Sign in

v1

latestOpenAPI 3.0.02026-08-062441107.9 KB
Computations

Set status of computation

Set status of computation given the computation ID.

post/computations/{computationId}/status

Path parameters

computationIdstring required

The ID of the computation.

Headers

slb-data-partition-idstring required

Data partition id.

Request body

status'CompletedSuccessfully' | 'CompletedWithErrors' | 'Stopped' | 'ProgressEvent' | 'ComputationLogEvent'

The computation status.

Example request

{
  "status": "CompletedWithErrors",
  "computationErrors": [
    {
      "addresses": [
        {
          "type": "DataTypeInput",
          "computationIndex": 0,
          "dataTypeIndex": 0
        },
        {
          "type": "DataTypeInput",
          "computationIndex": 0,
          "dataTypeIndex": 1
        }
      ],
      "message": "Something went wrong."
    }
  ]
}

Response

Computation status updated successfully.

idstring required

The computation ID.

status'Running' | 'CompletedSuccessfully' | 'CompletedWithErrors' | 'Stopping' | 'Stopped'

The computation status.

Example response

{
  "id": "0006803dc06c9bab3f82d4018287b8ccae575bd68eaa47f3c1797242e78daf03",
  "status": "CompletedWithErrors",
  "computationSpec": {
    "id": "ix",
    "version": 1
  },
  "inputContainers": [
    {
      "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/decline-curves/01CH0K76B5ANMW149TZZEGPZFV",
      "dataType": {
        "id": "decline-curves",
        "version": 1,
        "address": {
          "type": "DataTypeInput",
          "computationIndex": 0,
          "dataTypeIndex": 0
        }
      },
      "fileNames": [
        "decline_curves.json"
      ],
      "files": [
        {
          "name": "decline_curves.json"
        }
      ]
    },
    {
      "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/drilling-constraints/01CH0K76B5ANMW149TZZEGPZFV",
      "dataType": {
        "id": "drilling-constraints",
        "version": 1,
        "address": {
          "type": "DataTypeInput",
          "computationIndex": 0,
          "dataTypeIndex": 1
        }
      },
      "fileNames": [
        "drilling-constraints.json"
      ],
      "files": [
        {
          "name": "drilling-constraints.json"
        }
      ]
    }
  ],
  "outputContainers": [
    {
      "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV",
      "dataType": {
        "id": "production-forecast",
        "version": 1,
        "address": {
          "type": "DataTypeOutput",
          "computationIndex": 0,
          "dataTypeIndex": 0
        }
      },
      "fileNames": [
        "production-forecast.json"
      ],
      "files": [
        {
          "name": "production-forecast.json"
        }
      ]
    }
  ],
  "computationErrors": [
    {
      "addresses": [
        {
          "type": "DataTypeInput",
          "computationIndex": 0,
          "dataTypeIndex": 0
        },
        {
          "type": "DataTypeInput",
          "computationIndex": 0,
          "dataTypeIndex": 1
        }
      ],
      "message": "Something went wrong."
    }
  ],
  "computationConfiguration": {
    "schemaRef": {
      "ID": "planning:fdplan:dataiku:0.0.1",
      "Type": "JSON"
    }
  }
}