Skip to main content
GET

Authorizations

Authorization
string
header
required

Include the access token in the Authorization header using the Bearer scheme.

Path Parameters

jobId
string<uuid>
required

Unique identifier for the roster job.

Query Parameters

messageToken
string

Opaque token returned by the previous status response to retrieve new roster status messages.

Minimum string length: 1

Response

Current solver status and published outputs for a roster job.

jobId
string<uuid>
required

Identifier of the roster job.

updatedAt
string<date-time>
required

Time of the latest status update.

isActive
boolean
required

Whether any part of the job is still active and polling should continue.

status
enum<string>
required

Current status of the solver.

Available options:
starting,
running,
finished,
error,
stopped
hasResult
boolean
required

Whether a result is available.

messages
object
required

Generated status messages and message polling token.

error
string

Error message in case something has gone wrong.

metrics
object[]

Current values for the requested solver status metrics.

Maximum array length: 20