Sign in

v1

latestOpenAPI 3.0.02026-08-062441107.9 KB
DataTypes

Get a data-type

Get a data-type.

get/data-types/{dataTypeId}

Path parameters

dataTypeIdstring required

The data-type ID.

Query parameters

versioninteger

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

Headers

slb-data-partition-idstring required

Data partition id.

Response

Retrieved data-type 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"
    }
  ]
}