Get a workflow specification

Request

Get a workflow specification.

Security

bearer and appkey

Path

workflowSpecIdstringrequired

The workflow specification ID.

Query

versioninteger, (int32)

The id of the data-type to get. If not specified, the latest version will be returned.

slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/workflow-specs/{workflowSpecId}?version=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved workflow specification 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": [
    { … }
  ]
}