v1

latestSwagger 2.02026-07-17652667.3 KB

basic

Update a simulation

put/simulations/{sim_identifier}

Path parameters

sim_identifierinteger required

Request body

detail_typestring required

identifierinteger required

descriptionstring

createdstring date-time required

resultinteger required

0 is scheduled, -1 is prep failed, -100 is sim failed, 100 is sim succeeded

environment_namestring required

Name of the simulation environment

queued_task_identifierstring

Identifier of the task associated to this simulation

queued_task_stateinteger

Read only value, taken from associated task

configobject required

Configuration of the simulation.

on_complete_actionobject

Action to take when simulation completes.

Example request

{
  "result": 0,
  "identifier": 1,
  "queued_task_state": 6,
  "detail_type": "SimulationSummary",
  "created": "2000-01-23T04:56:07.000+00:00",
  "description": "Pull request #12, commit id a3458de90f9",
  "queued_task_identifier": "queued_task_identifier",
  "environment_name": "environment_name"
}

Response

Returns the simulation