DPH Services API#

The DPH services module provides the main client for Data Product Hub Services operations.

Core Classes
- DphV1 Service

Main Service Class#

DphV1#

The DphV1 class provides access to all Data Product Hub Services operations. For detailed API reference including all methods, see Core Classes.

class wxdi.dph_services.dph_v1.DphV1(authenticator: Authenticator = None)

Bases: BaseService

The DPH V1 service.

Construct a new client for the DPH service.

Parameters:: authenticator (Authenticator, default: None) – The authenticator specifies the authentication mechanism. Get up to date information from IBM/python-sdk-core about initializing the authenticator of your choice.

DEFAULT_SERVICE_URL = 'https://api.dataplatform.dev.cloud.ibm.com/'

DEFAULT_SERVICE_NAME = 'data_product_hub_api_service'

classmethod new_instance(service_name: str = 'data_product_hub_api_service')

Return type:: DphV1
Parameters:: service_name (str)

Return a new client for the DPH service using the specified parameters and: external configuration.

__init__(authenticator: Authenticator = None)

Construct a new client for the DPH service.

Parameters:: authenticator (Authenticator, default: None) – The authenticator specifies the authentication mechanism. Get up to date information from IBM/python-sdk-core about initializing the authenticator of your choice.
Return type:: None

get_initialize_status(*, container_id: str | None = None, **kwargs)

Get resource initialization status.

Use this API to get the status of resource initialization in Data Product Hub. If the data product catalog exists but has never been initialized, the status will be “not_started”. If the data product catalog exists and has been or is being initialized, the response will contain the status of the last or current initialization. If the initialization failed, the “errors” and “trace” fields will contain the error(s) encountered during the initialization, including the ID to trace the error(s). If the data product catalog doesn’t exist, an HTTP 404 response is returned.

Parameters:

container_id (str | None, default: None) – (optional) Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of the default data product catalog.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_service_id_credentials(**kwargs)

Get service id credentials.

Use this API to get the information of service id credentials in Data Product Hub.

Parameters:: headers (dict) – A dict containing the request headers
Returns:: A DetailedResponse containing the result, headers and HTTP status code.
Return type:: DetailedResponse

initialize(*, container: ContainerReference | None = None, include: List[str] | None = None, **kwargs)

Initialize resources.

Use this API to initialize default assets for data product hub. You can initialize: <ul><li>`delivery_methods` - Methods through which data product parts can be delivered to consumers of the data product hub</li><li>`domains_multi_industry` - Taxonomy of domains and use cases applicable to multiple industries</li><li>`data_product_samples` - Sample data products used to illustrate capabilities of the data product hub</li><li>`workflows` - Workflows to enable restricted data products</li><li>`project` - A default project for exporting data assets to files</li><li>`catalog_configurations` - Catalog configurations for the default data product catalog</li></ul> If a resource depends on resources that are not specified in the request, these dependent resources will be automatically initialized. E.g., initializing data_product_samples will also initialize domains_multi_industry and delivery_methods even if they are not specified in the request because it depends on them. If initializing the data product hub for the first time, do not specify a container. The default data product catalog will be created. For first time initialization, it is recommended that at least delivery_methods and domains_multi_industry is included in the initialize operation. If the data product hub has already been initialized, you may call this API again to initialize new resources, such as new delivery methods. In this case, specify the default data product catalog container information.

Parameters:

container (ContainerReference | None, default: None) – (optional) Container reference.
include (List[str] | None, default: None) – (optional) List of configuration options to (re-)initialize.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

manage_api_keys(**kwargs)

Rotate credentials for a Data Product Hub instance.

Use this API to rotate credentials for a Data Product Hub instance.

Parameters:: headers (dict) – A dict containing the request headers
Returns:: A DetailedResponse containing the result, headers and HTTP status code.
Return type:: DetailedResponse

create_data_asset_visualization(*, assets: List[DataAssetRelationship] | None = None, **kwargs)

Create visualization asset and initialize profiling for the provided data assets.

Use this API to create visualization asset and initialize profiling for the provided data assets Provide the below required fields Required fields: - catalog_id - Collection of assetId with it’s related asset id .

Parameters:

assets (List[DataAssetRelationship] | None, default: None) – (optional) Data product hub asset and it’s related part asset.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

reinitiate_data_asset_visualization(*, assets: List[DataAssetRelationship] | None = None, **kwargs)

