Containers

Get container given the container ID. The container ID associated with a given computation can be accessed through the computations API operations.

get/containers/{containerId}

Request

  • Base URL
    https://api.delfi.slb.com/fdplan/evaluation/v1
  • Auth
    API key in header Authorization and API key in header appkey

Path parameters

containerIdstring required

The ID of the container.

Query parameters

includeDataLinkContentboolean

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

Headers

slb-partition-idstring required

Data partition id.

Response

Retrieved container successfully.

idstring

The ID of the container.

storestring

The data store where the data within the container is located.

fileNamesstring[]

The file names which are part of the container. (marked for deprecation in favour of files).

labelsContainerLabels

The labels of a container.

Example response

{
  "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"
    }
  ],
  "labels": {
    "name": "p10"
  }
}

Changes

    • breaking

      added the new required header request parameter slb-partition-id

    • warning

      deleted the header request parameter slb-data-partition-id

    • warning

      added the new Workflow enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status