v1

latestOpenAPI 3.0.02026-08-062441107.9 KB

WorkflowSpecs

Get all workflow specifications

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.

get/workflow-specs

Query parameters

includePreviousVersionsboolean

Unless includePreviousVersions is true the response will return only the latest version of each specification.

Headers

slb-data-partition-idstring required

Data partition id.

Response

Retrieved workflow specifications 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": "id",
    "createdBy": "system",
    "name": "Well driven",
    "description": "Well driven",
    "latest": true,
    "version": 1,
    "computationSpecs": [
      {
        "id": "ix",
        "latest": true,
        "name": "ix",
        "createdBy": "system",
        "version": 1,
        "address": [
          {
            "computationIndex": 0,
            "type": "Computation"
          }
        ],
        "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",
        "latest": true,
        "name": "peep",
        "createdBy": "system",
        "version": 1,
        "address": [
          {
            "computationIndex": 1,
            "type": "Computation"
          }
        ],
        "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": [
              {
                "computationIndex": 1,
                "dataTypeIndex": 0,
                "type": "DataTypeOutput"
              }
            ]
          }
        ]
      }
    ],
    "edges": [
      {
        "fromAddressType": "DataTypeOutput",
        "fromComputationIndex": 0,
        "fromDataTypeIndex": 0,
        "toComputationIndex": 1,
        "toDataTypeIndex": 0
      }
    ]
  }
]