Update a Data Product

Update data product properties using JSON Patch

PATCH /v1/dataProducts/{id}

PATCH /v1/dataProducts/{id}

Python

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

configure(
    host="https://your-company.open-metadata.org/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}")

Response

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.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",
  "domain": {
    "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 Merge Patch. You can update by ID or by fully qualified name.

Update by ID

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.

fqn · string · required

Fully qualified name of the data product (e.g., Marketing.CustomerInsights).

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.

owners · array

Updated list of owner references.

Show properties

id · string

UUID of the owner entity.

type · string

Type of owner entity (e.g., user, team).

experts · array

Updated list of expert references.

Show properties

id · string

UUID of the user.

type · string

Type of entity (always user).

PATCH /v1/dataProducts/{id}

Python

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

configure(
    host="https://your-company.open-metadata.org/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}")

Response

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.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",
  "domain": {
    "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

id · string

Unique identifier for the data product (UUID format).

name · string

Data product name.

fullyQualifiedName · string

Fully qualified name in format domain.dataProductName.

description · string

Updated description.

version · 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