Reinitiate visualization for an asset.

Use this API to Reinitiate visualization for an asset which is in below scenarios - Previous bucket got deleted and new bucket is created. - Data visualization attachment is missing in asset details. - Visualization asset reference is missing in related asset details. .

Parameters:

assets (List[DataAssetRelationship] | None, default: None) – (optional) Data product hub asset and it’s related part asset.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

list_data_products(*, limit: int | None = None, start: str | None = None, **kwargs)

Retrieve a list of data products.

Parameters:

limit (int | None, default: None) – (optional) Limit the number of data products in the results. The maximum limit is 200.
start (str | None, default: None) – (optional) Start token for pagination.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

create_data_product(drafts: List[DataProductDraftPrototype], *, limit: int | None = None, start: str | None = None, **kwargs)

Create a new data product.

Use this API to create a new data product. Provide the initial draft of the data product. Required fields: - name - container If version is not specified, the default version 1.0.0 will be used. The domain is optional.

Parameters:

drafts (List[DataProductDraftPrototype]) – Collection of data products drafts to add to data product.
limit (int | None, default: None) – (optional) Limit the number of data products in the results. The maximum limit is 200.
start (str | None, default: None) – (optional) Start token for pagination.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_data_product(data_product_id: str, **kwargs)

Retrieve a data product identified by id.

Parameters:

data_product_id (str) – Data product ID.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

complete_draft_contract_terms_document(data_product_id: str, draft_id: str, contract_terms_id: str, document_id: str, **kwargs)

Complete a contract document upload operation.

After uploading a file to the provided signed URL, call this endpoint to mark the upload as complete. After the upload operation is marked as complete, the file is available to download. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly. - After the upload is marked as complete, the returned URL is displayed in the “url” field. The signed URL is used to download the document. - Calling complete on referential documents results in an error. - Calling complete on attachment documents for which the file has not been uploaded will result in an error.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
document_id (str) – Document id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

list_data_product_drafts(data_product_id: str, *, asset_container_id: str | None = None, version: str | None = None, limit: int | None = None, start: str | None = None, **kwargs)

Retrieve a list of data product drafts.

Retrieve a list of data product drafts. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
asset_container_id (str | None, default: None) – (optional) Filter the list of data product drafts by container id.
version (str | None, default: None) – (optional) Filter the list of data product drafts by version number.
limit (int | None, default: None) – (optional) Limit the number of data product drafts in the results. The maximum limit is 200.
start (str | None, default: None) – (optional) Start token for pagination.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

Create a new draft of an existing data product.

Parameters:

data_product_id (str) – Data product ID.
asset (AssetPrototype) – New asset input properties.
version (str | None, default: None) – (optional) The data product version number.
state (str | None, default: None) – (optional) The state of the data product version. If not specified, the data product version will be created in draft state.
data_product (DataProductIdentity | None, default: None) – (optional) Data product identifier.
name (str | None, default: None) – (optional) The name that refers to the new data product version. If this is a new data product, this value must be specified. If this is a new version of an existing data product, the name will default to the name of the previous data product version. A name can contain letters, numbers, understores, dashes, spaces or periods. A name must contain at least one non-space character.
description (str | None, default: None) – (optional) Description of the data product version. If this is a new version of an existing data product, the description will default to the description of the previous version of the data product.
tags (List[str] | None, default: None) – (optional) Tags on the data product.
use_cases (List[UseCase] | None, default: None) – (optional) A list of use cases associated with the data product version.
types (List[str] | None, default: None) – (optional) Types of parts on the data product.
contract_terms (List[ContractTerms] | None, default: None) – (optional) Contract terms binding various aspects of the data product.
domain (Domain | None, default: None) – (optional) Domain that the data product version belongs to. If this is the first version of a data product, this field is required. If this is a new version of an existing data product, the domain will default to the domain of the previous version of the data product.
parts_out (List[DataProductPart] | None, default: None) – (optional) The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data product, this field defaults to an empty list. If this is a new version of an existing data product, the data product parts will default to the parts list from the previous version of the data product.
workflows (DataProductWorkflows | None, default: None) – (optional) The workflows associated with the data product version.
dataview_enabled (bool | None, default: None) – (optional) Indicates whether the dataView has enabled for data product.
comments (str | None, default: None) – (optional) Comments by a producer that are provided either at the time of data product version creation or retiring.
access_control (AssetListAccessControl | None, default: None) – (optional) Access control object.
last_updated_at (datetime | None, default: None) – (optional) Timestamp of last asset update.
sub_container (ContainerIdentity | None, default: None) – (optional) The identity schema for a IBM knowledge catalog container (catalog/project/space).
is_restricted (bool | None, default: None) – (optional) Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data product requires explicit approval before data is delivered.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

