Retrieves all job statuses, optionally filtered via OData query options.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the list of job statuses.
job_status| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| name |
Name of the job status |
string | |
| sequence |
Order in which this status should be displayed relative to other statuses. |
integer | |
| color_text |
Display color (e.g. hex code) used to render this status in the UI. |
string | |
| system_job_status_id |
Foreign key of the built-in system status (e.g. Completed, Cancelled) this custom status maps to for workflow logic. |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| archived |
archived flag |
boolean | |
| is_isolated_workflow |
Indicates this status belongs to an isolated workflow, not reachable from/to statuses of other workflows. |
boolean |
Response Formats
application/json, text/json
Sample:
{
"id": "666d5914-091d-4df1-8e0c-bd977c5dca7e",
"name": "sample string 2",
"sequence": 3,
"color_text": "sample string 4",
"system_job_status_id": "e0160092-0355-4016-87ea-1a75a336d645",
"modified_dateutc": "2026-11-12T14:27:25.5870821+00:00",
"archived": true,
"is_isolated_workflow": true
}
application/xml, text/xml
Sample:
<job_status xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <color_text>sample string 4</color_text> <id>666d5914-091d-4df1-8e0c-bd977c5dca7e</id> <is_isolated_workflow>true</is_isolated_workflow> <modified_dateutc>2026-11-12T14:27:25.587Z</modified_dateutc> <name>sample string 2</name> <sequence>3</sequence> <system_job_status_id>e0160092-0355-4016-87ea-1a75a336d645</system_job_status_id> </job_status>