Get a computation

Request

Get a computation given the computation ID. The computation contains the state of the computation (i.e. running, succeeded), input/output data containers which has been associated with the computation and any errors which have occurred during the running of the computation. The input and output data containers associated with the computation can be accessed through the containers API operations. Computations external to FDPlan can discover when computations are required to be performed by querying the FDPlan Events API for events with the type 'com.slb.cloud.fdplan.evaluation.computation_required_{computation_spec_id}_v{computation_spec_version}.v1', for instance 'com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1'. The data for this event type contains information on the computation which is required.

Security

bearer and appkey

Path

computationIdstringrequired

The ID of the computation.

Query

includeDataLinkContentboolean

Flag will include data-link.json content encoded as base64.

Default:false

includeSignedURLboolean

Flag will include signed url for data-types with file size limit greater than 20MB.

Default:false

slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/computations/{computationId}?includeDataLinkContent=false&includeSignedURL=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved computation 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": { … }
  }
}