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

Response containing the current status of a roster job.

Response containing the current status of a roster job.

jobId
string<uuid>
required
updatedAt
string<date-time>
required
status
enum<string>
required
Available options:
starting,
running,
finished,
error,
stopped
hasResult
boolean
required
messages
object
required

Generated roster status messages and continuation token for message polling.

error
string
metrics
object[]

The current values of the status metrics requested when the job was started. Each requested metric is returned with its original scope. Values are null until the first metrics publication or when no matching rules exist.

Maximum array length: 20