POST /v1/dataProducts

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

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

request = {
    "name": "CustomerInsights",
    "displayName": "Customer Insights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product"
}

data_product = DataProducts.create(request)
print(f"Created: {data_product.fullyQualifiedName.root}")

import java.util.List;
import org.openmetadata.schema.api.domains.CreateDataProduct;

// client is an initialized OpenMetadataClient.
var request = new CreateDataProduct()
    .withName("CustomerInsights")
    .withDisplayName("Customer Insights")
    .withDomains(List.of("Marketing"))
    .withDescription("Curated customer analytics data product");

var dataProduct = client.dataProducts().create(request);

curl -X POST "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CustomerInsights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product",
    "owners": [],
    "experts": []
  }'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Curated customer analytics data product",
  "version": 0.1,
  "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": []
}

POST

dataProducts

POST /v1/dataProducts

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

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

request = {
    "name": "CustomerInsights",
    "displayName": "Customer Insights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product"
}

data_product = DataProducts.create(request)
print(f"Created: {data_product.fullyQualifiedName.root}")

import java.util.List;
import org.openmetadata.schema.api.domains.CreateDataProduct;

// client is an initialized OpenMetadataClient.
var request = new CreateDataProduct()
    .withName("CustomerInsights")
    .withDisplayName("Customer Insights")
    .withDomains(List.of("Marketing"))
    .withDescription("Curated customer analytics data product");

var dataProduct = client.dataProducts().create(request);

curl -X POST "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CustomerInsights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product",
    "owners": [],
    "experts": []
  }'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Curated customer analytics data product",
  "version": 0.1,
  "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": []
}

Create a Data Product

Create a new data product within a domain.

Body Parameters

string

required

Name of the data product. Must be unique across all data products.

array

required

Fully qualified names of the parent domains, for example ["Marketing"].

string

Human-readable display name for the data product.

string

Description of the data product in Markdown format.

array

Array of owner references (users or teams) to assign to the data product.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of user references who are subject matter experts.

Show properties

string

UUID of the user.

string

Type of entity (always user).

string

Name of the user.

POST /v1/dataProducts

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

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

request = {
    "name": "CustomerInsights",
    "displayName": "Customer Insights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product"
}

data_product = DataProducts.create(request)
print(f"Created: {data_product.fullyQualifiedName.root}")

import java.util.List;
import org.openmetadata.schema.api.domains.CreateDataProduct;

// client is an initialized OpenMetadataClient.
var request = new CreateDataProduct()
    .withName("CustomerInsights")
    .withDisplayName("Customer Insights")
    .withDomains(List.of("Marketing"))
    .withDescription("Curated customer analytics data product");

var dataProduct = client.dataProducts().create(request);

curl -X POST "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CustomerInsights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product",
    "owners": [],
    "experts": []
  }'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Curated customer analytics data product",
  "version": 0.1,
  "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 created data product object with all specified properties and system-generated fields.

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

Human-readable display name.

string

Description of the data product in Markdown format.

array

References to the parent domains.

Show properties

string

UUID of the domain.

string

Type of entity (always domain).

string

Name of the domain.

string

Fully qualified name of the domain.

array

List of owners assigned to the data product.

array

Subject matter experts for the data product.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/dataProducts instead of POST to perform an upsert. If a data product with the same fullyQualifiedName already exists, it will be updated; otherwise, a new data product is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

Note: PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create data products
`409`	`ENTITY_ALREADY_EXISTS`	Data product with the same name already exists (POST only)

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

Create a Data Product

Create a Data Product

Body Parameters

Returns

Response

Create or Update (PUT)

Error Handling