Get the Dependencies of a Workflow

Retrieve the dependency links between the action items of a workflow in your SysAid account. Each link names the action item that a dependent action item waits for, the source, and the dependent action item, the target. The type of a link says whether the target waits for the source to be completed ("finish-to-start") or to become active ("start-to-start"); a link whose type SysAid does not report is returned without one. The response is a plain array that holds the whole graph, because SysAid does not page it, so it has no "limit" or "offset". An empty array means the workflow has no dependencies; an answer from SysAid that is not a list returns 502. The order of the links is not stable between two reads. A link can carry a condition in SysAid (for example "Approved = Y"); the condition is not exposed, so such a link reads like an unconditional one. The API does not return whether an action item with several sources waits for all of them or for any one. To set it, send "waitsFor" to PATCH /workflows/{workflowId}/action-items/{actionItemId}. Returns 404 when no workflow exists with this ID, for example for the ID of an Incident. Returns 403 when the calling user does not have the permission to design workflows, or when the account's SysAid edition does not include the Workflow Designer; SysAid records each refused call in the account's Audit Log.

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.

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