Retrieves the job status with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The job status id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the job status, or 404 Not Found if it doesn't exist.
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": "68c5eec8-352d-4694-bc97-8d0ae872dee5",
"name": "sample string 2",
"sequence": 3,
"color_text": "sample string 4",
"system_job_status_id": "b7832c98-4efd-4475-8775-24e45621fc32",
"modified_dateutc": "2026-09-16T10:12:44.7165035+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>68c5eec8-352d-4694-bc97-8d0ae872dee5</id> <is_isolated_workflow>true</is_isolated_workflow> <modified_dateutc>2026-09-16T10:12:44.716Z</modified_dateutc> <name>sample string 2</name> <sequence>3</sequence> <system_job_status_id>b7832c98-4efd-4475-8775-24e45621fc32</system_job_status_id> </job_status>