Skip to content
Cloud APIs
/
/
/
Get a data-type

Get a data-type

Request

Get a data-type.

Security
bearer and appkey
Path
dataTypeIdstringrequired

The data-type ID.

Query
versioninteger, (int32)

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

Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/data-types/{dataTypeId}?version=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved data-type successfully.

Bodyapplication/json
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"
fileSpecsArray of objects(FileSpec)

Specification of the file types allowed to be used with this container.

Example:
[
  {
    "extension": "xlsx"
  },
  {
    "extension": "json",
    "schemaRef": { … },
    "defaultFilename": "filename.json"
  }
]
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": [
    { … },
    { … }
  ]
}