Sign in

v1

latestOpenAPI 3.0.02026-08-062441107.9 KB
Computations

Get a computation

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.

get/computations/{computationId}

Path parameters

computationIdstring required

The ID of the computation.

Query parameters

includeDataLinkContentboolean

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

Headers

slb-data-partition-idstring required

Data partition id.

Response

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