WorkflowSpecs

Get a workflow specification

Changed on

Get a workflow specification.

get/workflow-specs/{workflowSpecId}

Request

  • Base URL
    https://api.delfi.slb.com/fdplan/evaluation/v1
  • Auth
    API key in header Authorization and API key in header appkey

Path parameters

workflowSpecIdstring required

The workflow specification ID.

Query parameters

versioninteger

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

Headers

slb-partition-idstring required

Data partition id.

Response

Retrieved workflow specification successfully.

idstring required

The ID of the specification.

namestring required

The name of the specification.

versioninteger required

The version of the specification definition.

latestboolean required

Whether this is the latest version of the given specification.

archivedboolean required

Whether this specification has been marked as archived.

descriptionstring required

The description of the specification.

createdBystring required

The ID of the user who created the specification.

createdAtstring date-time required

The date the specification was created.

Example 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": [
    {
      "id": "ix",
      "name": "ix",
      "version": 1,
      "latest": true,
      "archived": false,
      "description": "A specification.",
      "createdBy": "system",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "address": {
        "type": "Computation",
        "computationIndex": 0,
        "dataTypeIndex": 0
      },
      "inputDataTypeIds": [
        {
          "id": "decline-curves",
          "version": 1,
          "address": [
            {
              "computationIndex": 0,
              "dataTypeIndex": 0,
              "type": "DataTypeInput"
            }
          ]
        },
        {
          "id": "drilling-constraints",
          "version": 1,
          "address": [
            {
              "computationIndex": 0,
              "dataTypeIndex": 1,
              "type": "DataTypeInput"
            }
          ]
        },
        {
          "id": "facility-constraints",
          "version": 1,
          "address": [
            {
              "computationIndex": 0,
              "dataTypeIndex": 2,
              "type": "DataTypeInput"
            }
          ]
        }
      ],
      "outputDataTypeIds": [
        {
          "id": "production-forecast",
          "version": 1,
          "address": {
            "type": "DataTypeOutput",
            "computationIndex": 0,
            "dataTypeIndex": 0
          }
        }
      ]
    },
    {
      "id": "peep",
      "name": "peep",
      "version": 1,
      "latest": true,
      "archived": false,
      "description": "A specification.",
      "createdBy": "system",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "address": {
        "type": "Computation",
        "computationIndex": 0,
        "dataTypeIndex": 0
      },
      "inputDataTypeIds": [
        {
          "id": "production-forecast",
          "version": 1,
          "address": [
            {
              "computationIndex": 1,
              "dataTypeIndex": 0,
              "type": "DataTypeInput"
            }
          ]
        },
        {
          "id": "well-capex",
          "version": 1,
          "address": [
            {
              "computationIndex": 1,
              "dataTypeIndex": 1,
              "type": "DataTypeInput"
            }
          ]
        },
        {
          "id": "general-capex",
          "version": 1,
          "address": [
            {
              "computationIndex": 1,
              "dataTypeIndex": 2,
              "type": "DataTypeInput"
            }
          ]
        },
        {
          "id": "general-opex",
          "version": 1,
          "address": [
            {
              "computationIndex": 1,
              "dataTypeIndex": 3,
              "type": "DataTypeInput"
            }
          ]
        },
        {
          "id": "economic-framework",
          "version": 1,
          "address": [
            {
              "computationIndex": 1,
              "dataTypeIndex": 4,
              "type": "DataTypeInput"
            }
          ]
        }
      ],
      "outputDataTypeIds": [
        {
          "id": "peep-output",
          "version": 1,
          "address": {
            "type": "DataTypeOutput",
            "computationIndex": 1,
            "dataTypeIndex": 0
          }
        }
      ]
    }
  ],
  "edges": [
    {
      "fromAddressType": "DataTypeOutput",
      "fromComputationIndex": 0,
      "fromDataTypeIndex": 0,
      "toComputationIndex": 1,
      "toDataTypeIndex": 0
    }
  ]
}

Changes

    • breaking

      added the new required header request parameter slb-partition-id

    • warning

      deleted the header request parameter slb-data-partition-id

    • warning

      added the new Workflow enum value to the //// response property for the response status

    • warning

      added the new Workflow enum value to the ///// response property for the response status

    • warning

      added the new Workflow enum value to the //////// response property for the response status

    • warning

      added the new Workflow enum value to the //////// response property for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status