Get all data-types

Request

Get all data-types. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the data-types or all possible versions of each data-type.

Security

bearer and appkey

Query

includePreviousVersionsboolean

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

slb-partition-idstringrequired

Data partition id.

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

Responses

Retrieved data-types successfully.

Bodyapplication/json

Array [

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": "decline-curves",
    "name": "decline-curves",
    "description": "Decline Curves",
    "version": 1,
    "latest": true,
    "archived": false,
    "createdBy": "system",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "fileSpecs": [ … ]
  },
  {
    "id": "facility-constraints",
    "name": "facility-constraints",
    "description": "Facility Constraints",
    "version": 1,
    "latest": true,
    "archived": false,
    "createdBy": "system",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "fileSpecs": [ … ]
  }
]