Update a Workflow Tab

Update the details of an existing workflow tab. The API changes only the fields that you include in the request body. The workflow must be a Change, Problem or Request template. The tab must be one that GET /workflows/{workflowId} returns. If service records already use the workflow's tabs, SysAid can first copy the tabs for the workflow, with new IDs. 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 workflow tab in SysAid. GET /workflows/{workflowId} returns the IDs of a workflow's tabs.

Body Params

The fields of the workflow tab to change.

string
required
length between 1 and 255

The name of the tab as users see it. The API keeps only safe HTML in the caption. It removes semicolons. It changes straight quotation marks around a word to "«" and "»". After these changes, the caption must have from 1 to 255 characters. The API then removes leading and trailing spaces. The caption must not be empty or "none". It must not contain a "$" sign, a control character or a character outside the Basic Multilingual Plane, such as an emoji.

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