Skip to content
Cloud APIs
/
/
/
Get container

Get container

Request

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

Security
bearer and appkey
Path
containerIdstringrequired

The ID of the container.

Query
includeDataLinkContentboolean

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

Default:false
Headers
slb-partition-idstringrequired

Data partition id.

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

Responses

Retrieved container successfully.

Bodyapplication/json
idstring

The ID of the container.

Example:"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV"
dataTypeobject(WorkflowDataType)

A workflow specific version of an evaluation data-type that includes its address within the workflow.

Example:
{
  "id": "decline-curves",
  "version": 1,
  "address": {
    "type": "DataTypeInput",
    "computationIndex": 0,
    "dataTypeIndex": 0
  }
}
storestring

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

Example:"fdplan"
fileNamesArray of strings

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

Example:
[
  "production-forecast.json"
]
filesArray of objects(File)

The files which are part of the container.

Example:
[
  {
    "name": "production-forecast.json"
  }
]
labelsobject(ContainerLabels)

The labels of a container.

Example:
{
  "name": "p10"
}
caseContainersArray of objects(CaseContainer)

The containers for each case (only if the current container is a composite container)

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