Update a workflow specification

Request

Update a workflow specification. It is only possible to update the "name", "description", "archived", "computationSpecs", "edges" and "annotations" fields of the workflow specification.

Security

bearer and appkey

Path

workflowSpecIdstringrequired

The workflow specification ID.

slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The patches to apply to the workflow 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", "computationSpecs", "edges" and "annotations" fields of the workflow 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/workflow-specs/{workflowSpecId}' \
  -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

Workflow 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"

computationSpecsArray of objects(WorkflowComputationSpec)required

The computation specifications which make up the workflow specification.

Example:

[
  {
    "id": "01DV2RPKYS5NYBAR6TNMJ8TNT8",
    "name": "spec-type",
    "version": 1,
    "latest": true,
    "archived": false,
    "description": "A specification.",
    "createdBy": "user@slb.com",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "address": { … },
    "inputDataTypeIds": [ … ],
    "outputDataTypeIds": [ … ]
  }
]

edgesArray of objects(Edge)

A list of graph edges which describe the data flow from one computation specifications output data-type to the next computation specifications input data-type.

Example:

[
  {
    "fromAddressType": "DataTypeOutput",
    "fromComputationIndex": 0,
    "fromDataTypeIndex": 0,
    "toComputationIndex": 1,
    "toDataTypeIndex": 0
  }
]

annotationsArray of objects(Annotation)

Example:

[
  {
    "address": { … },
    "key": "name",
    "value": "Decline Curves",
    "createdBy": "user@slb.com"
  }
]

Response

{
  "id": "01DV2RPKYS5NYBAR6TNMJ8TNT8",
  "name": "custom-workflow-spec",
  "version": 1,
  "latest": true,
  "archived": false,
  "description": "Description",
  "createdBy": "user@slb.com",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "computationSpecs": [
    { … },
    { … }
  ],
  "edges": [
    { … }
  ]
}