create_draft_contract_terms_document(data_product_id: str, draft_id: str, contract_terms_id: str, type: str, name: str, *, url: str | None = None, **kwargs)

Upload a contract document to the data product draft contract terms.

Upload a contract document to the data product draft identified by draft_id. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly. - If the request object contains a “url” parameter, a referential document is created to store the provided url. - If the request object does not contain a “url” parameter, an attachment document is created, and a signed url will be returned in an “upload_url” parameter. The data product producer can upload the document using the provided “upload_url”. After the upload is completed, call “complete_contract_terms_document” for the given document needs to be called to mark the upload as completed. After completion of the upload, “get_contract_terms_document” for the given document returns a signed “url” parameter that can be used to download the attachment document.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
type (str) – Type of the contract document.
name (str) – Name of the contract document.
url (str | None, default: None) – (optional) URL that can be used to retrieve the contract document.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_data_product_draft(data_product_id: str, draft_id: str, **kwargs)

Get a draft of an existing data product.

Get a draft of an existing data product. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

delete_data_product_draft(data_product_id: str, draft_id: str, **kwargs)

Delete a data product draft identified by ID.

Delete a data product draft identified by a valid ID. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

update_data_product_draft(data_product_id: str, draft_id: str, json_patch_instructions: List[JsonPatchOperation], **kwargs)

Update the data product draft identified by ID.

Use this API to update the properties of a data product draft identified by a valid ID. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the properties of a data product - Add/Remove parts from a data product (up to 20 parts) - Add/Remove use cases from a data product - Update the data product state .

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
json_patch_instructions (List[JsonPatchOperation]) – A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_draft_contract_terms_document(data_product_id: str, draft_id: str, contract_terms_id: str, document_id: str, **kwargs)

Get a contract document.

If a document has a completed attachment, the response contains the url which can be used to download the attachment. If a document does not have a completed attachment, the response contains the url which was submitted at document creation. If a document has an attachment that is incomplete, an error is returned to prompt the user to upload the document file and complete it. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
document_id (str) – Document id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

delete_draft_contract_terms_document(data_product_id: str, draft_id: str, contract_terms_id: str, document_id: str, **kwargs)

Delete a contract document.

Delete an existing contract document. Contract documents can only be deleted for data product versions that are in DRAFT state. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
document_id (str) – Document id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

update_draft_contract_terms_document(data_product_id: str, draft_id: str, contract_terms_id: str, document_id: str, json_patch_instructions: List[JsonPatchOperation], **kwargs)

Update a contract document.

Use this API to update the properties of a contract document that is identified by a valid ID. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the url of document if it does not have an attachment. - Update the type of the document. Contract terms documents can only be updated if the associated data product version is in DRAFT state. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
document_id (str) – Document id.
json_patch_instructions (List[JsonPatchOperation]) – A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_data_product_draft_contract_terms(data_product_id: str, draft_id: str, contract_terms_id: str, *, accept: str | None = None, include_contract_documents: bool | None = None, autopopulate_server_information: bool | None = None, server_asset_id: str | None = None, **kwargs)

Retrieve a data product contract terms identified by id.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
accept (str | None, default: None) – (optional) The type of the response: application/json or application/odcs+yaml.
include_contract_documents (bool | None, default: None) – (optional) Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By default, these are included.
autopopulate_server_information (bool | None, default: None) – (optional) Set to true to autopopulate server information from connection details. Default is false.
server_asset_id (str | None, default: None) – (optional) Asset ID of the server used for autopopulating connection details.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

replace_data_product_draft_contract_terms(data_product_id: str, draft_id: str, contract_terms_id: str, *, asset: AssetReference | None = None, id: str | None = None, documents: List[ContractTermsDocument] | None = None, error_msg: str | None = None, overview: Overview | None = None, description: Description | None = None, organization: List[ContractTemplateOrganization] | None = None, roles: List[Roles] | None = None, price: Pricing | None = None, sla: List[ContractTemplateSLA] | None = None, support_and_communication: List[ContractTemplateSupportAndCommunication] | None = None, custom_properties: List[ContractTemplateCustomProperty] | None = None, contract_test: ContractTest | None = None, servers: List[ContractServer] | None = None, schema: List[ContractSchema] | None = None, **kwargs)

