Update a data-type

Request

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

Security

bearer and appkey

Path

dataTypeIdstringrequired

The data-type ID.

slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The patches to apply to the data-type. Only "replace" operations are supported. It is only possible to update the "name", "description", "archived" and "fileSpecs" fields of the data-type.

Array [

opstringrequired

The operation to be performed.

Enum:"replace""add""remove"

Example:"replace"

pathstringrequired

A JSON-Pointer.

Example:"description"

valueany

The value to be used within the operations.

Example:"Description"

fromstring

A string containing a JSON Pointer value.

]

curl -i -X PATCH \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/data-types/{dataTypeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '[
    {
      "op": "replace",
      "path": "description",
      "value": "Description"
    },
    {
      "op": "replace",
      "path": "archived",
      "value": false
    }
  ]'

Responses

Data-type updated 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": [
    { … },
    { … }
  ]
}