/api/v1/simulator/runs/{runId}/cancel

POST

/api/v1/simulator/runs/{runId}/cancel

curl --request POST \
  --url https://example.com/api/v1/simulator/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Path Parameters

runId

required

string format: uuid

Responses

200

OK

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

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

Example

{
  "status": "Queued",
  "speed": {
    "mode": "Paced"
  }
}

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

Example

{
  "status": "Queued",
  "speed": {
    "mode": "Paced"
  }
}

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}