Update a data product contract terms identified by id.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
asset (AssetReference | None, default: None) – (optional) The reference schema for a asset in a container.
id (str | None, default: None) – (optional) ID of the contract terms.
documents (List[ContractTermsDocument] | None, default: None) – (optional) Collection of contract terms documents.
error_msg (str | None, default: None) – (optional) An error message, if existing, relating to the contract terms.
overview (Overview | None, default: None) – (optional) Overview details of a data contract.
description (Description | None, default: None) – (optional) Description details of a data contract.
organization (List[ContractTemplateOrganization] | None, default: None) – (optional) List of sub domains to be added within a domain.
roles (List[Roles] | None, default: None) – (optional) List of roles associated with the contract.
price (Pricing | None, default: None) – (optional) Represents the pricing details of the contract.
sla (List[ContractTemplateSLA] | None, default: None) – (optional) Service Level Agreement details.
support_and_communication (List[ContractTemplateSupportAndCommunication] | None, default: None) – (optional) Support and communication details for the contract.
custom_properties (List[ContractTemplateCustomProperty] | None, default: None) – (optional) Custom properties that are not part of the standard contract.
contract_test (ContractTest | None, default: None) – (optional) Contains the contract test status and related metadata.
servers (List[ContractServer] | None, default: None) – (optional) List of server definitions.
schema (List[ContractSchema] | None, default: None) – (optional) Schema details of the data asset.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

update_data_product_draft_contract_terms(data_product_id: str, draft_id: str, contract_terms_id: str, json_patch_instructions: List[JsonPatchOperation], **kwargs)

Update a contract terms property.

Use this API to update the properties of a contract terms that is identified by a valid ID. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the contract terms properties. Contract terms can only be updated if the associated data product version is in DRAFT state.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
json_patch_instructions (List[JsonPatchOperation]) – A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_contract_terms_in_specified_format(data_product_id: str, draft_id: str, contract_terms_id: str, format: str, format_version: str, *, accept: str | None = None, **kwargs)

Retrieve a data product contract terms identified by id in specified format.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
contract_terms_id (str) – Contract terms id.
format (str) – The format for returning contract terms. For example: odcs.
format_version (str) – The version of the format for returning contract terms. For example: 3.
accept (str | None, default: None) – (optional) The type of the response: application/odcs+yaml or application/json.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

publish_data_product_draft(data_product_id: str, draft_id: str, **kwargs)

Publish a draft of an existing data product.

Publish a draft of an existing data product. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
draft_id (str) – Data product draft id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_data_product_release(data_product_id: str, release_id: str, *, check_caller_approval: bool | None = None, **kwargs)

Get a release of an existing data product.

Get a release of an existing data product. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
release_id (str) – Data product release id.
check_caller_approval (bool | None, default: None) – (optional) If the value is true, then it will be verfied whether the caller is present in the data access request pre-approved user list.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

update_data_product_release(data_product_id: str, release_id: str, json_patch_instructions: List[JsonPatchOperation], **kwargs)

Update the data product release identified by ID.

Use this API to update the properties of a data product release identified by a valid ID. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the properties of a data product - Add/remove parts from a data product (up to 20 parts) - Add/remove use cases from a data product .

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
release_id (str) – Data product release id.
json_patch_instructions (List[JsonPatchOperation]) – A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_release_contract_terms_document(data_product_id: str, release_id: str, contract_terms_id: str, document_id: str, **kwargs)

Get a contract document.

If the document has a completed attachment, the response contains the url to download the attachment. If the document does not have an attachment, the response contains the url which was submitted at document creation. If the document has an incomplete attachment, an error is returned to prompt the user to upload the document file to complete the attachment. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
release_id (str) – Data product release id.
contract_terms_id (str) – Contract terms id.
document_id (str) – Document id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_published_data_product_draft_contract_terms(data_product_id: str, release_id: str, contract_terms_id: str, *, accept: str | None = None, include_contract_documents: bool | None = None, **kwargs)

