Set status of computation

Request

Set status of computation given the computation ID.

Security

bearer and appkey

Path

computationIdstringrequired

The ID of the computation.

Headers

slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The details of the computation status to be set.

statusstring

The computation status.

Enum:"CompletedSuccessfully""CompletedWithErrors""Stopped""ProgressEvent""ComputationLogEvent"

Example:"CompletedSuccessfully"

computationErrorsArray of objects(ComputationError)

The computation errors. There should not be any computation errors if the status of the computation is being set to 'CompletedSuccessfully'.

Example:

[
  {
    "addresses": [ … ],
    "message": "Something went wrong."
  }
]

progressEventobject(ComputationProgressEventMessage)

A message to provide a progress report on the status of an ongoing computation. Messages are logged as events.

Example:

{
  "timeStamp": "2020-01-01T00:00:00.000Z",
  "progressStatus": "Queued",
  "source": "External application",
  "body": "This is a progress event message"
}

computationLogEventobject(ComputationLogEvent)

The computationLogEvent. The log event should contain a list of logs associated with the computation.

curl -i -X POST \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/computations/{computationId}/status' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '{
    "status": "CompletedWithErrors",
    "computationErrors": [
      {
        "addresses": [
          {
            "type": "DataTypeInput",
            "computationIndex": 0,
            "dataTypeIndex": 0
          },
          {
            "type": "DataTypeInput",
            "computationIndex": 0,
            "dataTypeIndex": 1
          }
        ],
        "message": "Something went wrong."
      }
    ]
  }'

Responses

Computation status updated successfully.

Bodyapplication/json

idstringrequired

The computation ID.

Example:"0006803dc06c9bab3f82d4018287b8ccae575bd68eaa47f3c1797242e78daf03"

statusstring

The computation status.

Enum:"Running""CompletedSuccessfully""CompletedWithErrors""Stopping""Stopped"

Example:"Running"

computationSpecobject(VersionId)

A specification reference which allows the API users to specify the version of a specification when creating or updating a parent specification.

Example:

{
  "id": "01DV2RPKYS5NYBAR6TNMJ8TNT8",
  "version": 1
}

inputContainersArray of objects(Container)

A list of containers for the computation inputs.

Example:

[
  {
    "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/decline-curves/01CH0K76B5ANMW149TZZEGPZFV",
    "dataType": { … },
    "fileNames": [ … ],
    "files": [ … ]
  },
  {
    "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/drilling-constraints/01CH0K76B5ANMW149TZZEGPZFV",
    "dataType": { … },
    "fileNames": [ … ],
    "files": [ … ]
  }
]

outputContainersArray of objects(Container)

A list of containers for the computation outputs.

Example:

[
  {
    "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV",
    "dataType": { … },
    "fileNames": [ … ],
    "files": [ … ]
  }
]

logsContainerobject(Container)

A container is an instance of a data-type which is used to obtain the location of files which are part of the container, along with input and output errors.

Example:

{
  "id": "01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV",
  "dataType": {
    "id": "production-forecast",
    "version": 1,
    "address": { … }
  },
  "fileNames": [
    "production-forecast.json"
  ],
  "files": [
    { … }
  ],
  "labels": {
    "name": "p10"
  }
}

computationErrorsArray of objects(ComputationError)

The error associated with the computation.

Example:

[
  {
    "addresses": [ … ],
    "message": "Something went wrong."
  }
]

computationConfigurationobject

A computation configuration describes the configuration properties of the computation.

Example:

{
  "schemaRef": {
    "id": "planning:fdplan:dataiku:0.0.1",
    "type": "JSON"
  }
}

Response

{
  "id": "0006803dc06c9bab3f82d4018287b8ccae575bd68eaa47f3c1797242e78daf03",
  "status": "CompletedWithErrors",
  "computationSpec": {
    "id": "ix",
    "version": 1
  },
  "inputContainers": [
    { … },
    { … }
  ],
  "outputContainers": [
    { … }
  ],
  "computationErrors": [
    { … }
  ],
  "computationConfiguration": {
    "schemaRef": { … }
  }
}