Skip to main content
PATCH
/
v1
/
classifications
/
{id}
PATCH /v1/classifications/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Classifications

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
classification = Classifications.retrieve("06d90883-6be9-4f7e-9475-753f10a95e94")
classification.description = "Updated: Classification for data asset certification levels"
updated = Classifications.update(classification)

print(f"Updated to version {updated.version}")

{
  "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
  "name": "Certification",
  "fullyQualifiedName": "Certification",
  "description": "Updated: Classification for data asset certification levels",
  "version": 0.2,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

​
Update a Classification

Update a classification’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

​
Update by ID

​
id
string
required
UUID of the classification to update.

​
Update by Name

Use PATCH /v1/classifications/name/{fqn} to update by fully qualified name.
​
fqn
string
required
Fully qualified name of the classification (e.g., Certification).

​
Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
mutuallyExclusive
boolean
Updated mutually exclusive setting.
​
owners
array
Updated list of owner references.
PATCH /v1/classifications/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Classifications

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
classification = Classifications.retrieve("06d90883-6be9-4f7e-9475-753f10a95e94")
classification.description = "Updated: Classification for data asset certification levels"
updated = Classifications.update(classification)

print(f"Updated to version {updated.version}")

{
  "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
  "name": "Certification",
  "fullyQualifiedName": "Certification",
  "description": "Updated: Classification for data asset certification levels",
  "version": 0.2,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

​
Returns

Returns the updated classification object with the new version number.

​
Response

​
id
string
Unique identifier for the classification (UUID format).
​
name
string
Classification name.
​
fullyQualifiedName
string
Fully qualified name of the classification.
​
description
string
Updated description.
​
version
number
Incremented version number.

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this classification
404NOT_FOUNDClassification with given ID or FQN does not exist
409CONFLICTConcurrent modification detected