latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Simulation Runs

Create a simulation run

This operation creates a run in status READY, however the run is not automatically started. The run must be started explicitly using the POST /projects/{projectId}/simulations/{simulationId}/runs/{runId}/start endpoint.

post/projects/{projectId}/simulations/{simulationId}/runs

Request body

runIdstring uuid
namestring required

The name of the simulation run.

createdAtstring date-time

The time when the simulation run was created.

startedAtstring date-time

The time when the simulation run was started.

finishedAtstring date-time

The time when the simulation run was finished.

durationstring duration

The actual duration of the simulation run.

status'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED'

Status of the operation.

progressnumber

The current progress while the simulation run is in progress.

Example request

{
  "runId": "37ae37ae-37ae-37ae-37ae-37ae37ae37ae",
  "name": "My first simulation run",
  "createdAt": "2020-03-04T15:16:17Z",
  "startedAt": "2020-03-04T15:17:18Z",
  "finishedAt": "2020-03-04T17:29:42Z",
  "duration": "PT2H12M14S",
  "computeResource": {
    "type": "GPU_HOURS",
    "value": 0.27
  },
  "status": "FINISHED",
  "progress": 1,
  "isContinuable": false
}

Response

Successful creation of the simulation run

runIdstring uuid
namestring required

The name of the simulation run.

createdAtstring date-time

The time when the simulation run was created.

startedAtstring date-time

The time when the simulation run was started.

finishedAtstring date-time

The time when the simulation run was finished.

durationstring duration

The actual duration of the simulation run.

status'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED'

Status of the operation.

progressnumber

The current progress while the simulation run is in progress.

Example response

{
  "runId": "37ae37ae-37ae-37ae-37ae-37ae37ae37ae",
  "name": "My first simulation run",
  "createdAt": "2020-03-04T15:16:17Z",
  "startedAt": "2020-03-04T15:17:18Z",
  "finishedAt": "2020-03-04T17:29:42Z",
  "duration": "PT2H12M14S",
  "computeResource": {
    "type": "GPU_HOURS",
    "value": 0.27
  },
  "status": "FINISHED",
  "progress": 1,
  "isContinuable": false
}