Sign in

v1

latestOpenAPI 3.0.02026-08-062441107.9 KB
DataTypes

Get all data-types

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.

get/data-types

Query parameters

includePreviousVersionsboolean

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

Headers

slb-data-partition-idstring required

Data partition id.

Response

Retrieved data-types 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": "decline-curves",
    "name": "decline-curves",
    "description": "Decline Curves",
    "version": 1,
    "fileSpecs": [
      {
        "extension": "json"
      }
    ]
  },
  {
    "id": "facility-constraints",
    "name": "facility-constraints",
    "description": "Facility Constraints",
    "version": 1,
    "fileSpecs": [
      {
        "extension": "json"
      }
    ]
  }
]