Data

Update a data object

Unlike the other partial updates in this API, this one replaces the whole upsert body: fields absent from the request are cleared rather than left untouched.

Required scope data:edit

patch/data/{id}

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the data object.

Bodyapplication/json

namestringrequired

Name of the data object.

typesstring[]

Types of data the object holds.

privacystring

Privacy classification of the data.

criticalitystring

Business criticality of the data.

descriptionstring

Short description of the data object.

categoryIdstring<uuid>

Category to file the data object under.

categoryNamestring

Name of the category, sent together with `categoryId`.

Response200 · application/json

The updated data object.

idstring<uuid>required

Identifier of the data object.

namestringrequired

Name of the data object.

typesstring[]

Types of data the object holds.

privacystring | null

Privacy classification of the data.

criticalitystring | null

Business criticality of the data.

descriptionstring | null

Short description of the data object.

updatedAtstring<date-time>

Timestamp of the last change, usable for change detection.

categoryobject | null

Category the data object belongs to.

customFieldsany[]

Workspace custom fields and their values.