Skip to main content
Read this runner's assignment

Authorizations

Authorization
string
header
required

Opaque control credential

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
batchId
string
required
Pattern: ^cisuite_[0-9a-z]{12,32}$
workId
string
required
Pattern: ^simwork_[0-9a-z]{12,32}$

Query Parameters

runnerId
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$

Response

Current work state

organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
batchId
string
required
Pattern: ^cisuite_[0-9a-z]{12,32}$
schemaVersion
enum<number>
required
Available options:
1
workId
string
required
Pattern: ^simwork_[0-9a-z]{12,32}$
runnerId
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
phase
enum<string>
required
Available options:
waiting,
preparing,
ready,
accepted,
running,
finished,
expired,
withdrawn
preStartExpiresAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
capacityOccupied
boolean
required
waiting
object
case
object
session
object
hostedRunId
string
Pattern: ^hrun_[0-9a-z]{12,32}$