latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Simulation Runs

Add wind data to a simulation run (works only for PWC runs)

You can use this endpoint to add wind data to an existing PWC run. This means that for the new run, only the statistical surface solution will be regenerated based on the new wind data, while the individual results of each direction will be kept from the original run. This endpoint is only used to trigger the execution of the new simulation run - before calling this endpoint make sure to update the simulation spec with the new wind data.

post/projects/{projectId}/simulations/{simulationId}/runs/{runId}/add-wind-data

Request body

namestring required

The name of the newly created simulation run.

Example request

{
  "name": "PWC with new wind data"
}

Response

Successful operation.

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
}