Retrieve a published data product contract terms identified by id.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
release_id (str) – Data product release id.
contract_terms_id (str) – Contract terms id.
accept (str | None, default: None) – (optional) The type of the response: application/odcs+yaml or application/json.
include_contract_documents (bool | None, default: None) – (optional) Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By default, these are included.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

Retrieve a list of data product releases.

Retrieve a list of data product releases. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
asset_container_id (str | None, default: None) – (optional) Filter the list of data product releases by container id.
state (List[str] | None, default: None) – (optional) Filter the list of data product versions by state. States are: available and retired. Default is “available”,”retired”.
version (str | None, default: None) – (optional) Filter the list of data product releases by version number.
limit (int | None, default: None) – (optional) Limit the number of data product releases in the results. The maximum is 200.
start (str | None, default: None) – (optional) Start token for pagination.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

retire_data_product_release(data_product_id: str, release_id: str, *, revoke_access: bool | None = None, start_at: str | None = None, **kwargs)

Retire a release of an existing data product.

Retire a release of an existing data product. Use ‘-’ for the data_product_id to skip specifying the data product ID explicitly.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
release_id (str) – Data product release id.
revoke_access (bool | None, default: None) – (optional) Revoke’s Access from all the Subscriptions of the Data Product. No user’s can able to see the subscribed assets anymore.
start_at (str | None, default: None) – (optional) The date and time when the revoke access operation should start (ISO 8601 format, e.g., 2025-09-24T06:55:29Z). If not provided, the operation starts immediately.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

create_revoke_access_process(data_product_id: str, release_id: str, *, body: BinaryIO | None = None, content_type: str | None = None, **kwargs)

Revoke access from Data Product subscriptions.

Revoke’s access from Subscriptions of the data product id passed in the path parameter. Optionally specify a future date-time when the revoke access operation should start using the start_at field in ISO 8601 format (e.g., 2025-09-24T06:55:29Z). If start_at is not provided, the revoke access operation starts immediately.

Parameters:

data_product_id (str) – Data product ID. Use ‘-’ to skip specifying the data product ID explicitly.
release_id (str) – The unique identifier of the data product release.
body (BinaryIO | None, default: None) – (optional) Request parameters to handle revoke access from subscriptions. The start_at field can be used to schedule the revoke access operation for a future date-time.
content_type (str | None, default: None) – (optional) The type of the input.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

list_data_product_contract_template(*, container_id: str | None = None, contract_template_name: str | None = None, domain_ids: str | None = None, **kwargs)

Retrieve a list of data product contract templates.

Parameters:

container_id (str | None, default: None) – (optional) Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of the default data product catalog.
contract_template_name (str | None, default: None) – (optional) Name of the data product contract template. If not supplied, the data product templates within the catalog will returned.
domain_ids (str | None, default: None) – (optional) Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product templates within the catalog will returned.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

Create new data product contract template.

Parameters:

container (ContainerReference) – Container reference.
id (str | None, default: None) – (optional) The identifier of the data product contract template.
creator_id (str | None, default: None) – (optional) The identifier of the user who created the data product contract template.
created_at (str | None, default: None) – (optional) The timestamp when the data product contract template was created.
name (str | None, default: None) – (optional) The name of the contract template.
error (ErrorMessage | None, default: None) – (optional) Contains the code and details.
contract_terms (ContractTerms | None, default: None) – (optional) Defines the complete structure of a contract terms.
container_id (str | None, default: None) – (optional) Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of the default data product catalog.
contract_template_name (str | None, default: None) – (optional) Name of the data product contract template. If not supplied, the data product templates within the catalog will returned.
domain_ids (str | None, default: None) – (optional) Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product templates within the catalog will returned.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_contract_template(contract_template_id: str, container_id: str, **kwargs)

Retrieve a data product contract template identified by id.

Parameters:

contract_template_id (str) – Data Product Contract Template id.
container_id (str) – Container ID of the data product catalog.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

delete_data_product_contract_template(contract_template_id: str, container_id: str, **kwargs)

Delete a data product contract template identified by id.

Parameters:

contract_template_id (str) – Data Product Contract Template id.
container_id (str) – Container ID of the data product catalog.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

update_data_product_contract_template(contract_template_id: str, container_id: str, json_patch_instructions: List[JsonPatchOperation], **kwargs)

Update the data product contract template identified by ID.

Use this API to update the properties of a data product contract template identified by a valid ID. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the name of a data product contract template - Update the contract terms of data product contract template .

