WorkflowComputationSpec

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"

addressobject(SpecAddress)

An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.

Example:

{
  "type": "DataTypeInput",
  "computationIndex": 0,
  "dataTypeIndex": 0
}

inputDataTypeIdsArray of objects(WorkflowDataType)required

The input data-types for the computation.

Example:

[
  {
    "id": "decline-curves",
    "version": 1,
    "address": { … }
  },
  {
    "id": "facility-constraints",
    "version": 1,
    "address": { … }
  }
]

outputDataTypeIdsArray of objects(WorkflowDataType)required

The output data-types for the computation.

Example:

[
  {
    "id": "production-forecast",
    "version": 1,
    "address": { … }
  }
]

{
  "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": {
    "type": "Computation",
    "computationIndex": 0,
    "dataTypeIndex": 0
  },
  "inputDataTypeIds": [
    { … },
    { … }
  ],
  "outputDataTypeIds": [
    { … }
  ]
}