{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"API equivalent of submitting a ","type":"text"},{"text":"Workflow Popup","type":"text","marks":[{"type":"link","attrs":{"href":"https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/20881631"}}]},{"text":" via the UI. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates Attribute data for a Workflow Instance and triggers a specific ","type":"text"},{"text":"Workflow Action","type":"text","marks":[{"type":"link","attrs":{"href":"https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/345800774"}}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/20881631"}},{"text":" are one of the core elements in LearningBuilder. They represent multi-step process that create and populate various entities (","type":"text"},{"text":"LearningPlanInstances","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"ActivityInstances","type":"text","marks":[{"type":"code"}]},{"text":", etc) with data.","type":"text"}]},{"type":"paragraph","content":[{"text":"Each Workflow-enabled entity has a ","type":"text"},{"text":"WorkflowInstance","type":"text","marks":[{"type":"code"}]},{"text":" that tracks its progress through its configured process.","type":"text"}]},{"type":"paragraph","content":[{"text":"This API is the equivalent of submitting a Workflow Popup via the UI. It allows you to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update the values for the Attributes that are editable on the current Workflow Step","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Trigger one of the Workflow Actions configured on the current Workflow Step","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"This API is concerned with the data structure itself but not the presentation layer, so it does not care about Workflow Sections","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Calling the API","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"Requires an ","type":"text"},{"text":"API Key","type":"text","marks":[{"type":"link","attrs":{"href":"https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/418840595"}}]},{"text":" with the ","type":"text"},{"text":"PERFORM_WORKFLOW_STEP","type":"text","marks":[{"type":"code"}]},{"text":" permission, and the user owning the key must have access to the Workflow on its current Step.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"POST /API/WorkflowInstance/PerformStep\n\n{\n \"WorkflowInstanceId\": ,\n \"ActionId\": ,\n \"ActionName\": ,\n \"Attributes\": [\n { \"Name\": , \"Value\": },\n { \"Id\": , \"Value\": },\n ...\n ],\n \"IgnoreWarningActionId\": \n}","type":"text"}]},{"type":"table","attrs":{"layout":"center","width":760.0,"localId":"4820561f-7bbe-4b2e-9751-c7877556aa44"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[212.0]},"content":[{"type":"paragraph","content":[{"text":"JSON Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[548.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[212.0]},"content":[{"type":"paragraph","content":[{"text":"WorkflowInstanceId","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[548.0]},"content":[{"type":"paragraph","content":[{"text":"Required:","type":"text","marks":[{"type":"strong"}]},{"text":" The ID of the ","type":"text"},{"text":"WorkflowInstance","type":"text","marks":[{"type":"code"}]},{"text":" to modify","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[212.0]},"content":[{"type":"paragraph","content":[{"text":"ActionId","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"or","type":"text"},{"type":"hardBreak"},{"text":"ActionName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[548.0]},"content":[{"type":"paragraph","content":[{"text":"Required:","type":"text","marks":[{"type":"strong"}]},{"text":" Identifier for the Workflow Action to trigger. Must exist on the Current Step of the ","type":"text"},{"text":"WorkflowInstance","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"You must provide ","type":"text"},{"text":"one ","type":"text","marks":[{"type":"em"}]},{"text":"of these values, but not both.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[212.0]},"content":[{"type":"paragraph","content":[{"text":"Attributes","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[548.0]},"content":[{"type":"paragraph","content":[{"text":"Optional: An array of Attribute values to save.","type":"text"}]},{"type":"paragraph","content":[{"text":"Each item in the array has these properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":": the Attribute ID","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":": the Attribute name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"code"}]},{"text":": the value to save. The specific format will vary based on the ","type":"text"},{"text":"Attribute data type","type":"text","marks":[{"type":"link","attrs":{"href":"https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/343146535"}}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"You must provide ","type":"text"},{"text":"either ","type":"text","marks":[{"type":"em"}]},{"text":"the Attribute’s","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Id","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"or ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":", but not both. ","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[212.0]},"content":[{"type":"paragraph","content":[{"text":"IgnoreWarningActionId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[548.0]},"content":[{"type":"paragraph","content":[{"text":"Optional: The ID of the Workflow Action to trigger while ignoring warnings","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"If successful:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": true,\n \"AdditionalInformation\": { ... }\n}","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"AdditionalInformation","type":"text","marks":[{"type":"code"}]},{"text":" structure is populated differently for different Workflow Action types and is primarily intended for internal use.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"If unsuccessful:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": false,\n \"errors\": [array of strings],\n \"showIgnore\": ,\n \"actionName\": ,\n \"actionId\": \n}","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"You can generally ignore ","type":"text"},{"text":"showIgnore","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"actionName","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"actionId","type":"text","marks":[{"type":"code"}]},{"text":". Mainly you are looking for ","type":"text"},{"text":"success","type":"text","marks":[{"type":"code"}]},{"text":" and if that's false, look at ","type":"text"},{"text":"errors","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Error Messages","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"796585f0-b5e4-48d8-a96a-c6b222b91803"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error Message ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Cause Of Error Message","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"How To Resolve Error Message","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ActionId or ActionName are required","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The parameter string of the API call did not contain an ActionId or an ActionName parameter and value","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Resubmit the API call, and submit either an ActionId or ActionName parameter and value.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Only one of ActionId or ActionName should be specified, not both.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The parameter string of the API call contained both a an ActionId or ActionName parameter and value ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Resubmit the API call, and submit either an ActionId or ActionName parameter and value. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Attribute ID or Attribute Name should be specified, not both.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The collection of Attributes contained a combination of Attribute IDs and Attribute names","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Resubmit the API call and ensure the all attributes in the attribute collection contain either AttributeID or AttributeName parameters","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Attribute ID or Attribute Name are required for every attribute.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The collection of Attributes contained one or more attribute values without an Attribute IDs or Attribute names; Alternately, the Values provided for the attributes were not correctly escaped.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Resubmit the API call and ensure all attributes in the attribute collection have Attribute IDs or Attribute Names; Ensure that all Attribute values are correctly escaped.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Workflow Step Action# was not found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Workflow Instance specified is not on a step where the ActionId/ActionName specified exists.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Ensure the Workflow Instance is on the intended Workflow Step, ensure that the ActionId/ActionName on the intended workflow step matches the API call. ","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported