Index

Properties

activateDataProduct: typeof activateDataProduct

Activates a data product for publishing and consumption. Once activated, the data product becomes discoverable and accessible to authorized users. Requires publish permissions and valid data product configuration.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

an object with the body content

ActivateDataProductHttpError

clearCache: typeof dataProducts.clearCache

Clears the cache for data-products api requests.

createDataProduct: typeof createDataProduct

Creates a new data product with specified metadata, datasets, and governance information. Use this endpoint to package related datasets into a governed, discoverable asset. Requires create permissions in the target space.

an object with the body content

CreateDataProductHttpError

deactivateDataProduct: typeof deactivateDataProduct

Deactivates a data product, preventing it from being consumed by other services or users.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

DeactivateDataProductHttpError

deleteDataProduct: typeof deleteDataProduct

Permanently removes a data product from the tenant. This action cannot be undone and does not affect the underlying datasets. Requires delete permissions for the data product.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

DeleteDataProductHttpError

exportDocumentationDataProduct: typeof exportDocumentationDataProduct

Exports data product documentation in Markdown format. Use this endpoint to generate documentation for sharing or archiving. Requires read access to the data product.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

ExportDocumentationDataProductHttpError

generateProviderUrlDataProducts: typeof generateProviderUrlDataProducts

Generates a URL to access a third-party provider's user interface. Use this endpoint to integrate external services with your data product.

an object with query parameters

GenerateProviderUrlDataProductsHttpError

getDataProduct: typeof getDataProduct

Retrieves the details of the specified data product, including name, description, associated datasets, key contacts, and activation status. Requires read access to the Data Product.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

GetDataProductHttpError

getDataProductChangelogs: typeof getDataProductChangelogs

Retrieves a paginated history of all notable changes made to a data product. Each changelog entry captures the operation type, affected property, and timestamp. Use this endpoint to track the history of changes or data product evolution over time.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

an object with query parameters

GetDataProductChangelogsHttpError

moveDataProduct: typeof moveDataProduct

Moves a data product from its current space to a different space. Use this endpoint to reorganize data products across workspaces or governance domains. Requires delete permissions in the source space and create permissions in the target space.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

an object with the body content

MoveDataProductHttpError

patchDataProduct: typeof patchDataProduct

Partially updates an existing data product using JSON Patch operations. Use this endpoint to modify properties such as name, description, datasets, tags, or key contacts. Changes are tracked in the data product changelog.

Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

an object with the body content

PatchDataProductHttpError