PATCH /v1/dataProducts/{id}

from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

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

# Retrieve, modify, and update
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
dp.description = "Updated: Curated customer analytics with enriched profiles"
updated = DataProducts.update(dp)

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

// client is an initialized OpenMetadataClient.
var dataProductId = "b1839f98-f046-5f35-bdef-20f9b3395cb2";
var dataProduct = client.dataProducts().get(dataProductId);
dataProduct.setDescription("Updated: Curated customer analytics with enriched profiles");

var updated = client.dataProducts().update(dataProductId, dataProduct);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Updated: Curated customer analytics with enriched profiles",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "domains": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "type": "domain",
      "name": "Marketing",
      "fullyQualifiedName": "Marketing",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "experts": []
}

PATCH

dataProducts

{id}

PATCH /v1/dataProducts/{id}

from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

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

# Retrieve, modify, and update
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
dp.description = "Updated: Curated customer analytics with enriched profiles"
updated = DataProducts.update(dp)

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

// client is an initialized OpenMetadataClient.
var dataProductId = "b1839f98-f046-5f35-bdef-20f9b3395cb2";
var dataProduct = client.dataProducts().get(dataProductId);
dataProduct.setDescription("Updated: Curated customer analytics with enriched profiles");

var updated = client.dataProducts().update(dataProductId, dataProduct);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Updated: Curated customer analytics with enriched profiles",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "domains": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "type": "domain",
      "name": "Marketing",
      "fullyQualifiedName": "Marketing",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "experts": []
}

Update a Data Product

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

Update by ID

string

required

UUID of the data product to update.

Update by Name

Use PATCH /v1/dataProducts/name/{fqn} to update by fully qualified name.

string

required

Fully qualified name of the data product, for example CustomerInsights.

Body Parameters

Send a JSON Patch array of operations. Each operation targets a field path, such as /description. Only the fields you target are changed. You can patch the following fields:

string

Updated description in Markdown format.

string

Updated display name.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

array

Updated list of expert references.

Show properties

string

UUID of the user.

string

Type of entity (always user).

array

Classification tags or glossary terms applied to the data product. To add or remove a single tag, use the JSON Patch operations described in Add or Remove Tags.

Show properties

string

required

Fully qualified name of the tag or glossary term, for example PII.Sensitive or BusinessGlossary.Customer.

string

required

Where the tag comes from. Use Classification for a classification tag or Glossary for a glossary term.

string

required

How the tag was applied. Allowed values are Manual, Propagated, Automated, Derived, and Generated. Use Manual for a tag that a person or your own script applies.

string

required

Whether the tag is accepted. Use Confirmed for an applied tag. Suggested marks a tag that still needs the owner’s confirmation.

Add or Remove Tags

Tags are an array on the data product, so you change them with JSON Patch operations against /tags.

Add a Tag

Use an add operation at /tags/0 with a full tag object. Include all four fields: tagFQN, source, labelType, and state.

curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {
      "op": "add",
      "path": "/tags/0",
      "value": {
        "tagFQN": "PII.Sensitive",
        "source": "Classification",
        "labelType": "Manual",
        "state": "Confirmed"
      }
    }
  ]'

To add a glossary term, set source to Glossary and tagFQN to the term’s fully qualified name.

Remove a Tag

A remove operation targets a position in the tags array, not a tag name. JSON Patch has no way to remove a tag by its tagFQN. To remove a tag:

Retrieve the data product with its tags: GET /v1/dataProducts/name/{fqn}?fields=tags.
Find the position (starting at 0) of the tag you want to remove in the returned tags array.
Send a remove operation for that position.

curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "remove", "path": "/tags/1"}
  ]'

Important: The position changes whenever tags are added or removed. Retrieve the tags immediately before you send the remove operation. A stale position removes a different tag.

Note: PUT can only add tags and never removes them. Use PATCH to remove a tag. For the full rules, see Entity Update Behavior.

PATCH /v1/dataProducts/{id}

from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

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

# Retrieve, modify, and update
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
dp.description = "Updated: Curated customer analytics with enriched profiles"
updated = DataProducts.update(dp)

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

// client is an initialized OpenMetadataClient.
var dataProductId = "b1839f98-f046-5f35-bdef-20f9b3395cb2";
var dataProduct = client.dataProducts().get(dataProductId);
dataProduct.setDescription("Updated: Curated customer analytics with enriched profiles");

var updated = client.dataProducts().update(dataProductId, dataProduct);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Updated: Curated customer analytics with enriched profiles",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "domains": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "type": "domain",
      "name": "Marketing",
      "fullyQualifiedName": "Marketing",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "experts": []
}

Returns

Returns the updated data product object with the new version number.

Response

string

Unique identifier for the data product (UUID format).

string

Data product name.

string

Fully qualified name of the data product. This is the data product name.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid JSON patch or malformed request
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this data product
`404`	`NOT_FOUND`	Data product with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Update a Data Product

Update a Data Product

Update by ID

Update by Name

Body Parameters

Add or Remove Tags

Add a Tag

Remove a Tag

Returns

Response

Error Handling