Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Jobs

Get Job Status Definition by Name

Returns a job status by name that can be assigned to a job.

get/v1/job-status/{name}

Path parameters

namestring required

The name of the job status definition to retrieve.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The job status definition.

idinteger

The identifier for the job status.

itemstring

The job status name.

typestring

The type of job status. Values are "open" or "closed". Open and closed job statuses are grouped together in BOLD.

statusOrderinteger

Numerical order value for the job status in the list of statuses in BOLD.

Example response

{
  "id": 1234,
  "item": "Active",
  "type": "open",
  "statusOrder": 1
}