Update a Workflow Action Item

Update the details of an existing action item of a workflow in your SysAid account. The API changes only the fields that you include in the request body. The workflow must be a Change, Problem or Request template. If the request puts an action item after another action item whose field it fills, SysAid deletes the rule that fills the field. If the API returns 500 or 502, read the workflow and its dependencies before you try again. The calling user needs the permission to design workflows.

Path Params
integer
required
1 to 2147483647

The unique identifier of the workflow in SysAid. It is the ID of the SysAid service record that holds the workflow. For a Change, Problem or Request template, this service record is the template's workflow record. For the templates that SysAid ships, this record has the template's ID. A Change, Problem or Request service record holds its own copy of its template's workflow. The read operations also accept the ID of such a service record. If no workflow exists with this ID, for example for the ID of an Incident, the API returns 404.

integer
required
1 to 2147483647

The unique identifier of the action item in SysAid. The action item must belong to the workflow. Use GET /workflows/{workflowId} to retrieve the action items of the workflow.

Body Params

The fields of the action item to change. Send "tabId", "order", "waitsFor" or a combination of them. If the request moves the action item, every dependency link of the action item must point forward after the move. A link must not join the action item to an action item on a hidden tab. If a link breaks one of these rules, the API returns 409 with the IDs of the links. Delete those links first. If the API returns 500 or 502, SysAid can already have stored "waitsFor". You can send a request with only "waitsFor" again.

integer
1 to 2147483647

The unique identifier of the tab to move the action item to. Use GET /workflows/{workflowId} to retrieve the tabs of the workflow. Without "tabId", the action item stays on its tab.

integer
1 to 2147483647

The order that the action item takes on the tab. The action items at this order or later move down by one. The order can be at most one more than the highest order on the tab. Orders can have gaps. Read them with GET /workflows/{workflowId}. Without "order", the action item goes to the end of the tab.

string
enum

Whether the action item waits for all the action items that it depends on ("all") or for any one of them ("any"). An action item that never had this setting waits for all of them. SysAid uses this setting only when the action item depends on two or more action items, or on one that no longer exists. The setting applies to this template and to the service records that SysAid creates from it after the change. Service records that already exist keep their own setting.

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json