Sign in

v1

latestOpenAPI 3.0.02026-08-062441107.9 KB
DataTypes

Create or update data-type

Create or update data-type. The request must contain all the file types which are to be associated with the data-type. For example, if the data-type was to allow the use of JSON documents then the request would list it as a file specification.

put/data-types/{dataTypeId}

Path parameters

dataTypeIdstring required

The data-type ID.

Headers

slb-data-partition-idstring required

Data partition id.

Request body

idstring required

The id of the specification. The id should be of the form '{authority}:{spec-type}:{id}', where '{authority}' is the owning authority of the specification, '{spec-type}' is one of 'data-types', 'computation-specs' or 'workflow-specs'.

namestring required

The name of the specification.

versioninteger required

The version of the specification definition.

archivedboolean

Whether this specification has been marked as archived.

descriptionstring required

The description of the specification.

Example request

{
  "id": "slb:data-types:custom-data-type",
  "version": 1,
  "name": "custom-data-type",
  "description": "Description",
  "archived": false,
  "fileSpecs": [
    {
      "extension": "json",
      "schemaRef": {
        "id": "planning:fdplan:result-set:0.0.1",
        "type": "JSON"
      },
      "defaultFilename": "filename.json"
    },
    {
      "extension": "xlsx"
    }
  ]
}

Response

Data-type updated 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-data-type",
  "version": 1,
  "latest": true,
  "archived": false,
  "description": "Description",
  "createdBy": "user@slb.com",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "fileSpecs": [
    {
      "extension": "json",
      "schemaRef": {
        "id": "planning:fdplan:result-set:0.0.1",
        "type": "JSON"
      },
      "defaultFilename": "filename.json"
    },
    {
      "extension": "xlsx"
    }
  ]
}