Skip to content
Cloud APIs
/
/
/
Get all computation speci...

Get all computation specifications

Request

Get all computation specifications. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the computation specifications or all possible versions of each computation specification.

Security
bearer and appkey
Query
includePreviousVersionsboolean

Unless includePreviousVersions is true the response will return only the latest version of each specification.

Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/computation-specs?includePreviousVersions=true' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved computation specifications successfully.

Bodyapplication/json
Array [
idstringrequired

The ID of the specification.

Example:"01DV2RPKYS5NYBAR6TNMJ8TNT8"
namestringrequired

The name of the specification.

Example:"A custom data-type"
versionintegerrequired

The version of the specification definition.

Example:1
latestbooleanrequired

Whether this is the latest version of the given specification.

Example:true
archivedbooleanrequired

Whether this specification has been marked as archived.

Example:false
descriptionstringrequired

The description of the specification.

Example:"A specification"
createdBystringrequired

The ID of the user who created the specification.

Example:"user@slb.com"
createdAtstring, (date-time)required

The date the specification was created.

Example:"2020-01-01T00:00:00.000Z"
inputDataTypeIdsArray of objects(VersionId)required

The input data-type IDs for the computation specification.

Example:
[
  {
    "id": "decline-curves",
    "version": 1
  },
  {
    "id": "drilling-constraints",
    "version": 1
  },
  {
    "id": "facility-constraints",
    "version": 1
  }
]
outputDataTypeIdsArray of objects(VersionId)required

The output data-type IDs for the computation specification.

Example:
[
  {
    "id": "production-forecast",
    "version": 1
  }
]
annotationsArray of objects(Annotation)

The annotations for the computation specification. These annotations can be used to annotate the computation specification with useful information such as a 'name'.

Example:
[
  {
    "address": { … },
    "key": "name",
    "value": "Decline Curves",
    "createdBy": "user@slb.com"
  },
  {
    "address": { … },
    "key": "name",
    "value": "Drilling Constraints",
    "createdBy": "user@slb.com"
  },
  {
    "address": { … },
    "key": "name",
    "value": "Facility Constraints",
    "createdBy": "user@slb.com"
  },
  {
    "address": { … },
    "key": "name",
    "value": "Production Forecast",
    "createdBy": "user@slb.com"
  }
]
]
Response
[
  {
    "id": "ix",
    "latest": true,
    "name": "ix",
    "version": 1,
    "archived": false,
    "description": "ix computation",
    "createdBy": "system",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "inputDataTypeIds": [ … ],
    "outputDataTypeIds": [ … ]
  },
  {
    "id": "peep",
    "latest": true,
    "name": "peep",
    "version": 1,
    "archived": false,
    "description": "peep computation",
    "createdBy": "system",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "inputDataTypeIds": [ … ],
    "outputDataTypeIds": [ … ]
  }
]