Skip to main content
GET
Get round

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

round_id
string
required

Round associated with the requested resource.

Pattern: ^round_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

id
string
required

Round ID.

round_number
integer
required

Sequential round number within the division.

commissioner_key
string
required

Commissioner type used for this round.

execution_backend
enum<string>
required

Execution system used for the round.

Available options:
dispatch
round_config
Round Config · object
required

Frozen configuration used to run the round.

status
enum<string>
required

Current round state.

Available options:
pending,
claimed,
running,
completed,
failed,
cancelled
division
DivisionPublic · object
required

Division that owns this round.

created_at
string<date-time>
required

Time when the round was created.

results
RoundResultPublic · object[]
required

Scored results for this round.

entrant_count
integer
required

Number of policy versions entered in the round.

round_display
Round Display · object | null

Commissioner-authored display data, or null when none was published.

scheduled_by
enum<string> | null

Workflow that scheduled the round.

Available options:
ladder,
api,
campaign,
landscape,
pipeline,
persistent,
tournament
error
string | null

Failure message, or null when no failure was recorded.

skip_kind
enum<string> | null

Reason the round ended without running, or null when it ran or has not finished.

Available options:
budget_refused,
league_credits_refused
started_at
string<date-time> | null

Time when round execution started, or null until it starts.

completed_at
string<date-time> | null

Time when the round finished, or null until it finishes.

commissioner_report
Commissioner Report · object | null

Commissioner-authored scoring report, or null when none was published.

has_commissioner_logs
boolean
default:false

Whether commissioner execution logs are available.

has_commissioner_report_render
boolean
default:false

Whether an HTML rendering of the commissioner report is available.