Skip to content
Cloud APIs
/
FDPlan
/
/WorkflowSpecs

Get all workflow specifications

Request

Get all workflow specifications. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the workflow specifications or all possible versions of each workflow 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/workflow-specs?includePreviousVersions=true' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved workflow 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"
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": "id",
    "name": "Well driven",
    "description": "Well driven",
    "latest": true,
    "version": 1,
    "archived": false,
    "createdBy": "system",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "computationSpecs": [ … ],
    "edges": [ … ]
  }
]