Parameters:

contract_template_id (str) – Data Product Contract Template id.
container_id (str) – Container ID of the data product catalog.
json_patch_instructions (List[JsonPatchOperation]) – A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

list_data_product_domains(*, container_id: str | None = None, include_subdomains: bool | None = None, **kwargs)

Retrieve a list of data product domains.

Parameters:

container_id (str | None, default: None) – (optional) Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of the default data product catalog.
include_subdomains (bool | None, default: None) – (optional) Include subdomains in the response.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

Create new data product domain.

Parameters:

container (ContainerReference) – Container reference.
trace (str | None, default: None) – (optional) The id to trace the failed domain creations.
errors (List[ErrorModelResource] | None, default: None) – (optional) Set of errors on the sub domain creation.
name (str | None, default: None) – (optional) The name of the data product domain.
description (str | None, default: None) – (optional) The description of the data product domain.
id (str | None, default: None) – (optional) The identifier of the data product domain.
created_by (str | None, default: None) – (optional) The identifier of the creator of the data product domain.
member_roles (MemberRolesSchema | None, default: None) – (optional) Member roles of a corresponding asset.
properties (PropertiesSchema | None, default: None) – (optional) Properties of the corresponding asset.
sub_domains (List[InitializeSubDomain] | None, default: None) – (optional) List of sub domains to be added within a domain.
sub_container (ContainerIdentity | None, default: None) – (optional) The identity schema for a IBM knowledge catalog container (catalog/project/space).
link_to_subcontainers (bool | None, default: None) – (optional) Link domains to subcontainers.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

create_data_product_subdomain(domain_id: str, container_id: str, *, name: str | None = None, id: str | None = None, description: str | None = None, **kwargs)

Create data product subdomains for a specific domain identified by id.

Parameters:

domain_id (str) – Domain id.
container_id (str) – Container ID of the data product catalog.
name (str | None, default: None) – (optional) The name of the data product subdomain.
id (str | None, default: None) – (optional) The identifier of the data product subdomain.
description (str | None, default: None) – (optional) The description of the data product subdomain.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_domain(domain_id: str, **kwargs)

Retrieve a data product domain or subdomain identified by id.

Parameters:

domain_id (str) – Domain id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

delete_domain(domain_id: str, **kwargs)

Delete a data product domain identified by id.

Parameters:

domain_id (str) – Domain id.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

update_data_product_domain(domain_id: str, container_id: str, json_patch_instructions: List[JsonPatchOperation], **kwargs)

Update the data product domain identified by ID.

Use this API to update the properties of a data product domain identified by a valid ID. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the name of a data product domain - Update the description of a data product domain - Update the rov of a data product domain .

Parameters:

domain_id (str) – Domain id.
container_id (str) – Container ID of the data product catalog.
json_patch_instructions (List[JsonPatchOperation]) – A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_data_product_by_domain(domain_id: str, container_id: str, **kwargs)

Retrieve all data products in a domain specified by id or any of it’s subdomains.

Retrieve all the data products tagged to the domain identified by id or any of it’s subdomains.

Parameters:

domain_id (str) – Domain id.
container_id (str) – Container ID of the data product catalog.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

create_s3_bucket(is_shared: bool, **kwargs)

Create a new Bucket.

Use this API to create a new S3 Bucket on an AWS Hosting.

Parameters:

is_shared (bool) – Flag to specify whether the bucket is dedicated or shared.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_s3_bucket_validation(bucket_name: str, **kwargs)

Validate the Bucket Existence.

Use this API to validate the bucket existence on an AWS hosting.

Parameters:

bucket_name (str) – Name of the bucket to validate.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

get_revoke_access_process_state(release_id: str, *, limit: int | None = None, start: str | None = None, **kwargs)

Access revoke status of the subscriptions against the data product release id.

Retrieves the status of revoke access requests.

Parameters:

release_id (str) – Pass the data product release version id to retrieve job runs state for that specific DPV ID.
limit (int | None, default: None) – (optional) Limit the number of tracking assets in the results. The maximum is 200.
start (str | None, default: None) – (optional) Start token for pagination.
headers (dict) – A dict containing the request headers

Returns:

A DetailedResponse containing the result, headers and HTTP status code.

Return type:

DetailedResponse

DPH Services API

Section Contents

DPH Services API#

Main Service Class#

DphV1#