Update computation specification

Request

Update computation specification. It is only possible to update the "name", "description", "archived", "inputDataTypeIds", "outputDataTypeIds" and "annotations" fields of the computation specification.

Security

bearer and appkey

Path

computationSpecIdstringrequired

The computation specification ID.

slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The patches to apply to the computation specification. Only "replace" operations are supported with the exception of "add" and "remove" for "annotations" path. It is only possible to update the "name", "description", "archived", "inputDataTypeIds", "outputDataTypeIds" and "annotations" fields of the computation specification.

Array [

opstringrequired

The operation to be performed.

Enum:"replace""add""remove"

Example:"replace"

pathstringrequired

A JSON-Pointer.

Example:"description"

valueany

The value to be used within the operations.

Example:"Description"

fromstring

A string containing a JSON Pointer value.

]

curl -i -X PATCH \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/computation-specs/{computationSpecId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '[
    {
      "op": "replace",
      "path": "description",
      "value": "Description"
    },
    {
      "op": "replace",
      "path": "archived",
      "value": false
    }
  ]'

Responses

Computation specification updated successfully.

Bodyapplication/json

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": "01DV2RPKYS5NYBAR6TNMJ8TNT8",
  "name": "custom-computation-spec",
  "version": 1,
  "latest": true,
  "archived": false,
  "description": "Description",
  "createdBy": "user@slb.com",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "inputDataTypeIds": [
    { … },
    { … },
    { … }
  ],
  "outputDataTypeIds": [
    { … }
  ],
  "annotations": [
    { … },
    { … },
    { … },
    { … }
  ]
}