Skip to content
jtWMS Docs

/api/v1/simulator/runs (GET)

GET
/api/v1/simulator/runs
curl --request GET \
  --url https://example.com/api/v1/simulator/runs \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
Status
Array<string>
Allowed values: Queued Provisioning Running Paused Completed Failed Cancelled
ScenarioId
string format: uuid
Page
integer format: int32
PageSize
integer format: int32
Sort
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

object
items
required
Array<object>
object
id
required
string format: uuid
number
required
integer format: int32
name
required
string
status
required
string
Allowed values: Queued Provisioning Running Paused Completed Failed Cancelled
scenarioId
required
string format: uuid
nullable
scenarioName
required
string
seed
required
integer format: int64
speed
required
object
mode
required
string
Allowed values: Paced AsFastAsPossible
factor
required
number format: double
nullable >= 0.1 <= 100
simTime
required
number format: double
durationSeconds
required
number format: double
lagSeconds
required
number format: double
facilityId
required
string format: uuid
nullable
facilityCode
required
string
nullable
lastSeq
required
integer format: int64
errorCode
required
string
nullable
errorDetail
required
string
nullable
createdAt
required
string format: date-time
startedAt
required
string format: date-time
nullable
endedAt
required
string format: date-time
nullable
updatedAt
required
string format: date-time
page
required
integer format: int32
pageSize
required
integer format: int32
totalCount
required
integer format: int32

400

Section titled “400”

Bad Request

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable