Sign in

v1

latestOpenAPI 3.0.02026-08-062441107.9 KB
DataTypes

Update a data-type

Update a data-type. It is only possible to update the "name", "description", "archived", and "fileSpecs" fields of the data-type.

patch/data-types/{dataTypeId}

Path parameters

dataTypeIdstring required

The data-type ID.

Headers

slb-data-partition-idstring required

Data partition id.

Request body

op'replace' | 'add' | 'remove' required

The operation to be performed.

pathstring required

A JSON-Pointer.

valueobject

The value to be used within the operations.

fromstring

A string containing a JSON Pointer value.

Example request

[
  {
    "op": "replace",
    "path": "description",
    "value": "Description"
  },
  {
    "op": "replace",
    "path": "archived",
    "value": false
  }
]

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"
    }
  ]
}