GET /v1/dataProducts/{id}

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"
)

# Get by ID
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
print(f"{dp.fullyQualifiedName}: {dp.description}")

# Get by ID with fields
dp = DataProducts.retrieve(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    fields=["owners", "domain", "experts", "assets"]
)

# Get by fully qualified name
dp = DataProducts.retrieve_by_name("Marketing.CustomerInsights")

# Get by name with fields
dp = DataProducts.retrieve_by_name(
    "Marketing.CustomerInsights",
    fields=["owners", "domain", "experts", "assets"]
)

import static org.openmetadata.sdk.fluent.DataProducts.*;

// Get by ID
var dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2");

// Get by ID with fields
var dp = DataProducts.retrieve(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    "owners,domain,experts,assets"
);

// Get by fully qualified name
var dp = DataProducts.retrieveByName("Marketing.CustomerInsights");

// Get by name with fields
var dp = DataProducts.retrieveByName(
    "Marketing.CustomerInsights",
    "owners,domain,experts,assets"
);

# Get by ID
curl "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2?fields=owners,domain,experts,assets" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/dataProducts/name/Marketing.CustomerInsights" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/dataProducts/name/Marketing.CustomerInsights?fields=owners,domain,experts,assets" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.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",
  "domain": {
    "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "type": "domain",
    "name": "Marketing",
    "fullyQualifiedName": "Marketing",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "experts": []
}

GET

dataProducts

{id}

GET /v1/dataProducts/{id}

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"
)

# Get by ID
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
print(f"{dp.fullyQualifiedName}: {dp.description}")

# Get by ID with fields
dp = DataProducts.retrieve(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    fields=["owners", "domain", "experts", "assets"]
)

# Get by fully qualified name
dp = DataProducts.retrieve_by_name("Marketing.CustomerInsights")

# Get by name with fields
dp = DataProducts.retrieve_by_name(
    "Marketing.CustomerInsights",
    fields=["owners", "domain", "experts", "assets"]
)

import static org.openmetadata.sdk.fluent.DataProducts.*;

// Get by ID
var dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2");

// Get by ID with fields
var dp = DataProducts.retrieve(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    "owners,domain,experts,assets"
);

// Get by fully qualified name
var dp = DataProducts.retrieveByName("Marketing.CustomerInsights");

// Get by name with fields
var dp = DataProducts.retrieveByName(
    "Marketing.CustomerInsights",
    "owners,domain,experts,assets"
);

# Get by ID
curl "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2?fields=owners,domain,experts,assets" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/dataProducts/name/Marketing.CustomerInsights" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/dataProducts/name/Marketing.CustomerInsights?fields=owners,domain,experts,assets" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.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",
  "domain": {
    "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "type": "domain",
    "name": "Marketing",
    "fullyQualifiedName": "Marketing",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "experts": []
}

Retrieve a Data Product

Get a single data product by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the data product to retrieve.

fields

string

Comma-separated list of fields to include (e.g., owners,domain,experts,assets).

include

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/dataProducts/name/{fqn} to retrieve by fully qualified name.

fqn

string

required

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

fields

string

Comma-separated list of fields to include: owners, domain, experts, assets.

include

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/dataProducts/{id}

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"
)

# Get by ID
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
print(f"{dp.fullyQualifiedName}: {dp.description}")

# Get by ID with fields
dp = DataProducts.retrieve(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    fields=["owners", "domain", "experts", "assets"]
)

# Get by fully qualified name
dp = DataProducts.retrieve_by_name("Marketing.CustomerInsights")

# Get by name with fields
dp = DataProducts.retrieve_by_name(
    "Marketing.CustomerInsights",
    fields=["owners", "domain", "experts", "assets"]
)

import static org.openmetadata.sdk.fluent.DataProducts.*;

// Get by ID
var dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2");

// Get by ID with fields
var dp = DataProducts.retrieve(
    "b1839f98-f046-5f35-bdef-20f9b3395cb2",
    "owners,domain,experts,assets"
);

// Get by fully qualified name
var dp = DataProducts.retrieveByName("Marketing.CustomerInsights");

// Get by name with fields
var dp = DataProducts.retrieveByName(
    "Marketing.CustomerInsights",
    "owners,domain,experts,assets"
);

# Get by ID
curl "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2?fields=owners,domain,experts,assets" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/dataProducts/name/Marketing.CustomerInsights" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/dataProducts/name/Marketing.CustomerInsights?fields=owners,domain,experts,assets" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "Marketing.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",
  "domain": {
    "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "type": "domain",
    "name": "Marketing",
    "fullyQualifiedName": "Marketing",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "experts": []
}

Returns

Returns a data product object with all requested fields populated.

Response

string

Unique identifier for the data product (UUID format).

name

string

Data product name.

fullyQualifiedName

string

Fully qualified name in format domain.dataProductName.

displayName

string

Human-readable display name.

description

string

Description of the data product in Markdown format.

domain

object

Reference to the parent domain.

owners

array

List of owners. Only included when fields contains owners.

experts

array

Subject matter experts. Only included when fields contains experts.

assets

array

Associated data assets. Only included when fields contains assets.

version

number

Version number for the entity.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this data product
`404`	`NOT_FOUND`	Data product with given ID or FQN does not exist

Ports & Assets

Update a Data Product

​Retrieve a Data Product

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Data Product

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling