Introduction IMPORTANT: Watson Data API documentation is deprecated and might be out of date. The relevant functionality is now described in the following documents: 1. Common core functionality APIs for Data and AI SaaS productshttps://cloud.ibm.com/apidocs/data-ai-common-core 2. IBM Knowledge Catalog as a Service APIshttps://cloud.ibm.com/apidocs/knowledge-catalog 3. IBM watsonx.ai as a Service APIshttps://cloud.ibm.com/apidocs/watsonx-ai You can use a collection of Watson Data REST APIs associated with Watson Studio and Watson Knowledge Catalog to manage data-related assets and the people who need to use these assets. Refine data Use the sampling APIs to create representative subsets of the data on which to test and refine your data cleansing and shaping operations. To better understand the contents of your data, you can create profiles of your data assets that include a classification of the data and additional distribution information which assists in determining the data quality. Catalog data Use the catalog APIs to create catalogs to administer your assets, associate properties with those assets, and organize the users who use the assets. Assets can be notebooks or connections to files, database sources, or data assets from a connection. Data policies Use the data policy APIs to implement data policies and a business glossary that fits to your organization to control user access rights to assets and to make it easier to find data. Ingest streaming data Use the streams flow APIs to hook up continuous, unidirectional flows of massive volumes of moving data that you can analyze in real time. API Endpoint https://api.dataplatform.cloud.ibm.com Creating an IAM bearer token Before you can call a Watson Data API you must first create an IAMhttps://cloud.ibm.com/docs/account?topic=account-iamoverview bearer token. Each token is valid only for one hour, and after a token expires you must create a new one if you want to continue using the API. The recommended method to retrieve a token programmatically is to create an API key for your IBM Cloud identity and then use the IAM token API to exchange that key for a token. You can create a token in IBM Cloud or by using the IBM Cloud command line interface CLI. To create a token in the IBM Cloud: 1. Log in to IBM Cloudhttps://cloud.ibm.com/ and select Manage Access IAM API keys. 2. Create an API key for your own personal identity, copy the key value, and save it in a secure place. After you leave the page, you will no longer be able to access this value. 3. With your API key, set up Postman or another REST API tool and run the following command to the right You can read more about managing API keys at Understanding API keyshttps://cloud.ibm.com/docs/account?topic=account-manapikey documentation page. Curl command with API key to retrieve token curl -X POST 'https://iam.cloud.ibm.com/identity/token' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'granttype=urn:ibm:params:oauth:grant-type:apikey&apikey=MYAPIKEY' Response json { "accesstoken": "eyJhbGciOiJIUz......sgrKIi8hdFs", "refreshtoken": "SPrXw5tBE3......KBQ+luWQVY=", "tokentype": "Bearer", "expiresin": 3600, "expiration": 1473188353 } 4. Use the value of the accesstoken property for your Watson Data API calls. Set the accesstoken value as the authorization header parameter for requests to the Watson Data APIs. The format is Authorization: Bearer Method Path Summary GET /v2/asset_files Get a list of file paths. PUT /v2/asset_files Create project, catalog, space or account root folder. DELETE /v2/asset_files Batch delete or delete project/catalog/account/space folder. GET /v2/asset_files/{path} Get Asset File HEAD /v2/asset_files/{path} Get Asset File Headers PUT /v2/asset_files/{path} Put New Asset File DELETE /v2/asset_files/{path} Delete Single Asset File/Folder POST /v2/asset_files/{path}/signed Get auth signature POST /v2/asset_files/{path}/deflate Create archive for target POST /v2/asset_files/inflate Inflate the source archive to the target location POST /v2/asset_files/copy Copy Asset File POST /v2/asset_files/async_copy Copy Asset File (async) POST /v2/asset_files/git_transactions/export Git Export POST /v2/asset_files/git_transactions/import Git Import POST /v2/asset_files/git_transactions/remote Git Add Remote POST /v2/asset_files/git_transactions/delete_remote Git Remove Remote POST /v2/asset_files/git_transactions/fetch Git Fetch POST /v2/asset_files/git_transactions/status Git status POST /v2/asset_files/git_transactions/pull Git Pull PUT /v2/asset_files/git_transactions/settings Change Git Settings GET /v2/asset_files/git_transactions/settings Get Git Settings POST /v2/asset_containers/archive Archive the asset container GET /v2/asset_containers/archive_info Get archive information of the asset container GET /v2/asset_containers/configurations Get configurations PUT /v2/asset_containers/configurations Replace or create configurations POST /v2/asset_containers/restore Restore the asset container GET /v2/asset_lists List all asset lists defined for an account POST /v2/asset_lists Create a new asset list DELETE /v2/asset_lists Delete asset lists GET /v2/asset_lists/{asset_list_id} Retrieve an asset list identified by ID DELETE /v2/asset_lists/{asset_list_id} Delete an asset list identified by ID PATCH /v2/asset_lists/{asset_list_id} Update the metadata of an asset list GET /v2/asset_lists/{asset_list_id}/items List the items of an asset list identified by ID GET /v2/asset_lists/{asset_list_id}/items/{asset_list_item_id} Retrieve an item in an asset list PATCH /v2/asset_lists/{asset_list_id}/items/{asset_list_item_id} Update an asset list item GET /v2/asset_relationship_types Searches for relationship types POST /v2/asset_relationship_types Creates an asset relationship type POST /v2/asset_relationship_types/search_ends Searches for relationship type ends POST /v2/asset_relationship_types/search_used_ends Finds relationship types that are used by an asset, column or governance artifact DELETE /v2/asset_relationship_types/{relationship_type_id} deleteRelationshipType PATCH /v2/asset_relationship_types/{relationship_type_id} Patches a relationship type GET /v2/asset_types List all asset types defined for an account, catalog, project or space. POST /v2/asset_types Creates an asset type in an account, catalog, project or space. GET /v2/asset_types/{type_name} Retrieves an asset type of a given name. PUT /v2/asset_types/{type_name} Replace an asset type DELETE /v2/asset_types/{type_name} Deletes an asset type GET /v2/asset_types/{type_name}/relationships Finds relationship types for an asset type POST /v2/asset_types/{type_name}/search Search for asset metadata within assets of the specified type GET /v2/asset_types/{type_name}/status Get the status of an account scope or global scope asset type. POST /v2/assets Create an asset GET /v2/assets/bulk Get one or more assets. DELETE /v2/assets/bulk Marks existing assets for delete GET /v2/assets/bulk/members/{member_id} Get assets membership for a specific user POST /v2/assets/bulk_copy Copies one or more assets and, if deep copy option is on, their related assets from a source container to a target container. POST /v2/assets/bulk_create Create one or more assets. POST /v2/assets/bulk_patch Patch one or more assets. GET /v2/assets/copy_status/{copy_task_id} Gets the status of asset copy operation POST /v2/assets/create_object_url Create a PUT signed url for an object or a file GET /v2/assets/deepcopy/{deep_copy_task_id} Gets the status of a deep copy operation POST /v2/assets/duplicates/bulk_search Bulk search duplicate assets POST /v2/assets/duplicates/search Search duplicate assets GET /v2/assets/ibm_data_source Get an ibm_data_source asset POST /v2/assets/publish Publish an asset from a project which is only referenced in that project GET /v2/assets/{asset_id} Get an asset DELETE /v2/assets/{asset_id} Marks an existing asset for delete PATCH /v2/assets/{asset_id} Update an asset POST /v2/assets/{asset_id}/clone Clone an asset PATCH /v2/assets/{asset_id}/collaborators Add/Update asset collaborators POST /v2/assets/{asset_id}/deepcopy Deep copies an asset and its related assets to a catalog, project, or space PUT /v2/assets/{asset_id}/owner Update the owner of an asset PUT /v2/assets/{asset_id}/perms Update privacy settings of an asset POST /v2/assets/{asset_id}/promote Promote an asset POST /v2/assets/{asset_id}/publish Publish an asset POST /v2/assets/get_relationships Finds related assets POST /v2/assets/search_relationships Searches for relationships POST /v2/assets/set_relationships Create asset relationships POST /v2/assets/unset_relationships Deletes asset relationships GET /v2/assets/{asset_id}/relationship_types Finds relationship types used by an asset GET /v2/assets/{asset_id}/relationships Finds related assets PUT /v2/assets/{asset_id}/relationships/{relationship_name} Create asset relationships DELETE /v2/assets/{asset_id}/relationships/{relationship_name} Deletes asset relationships HEAD /v2/assets/{asset_id}/relationships/{relationship_name} Determine if a relationship exists between an asset and a target artifact POST /v2/assets/{asset_id}/attachments Create an attachment GET /v2/assets/{asset_id}/attachments/{attachment_id} Get an attachment DELETE /v2/assets/{asset_id}/attachments/{attachment_id} Delete an attachment PATCH /v2/assets/{asset_id}/attachments/{attachment_id} Update attachment metadata POST /v2/assets/{asset_id}/attachments/{attachment_id}/complete Mark an attachment as transfer complete PATCH /v2/assets/{asset_id}/attachments/{attachment_id}/datasource_type Auto update attachment's datasource_type from connection asset GET /v2/assets/{asset_id}/attachments/{attachment_id}/resources Get resources info for an attachment PUT /v2/assets/{asset_id}/attachments/{attachment_id}/resources Increase resources for an attachment GET /v2/assets/{asset_id}/attributes List all attributes POST /v2/assets/{asset_id}/attributes Create an attribute GET /v2/assets/{asset_id}/attributes/{attribute_key} Get an attribute DELETE /v2/assets/{asset_id}/attributes/{attribute_key} Delete an attribute PATCH /v2/assets/{asset_id}/attributes/{attribute_key} Update attributes GET /v2/assets/{asset_id}/conflicts Get asset document conflicts DELETE /v2/assets/{asset_id}/conflicts Delete asset document conflicts GET /v2/assets/{asset_id}/images Get the image of asset PUT /v2/assets/{asset_id}/images Upload an image for asset DELETE /v2/assets/{asset_id}/images/{image_id} Delete the image of asset GET /v2/assets/{asset_id}/notes Get asset or column notes POST /v2/assets/{asset_id}/notes Create notes on an asset GET /v2/assets/{asset_id}/notes/{note_id} Get an asset or column note DELETE /v2/assets/{asset_id}/notes/{note_id} Delete an asset or a column note PATCH /v2/assets/{asset_id}/notes/{note_id} Update an asset or column note GET /v2/assets/{asset_id}/ratings Get ratings of an asset POST /v2/assets/{asset_id}/ratings Rate an asset GET /v2/assets/{asset_id}/ratings/stats Get the count of each rating value for the specified asset DELETE /v2/assets/{asset_id}/ratings/{asset_rating_id} Delete an asset rating PATCH /v2/assets/{asset_id}/ratings/{asset_rating_id} Use this API to update an asset rating. GET /v2/assets/{asset_id}/revisions Get a list of revisions for an asset POST /v2/assets/{asset_id}/revisions Commit a revision of an asset DELETE /v2/assets/{asset_id}/revisions Delete a revision POST /v2/cams/admin/index_repairs Find and repair stuck temporary design documents by creating cache entries that resume their processing GET /v2/cams/admin/index_repairs/{id} Gets the status of a temporary design document repair operation POST /v2/cams/admin/reconfigure Reconfigure the asset container DELETE /v2/cams/admin/roles_cache_entry invalidateRoleCacheEntry GET /v2/cams/metrics/asset_list_count Get metrics of the asset lists GET /v2/cams/metrics/user_access_count Get metrics of the users who accessed the catalogs GET /v2/catalogs List all catalogs for a specific account POST /v2/catalogs Create a catalog GET /v2/catalogs/default Retrieve the default catalog POST /v2/catalogs/default Create the default catalog POST /v2/catalogs/default/rehome Rehome one or more synced assets. GET /v2/catalogs/default/rehome/status Monitor status of rehome task GET /v2/catalogs/{catalog_id} Get a catalog by catalog ID DELETE /v2/catalogs/{catalog_id} Delete a catalog by catalog ID PATCH /v2/catalogs/{catalog_id} Update catalog GET /v2/catalogs/{catalog_id}/properties List all properties of a catalog PATCH /v2/catalogs/{catalog_id}/properties Update catalog properties GET /v2/catalogs/{catalog_id}/properties/{property_key} Get a single property in a catalog PATCH /v2/catalogs/{catalog_id}/reconfigure Update catalog connections GET /v2/catalogs/{catalog_id}/state Get the catalog state POST /v2/catalogs/export_assets Export as a zip file containing appropriate csv files for the selected assets POST /v2/catalogs/import_assets Process an import asset POST /v2/catalogs/temporary_credentials Request temporary security credentials GET /v2/catalogs/{catalog_id}/collections/{collection_id} Get a catalog-level collection by collection ID PUT /v2/catalogs/{catalog_id}/collections/{collection_id} Update a catalog-level collection for a catalog DELETE /v2/catalogs/{catalog_id}/collections/{collection_id} Delete a catalog-level collection by collection id GET /v2/catalogs/{catalog_id}/members List all members of the catalog POST /v2/catalogs/{catalog_id}/members Add members to a catalog DELETE /v2/catalogs/{catalog_id}/members/bulk Delete members from a catalog GET /v2/catalogs/{catalog_id}/members/{member_id} Get catalog membership for a specific user DELETE /v2/catalogs/{catalog_id}/members/{member_id} Delete a member from a catalog PATCH /v2/catalogs/{catalog_id}/members/{member_id} Update members in a catalog POST /v2/data_assets Create a data asset GET /v2/data_assets/{data_asset_id} Get a data asset GET /v2/data_assets/{data_asset_id}/columns Get columns of a data asset POST /v2/folder_assets Create a folder asset GET /v2/folder_assets/{asset_id} Get a folder asset GET /v2/folder_assets/{asset_id}/contents Get a signed URL of an item to be downloaded GET /v2/trashed_assets List all assets in the trash (Marked for delete) GET /v2/trashed_assets/count Get count of all assets in the trash (Marked for delete) DELETE /v2/trashed_assets/purge_all Delete all assets from trash GET /v2/trashed_assets/{asset_id} Get a soft-deleted object from trash DELETE /v2/trashed_assets/{asset_id} Delete an asset from the trash POST /v2/trashed_assets/{asset_id}/restore Restore an asset from the trash GET /v2/connections List defined connections POST /v2/connections Define connection GET /v2/connections/{connection_id} Get connection DELETE /v2/connections/{connection_id} Delete connection PATCH /v2/connections/{connection_id} Update connection POST /v2/connections/upgrade Upgrade connections POST /v2/connections/assets Discover assets GET /v2/connections/{connection_id}/assets Discover assets GET /v2/connections/assets/{data_asset_id} Discover data asset GET /v2/connections/{connection_id}/actions List actions PUT /v2/connections/{connection_id}/actions/{action_name} Perform action GET /v2/connections/files/{file_name} Download a file POST /v2/connections/files/{file_name} Upload a file DELETE /v2/connections/files/{file_name} Delete a file GET /v2/connections/files List files PUT /v2/connections/files Migrate files GET /v2/datasource_types List defined types of data sources POST /v2/datasource_types Define data source type GET /v2/datasource_types/{datasource_type} Get details for type of data source DELETE /v2/datasource_types/{datasource_type} Delete data source type PATCH /v2/datasource_types/{datasource_type} Update datasource type POST /v2/metadata_enrichment/metadata_enrichment_area Create a metadata enrichment area asset GET /v2/metadata_enrichment/metadata_enrichment_area/settings Retrieve metadata enrichment settings PUT /v2/metadata_enrichment/metadata_enrichment_area/settings Create or update metadata enrichment settings GET /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id} Retrieve details of a Metadata Enrichment Area asset DELETE /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id} Delete a metadata enrichment asset PATCH /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id} edit a metadata enrichment area asset PATCH /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope Add or remove assets from data scope POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/assign_terms Assign business terms to data assets POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/assign_terms Assign business terms to columns of data assets POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/dataclass Assign or remove a data class to columns of data assets POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/remove_terms Remove business terms from columns of data assets. POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/review Adds or updates the review timestamp for given columns. POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/unreview Removes review timestamp for given columns. POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/enrich Enrich selected data assets POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/remove_terms Remove business terms from data assets POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/review Review a given list of data assets. POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/unreview Removes review timestamp from the given assets POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/publish_assets Publish all assets or a subset of assets of a Metadata Enrichment Area to a catalog POST /v2/metadata_imports Create a Metadata Import asset POST /v2/metadata_imports/bulk_delete_assets Bulk delete data assets in Metadata discovery DELETE /v2/metadata_imports/bulk_delete_metadataImport_assets Bulk delete metadata import assets in Metadata discovery POST /v2/metadata_imports/bulk_publish_assets Bulk publish data assets in Metadata discovery GET /v2/metadata_imports/connections Get a list of supported datasource types POST /v2/metadata_imports/job_runs/reconcile Reconcile the status of the job run record w.r.t the Discovery status POST /v2/metadata_imports/recover_task Restart the pending a job run POST /v2/metadata_imports/validate_metadata_import_job Validate the attempt to delete job associated with Metadata import asset POST /v2/metadata_imports/validate_sap_connection Validates a SAP Business Metadata connection GET /v2/metadata_imports/{metadata_import_id} Retrieve details of a Metadata Import DELETE /v2/metadata_imports/{metadata_import_id} delete a metadata import asset PATCH /v2/metadata_imports/{metadata_import_id} edit a metadata import asset POST /v2/metadata_imports/job_runs Start a Metadata Import job POST /v2/metadata_imports/job_runs/cancel cancel a Metadata Import run GET /v2/data_profiles List data profiles POST /v2/data_profiles Create data profile GET /v2/data_profiles/{profile_id} Get data profile DELETE /v2/data_profiles/{profile_id} Delete data profile PATCH /v2/data_profiles/{profile_id} Update data profile POST /v2/data_profiles/bulk Update data profiles PUT /v2/data_profiles/{profile_id}/execution Stop profiling process GET /v2/data_profiles/{profile_id}/logs Get profiling logs GET /v2/data_profiles/dqdimensions Get the list of data quality dimensions available. PATCH /v2/data_profiles/classification Modify asset level classification GET /v2/data_profiles/export Export data profile POST /v2/data_profiles/import Import data profile POST /v2/data_profiles/{profile_id}/unique_values This filters rows from the frequency distribution. GET /v2/data_profiles/options Get data profile options POST /v2/data_profiles/options Create data profile options DELETE /v2/data_profiles/options Delete data profile options PATCH /v2/data_profiles/options Update the data profile options. POST /v2/data_profiles/results Persist profiling results POST /v2/data_profiles/results/status Update data profile results status GET /v2/data_profiles/bivariate_results Get bivariate results of given asset. POST /v2/data_profiles/bivariate_results Persist bivariate results of given asset. POST /v2/data_profiles/migrate Migrate data profile quality results to new Data Quality service GET /v1/hb_tasks List Hummingbird tasks POST /v1/hb_tasks Create a Hummingbird task POST /v1/hb_tasks/stop Stop Hummingbird tasks POST /v1/hb_tasks/delete Delete Hummingbird tasks GET /v1/hb_tasks/{hb_task_id} Get HB task DELETE /v1/hb_tasks/{hb_task_id} Delete Hummingbird task POST /v1/hb_tasks/{hb_task_id}/start Start Hummingbird task POST /v1/hb_tasks/{hb_task_id}/stop Stop Hummingbird task GET /v1/hb_tasks/{hb_task_id}/logs Get Hummingbird task logs GET /data_quality/v4/assets Get data quality assets POST /data_quality/v4/assets Create Data quality assets GET /data_quality/v4/assets/{id} Get a data quality asset DELETE /data_quality/v4/assets/{id} Delete data quality asset PATCH /data_quality/v4/assets/{id} Update or patch a data quality asset POST /data_quality/v4/search_dq_asset Search data quality asset with given native id and type GET /data_quality/v4/assets/{id}/sla_assessments List SLA assessments for an asset GET /data_quality/v4/assets/{id}/sla_assessments/{assessment_id} Get an SLA assessment GET /data_quality/v4/assets/{id}/sla_assessments/{assessment_id}/violations Get the SLA violations for the given assessment GET /data_quality/v4/checks Get data quality checks POST /data_quality/v4/checks Create data quality checks GET /data_quality/v4/checks/{id} Get a data quality check DELETE /data_quality/v4/checks/{id} Delete a data quality check PATCH /data_quality/v4/checks/{id} Update or patch a data quality check POST /data_quality/v4/search_dq_check Search for a data quality check by its native id and type GET /data_quality/v4/dimensions Get a list of data quality dimensions POST /data_quality/v4/dimensions Create a data quality dimension GET /data_quality/v4/dimensions/{id} Get the data quality dimension with the given identifier DELETE /data_quality/v4/dimensions/{id} Delete the data quality dimension with the given identifier.
PATCH /data_quality/v4/dimensions/{id} Update a data quality dimension as specified in the payload details of the request POST /data_quality/v4/search_dq_dimension Search for data quality dimensions by name or part of their names GET /data_quality/v4/issues Get a list of data quality issues POST /data_quality/v4/issues Create a data quality issue GET /data_quality/v4/issues/{id} Get the data quality issue with the given identifier PATCH /data_quality/v4/issues/{id} Update a data quality issue as specified in the payload details
of the request.
POST /data_quality/v4/search_dq_issue Search for a data quality issue by its native id POST /data_quality/v4/create_issues Create several data quality issues. The related DQ assets referenced by their native ID are created if they do not already exist GET /data_quality/v4/scores Get a list of data quality scores for a given asset GET /data_quality/v4/bulkScores Get a list of data quality scores for a given assets GET /data_quality/v4/slas Get a list of data quality SLAs POST /data_quality/v4/slas Create a data quality SLA GET /data_quality/v4/slas/{sla_id} Get a data quality SLA PUT /data_quality/v4/slas/{sla_id} Update a data quality SLA DELETE /data_quality/v4/slas/{sla_id} Delete a data quality SLA GET /data_quality/v4/assets/{id}/sla_assessments List SLA assessments for an asset GET /data_quality/v4/assets/{id}/sla_assessments/{assessment_id} Get an SLA assessment GET /data_quality/v4/assets/{id}/sla_assessments/{assessment_id}/violations Get the SLA violations for the given assessment GET /data_quality/v4/sla_assessment_activation Get the status of the data quality SLA assessment activation PUT /data_quality/v4/sla_assessment_activation Activate or deactivate data quality SLA assessments GET /data_quality/v3/projects/{project_id}/rules List all data quality rules or a subset of them POST /data_quality/v3/projects/{project_id}/rules Create data quality rule DELETE /data_quality/v3/projects/{project_id}/rules Delete data quality rules POST /data_quality/v3/projects/{project_id}/validate_rule Validate data quality rule GET /data_quality/v3/projects/{project_id}/rules/{id} Get data quality rule DELETE /data_quality/v3/projects/{project_id}/rules/{id} Delete data quality rule PATCH /data_quality/v3/projects/{project_id}/rules/{id} Update data quality rule POST /data_quality/v3/projects/{project_id}/rules/{id}/execute Run data quality rule GET /data_quality/v3/catalogs/{catalog_id}/rules/{id} Get data quality rule from catalog GET /data_quality/v3/projects/{project_id}/rules/{rule_id}/executions List history of all data quality rule run results or a subset of them GET /data_quality/v3/projects/{project_id}/rules/{rule_id}/executions/{id} Get the data quality rule run GET /data_quality/v3/projects/{project_id}/definitions List all data quality definitions or a subset of them POST /data_quality/v3/projects/{project_id}/definitions Create data quality definition DELETE /data_quality/v3/projects/{project_id}/definitions Delete data quality definitions POST /data_quality/v3/projects/{project_id}/validate_definition Validate data quality definition expression GET /data_quality/v3/projects/{project_id}/definitions/{id} Get data quality definition PUT /data_quality/v3/projects/{project_id}/definitions/{id} Replace data quality definition DELETE /data_quality/v3/projects/{project_id}/definitions/{id} Delete data quality definition PATCH /data_quality/v3/projects/{project_id}/definitions/{id} Update data quality definition GET /data_quality/v3/catalogs/{catalog_id}/definitions/{id} Get data quality definition from catalog PATCH /data_quality/v3/catalogs/{catalog_id}/definitions/{id} Update data quality definition in catlog GET /data_quality/v3/projects/{project_id}/dimensions List all data quality dimensions GET /data_quality/v3/projects/{project_id}/settings Get project settings for data quality rules PUT /data_quality/v3/projects/{project_id}/settings Replace project settings for data quality rules GET /v2/environments List environments. POST /v2/environments Create a new environment. GET /v2/environments/{environment_guid} Retrieve an environment. DELETE /v2/environments/{environment_guid} Delete an environment. PATCH /v2/environments/{environment_guid} Update an environment. GET /v2/hardware_specifications List hardware specifications. POST /v2/hardware_specifications Create a new hardware specification. GET /v2/hardware_specifications/{hardware_specification_guid} Retrieve a hardware specification. DELETE /v2/hardware_specifications/{hardware_specification_guid} Delete a hardware specification. PATCH /v2/hardware_specifications/{hardware_specification_guid} Update a hardware specification. GET /v2/software_specifications List software specifications. POST /v2/software_specifications Create a new software specification. PATCH /v2/software_specifications/{software_specification_guid} Update a software specification. GET /v2/software_specifications/{software_specification_guid} Retrieve a software specification. DELETE /v2/software_specifications/{software_specification_guid} Delete a software specification. PUT /v2/software_specifications/{software_specification_guid}/package_extensions/{package_extension_guid} Add a package extension to a software specification. DELETE /v2/software_specifications/{software_specification_guid}/package_extensions/{package_extension_guid} Remove a package extension from a software specification. GET /v2/package_extensions List package extensions. POST /v2/package_extensions Create a new package extension. POST /v2/package_extensions/{package_extension_guid}/upload_complete Mark file upload complete. PATCH /v2/package_extensions/{package_extension_guid} Update a package extension. GET /v2/package_extensions/{package_extension_guid} Retrieve a package extension. DELETE /v2/package_extensions/{package_extension_guid} Delete a package extension. GET /v2/runtime_definitions List runtime definitions. POST /v2/runtime_definitions Create a new runtime definition. GET /v2/runtime_definitions/{runtime_definition_guid} Retrieve a runtime definition. PUT /v2/runtime_definitions/{runtime_definition_guid} Update a runtime definition. DELETE /v2/runtime_definitions/{runtime_definition_guid} Delete a runtime definition. POST /v3/search/update_by_query A update operation allowing you to update artifacts based on a simple query. GET /v3/search/sss_heartbeat Test if sss is up. GET /v3/search Execute a query based on the Lucene Syntax POST /v3/search Execute a query and pass in a structured query conforming to the Elasticsearch Domain Specific Language. GET /v3/search/search_facet This API will return all available pre search filters POST /v3/categories Creates a category in the glossary POST /v3/categories/collaborators/bootstrap Start category boostrap process GET /v3/categories/collaborators/bootstrap/status Get status of category bootstrap process GET /v3/categories/collaborators/bootstrap/status/history Get history status of category bootstrap process GET /v3/categories/hierarchy Retrieves category hierarchy paths for given artifact ids of categories POST /v3/categories/hierarchy Retrieves category hierarchy paths for given artifact ids of categories GET /v3/categories/uncategorized Retrieves the special [uncategorized] category DELETE /v3/categories/{category_id} Deletes the category with a given guid GET /v3/categories/{category_id} Retrieves category with given guid PATCH /v3/categories/{category_id} Updates category with given id DELETE /v3/categories/{category_id}/artifacts/{artifact_id} Removes an artifact from its secondary category PUT /v3/categories/{category_id}/artifacts/{artifact_id} Adds an artifact to a category GET /v3/categories/{category_id}/collaborators Retrieves collaborators for given artifact id of a category POST /v3/categories/{category_id}/collaborators Creates single collaborator for given category DELETE /v3/categories/{category_id}/collaborators/{collaborator_id} Deletes single collaborator GET /v3/categories/{category_id}/relationships List the relationships of the given type for the specified category DELETE /v3/categories/{category_id}/relationships/{relationship_id} Remove a relationship from category GET /v3/category_role_statistics Get role usage statistics GET /v3/category_statistics Returns list of categories which has specific role assigned, along with number of assignments for users and groups POST /v3/classifications Creates a classification in the glossary GET /v3/classifications/{artifact_id}/versions Retrieves classification with given guid and status DELETE /v3/classifications/{artifact_id}/versions/{version_id} Deletes a draft or published version of an artifact GET /v3/classifications/{artifact_id}/versions/{version_id} Retrieves classification with given guid PATCH /v3/classifications/{artifact_id}/versions/{version_id} Updates a draft or published artifact GET /v3/classifications/{artifact_id}/versions/{version_id}/relationships List the associations of the given type for the specified classification POST /v3/classifications/{artifact_id}/versions/{version_id}/relationships Create relationships for an artifact in the glossary DELETE /v3/classifications/{artifact_id}/versions/{version_id}/relationships/{relationship_id} Deletes relationships for an artifact in the glossary GET /v3/data_classes Retrieves the data classes matching specified parameters. POST /v3/data_classes Creates a draft data class in the glossary GET /v3/data_classes/{artifact_id}/versions Retrieves data class with given guid and status DELETE /v3/data_classes/{artifact_id}/versions/{version_id} Deletes a draft or published version of an artifact GET /v3/data_classes/{artifact_id}/versions/{version_id} Retrieves data class with given guid PATCH /v3/data_classes/{artifact_id}/versions/{version_id} Updates a draft or published artifact GET /v3/data_classes/{artifact_id}/versions/{version_id}/relationships List the relationships of the given type for the specified data class POST /v3/data_classes/{artifact_id}/versions/{version_id}/relationships Create relationships for an artifact in the glossary DELETE /v3/data_classes/{artifact_id}/versions/{version_id}/relationships/{relationship_id} Deletes relationships for an artifact in the glossary GET /v3/glossary_status/heartbeat Business Glossary Heartbeat POST /v3/glossary_status/tenant_init Tenant init and status GET /v3/glossary_status/tenant_init_status Tenant init and status POST /v3/glossary_terms Creates draft terms in the glossary GET /v3/glossary_terms/{artifact_id}/versions Retrieves versions of a term for the given artifact_id and status DELETE /v3/glossary_terms/{artifact_id}/versions/{version_id} Deletes a draft or published version of an artifact GET /v3/glossary_terms/{artifact_id}/versions/{version_id} Gets the term in the glossary with a given version id PATCH /v3/glossary_terms/{artifact_id}/versions/{version_id} Updates a draft or published artifact GET /v3/glossary_terms/{artifact_id}/versions/{version_id}/relationships List the relationships for the specified term POST /v3/glossary_terms/{artifact_id}/versions/{version_id}/relationships Create relationships for an artifact in the glossary DELETE /v3/glossary_terms/{artifact_id}/versions/{version_id}/relationships/{relationship_id} Deletes relationships for an artifact in the glossary POST /v3/governance_artifact_types/custom_attribute_definitions/export Exports custom attribute definitions to a json file POST /v3/governance_artifact_types/custom_attribute_definitions/import Import values for custom attribute definitions from specified json file GET /v3/governance_artifact_types/export Export values of all supported types to a ZIP file POST /v3/governance_artifact_types/import Import values from specified ZIP file POST /v3/governance_artifact_types/import/cleanup/{process_id} Cleanup ZIP import process GET /v3/governance_artifact_types/import/status/{process_id} Import of assets status GET /v3/governance_artifact_types/{artifact_type} Get artifacts of given type that are either published or drafts matching specified criteria GET /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions Retrieves custom attribute definitions with given artifact type POST /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions Creates custom attribute definition in the glossary DELETE /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id} Deletes the custom attribute definition with a given artifact_id GET /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id} Retrieves custom attribute definition with given artifact_id PATCH /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id} Updates custom attribute definition with given artifact_id POST /v3/governance_artifact_types/{artifact_type}/delete Delete a list of draft or published versions of given artifact_type GET /v3/governance_artifact_types/{artifact_type}/export Exports values of a specified type to a csv file POST /v3/governance_artifact_types/{artifact_type}/import Import values from specified csv file POST /v3/governance_artifact_types/{artifact_type}/search Search for a list of drafts of given artifact_type GET /v3/governance_artifact_types/{artifact_type}/{artifact_id} Get the latest published version of the specified artifact POST /v3/governance_artifact_types/{artifact_type}/{artifact_id}/move Changes the parent category of a published artifact with given id GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/aggregated_logs Get development logs & Comments for a draft artifact version GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/aggregated_logs/{mod_id} Get development logs & Comments for a draft artifact version with development log id POST /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments Add a comment for a draft artifact version DELETE /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments/{comment_id} Delete a comment on a draft artifact version PATCH /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments/{comment_id} Update a comment on a draft artifact version GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/logs Get development logs & Comments for a draft artifact version POST /v3/policies Creates a policy in the glossary GET /v3/policies/{artifact_id}/versions Retrieves versions of a policy for the given artifact_id and status DELETE /v3/policies/{artifact_id}/versions/{version_id} Deletes a draft or published version of an artifact GET /v3/policies/{artifact_id}/versions/{version_id} Retrieves versions of a policy for the given artifact_id and status PATCH /v3/policies/{artifact_id}/versions/{version_id} Updates policy with given artifact id and version id PATCH /v3/policies/{artifact_id}/versions/{version_id}/data_protection_rules Updates DPR rule relationships of a published policy using its artifact id and version id GET /v3/policies/{artifact_id}/versions/{version_id}/relationships List the relationships for the specified policy POST /v3/policies/{artifact_id}/versions/{version_id}/relationships Create relationships for an artifact in the glossary DELETE /v3/policies/{artifact_id}/versions/{version_id}/relationships/{relationship_id} Deletes a relationship from a draft policy GET /v3/relationships Retrieves relationships for a given artifact type, artifact_id and artifact version_id POST /v3/rules Creates a rule in the glossary GET /v3/rules/{artifact_id}/versions Retrieves rule with given artifact_id and status DELETE /v3/rules/{artifact_id}/versions/{version_id} Deletes a draft or published version of an artifact GET /v3/rules/{artifact_id}/versions/{version_id} Retrieves rule with given guid PATCH /v3/rules/{artifact_id}/versions/{version_id} Updates rule with given id GET /v3/rules/{artifact_id}/versions/{version_id}/relationships List the relationships of the given type for the specified rule POST /v3/rules/{artifact_id}/versions/{version_id}/relationships Create relationships for an artifact in the glossary DELETE /v3/rules/{artifact_id}/versions/{version_id}/relationships/{relationship_id} Deletes a relationship of a rule artifact POST /v4/reference_data_sets Create a reference data set GET /v4/reference_data_sets/{artifact_id}/versions Retrieve a reference data set with given artifact_id and status DELETE /v4/reference_data_sets/{artifact_id}/versions/{version_id} Delete a reference data set with given artifact_id and version_id GET /v4/reference_data_sets/{artifact_id}/versions/{version_id} Retrieve a reference data set with given artifact_id and version_id PATCH /v4/reference_data_sets/{artifact_id}/versions/{version_id} Update a reference data set with given artifact id and version id POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/custom_columns Create Custom Column definitions DELETE /v4/reference_data_sets/{artifact_id}/versions/{version_id}/custom_columns/{column_id} Delete a Custom Column definition by column_id GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/custom_columns/{column_id} Retrieve a Custom Column definition with given column_id PATCH /v4/reference_data_sets/{artifact_id}/versions/{version_id}/custom_columns/{column_id} Update Custom Column properties with given column_id GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships List the relationships of the given type for the specified reference data set POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships Associate Reference data set identified by artifact_id and version_id with other governance artifacts DELETE /v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships/{relationship_id} Delete the relationship associated to reference data set with specified artifact_id and version_id POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports Import reference data values from csv file to the reference data set with specified artifact_id and version_id DELETE /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports/{import_id} Request cancellation of a ongoing reference data values import process with specified import_id GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports/{import_id} Get current state of reference data values import process with specified import_id POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_relationships Creates relationships for reference data values GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_relationships/{rdv_artifact_id} Retrieve a reference data value relationships with given reference data set artifact_id and version_id and reference data value artifact_id POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_search Search for reference data value(s) details with given RDS artifact_id and version_id using specific code or text value filter GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids PATCH /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values Remove or update reference data values for the specified reference data set POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values Add reference data value to the specified reference data set PUT /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values Add or update reference data values for the specified reference data set GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/export Exports values of a specified reference data set with specified artifact_id and version_id to a csv file DELETE /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id} Delete the reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id} Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids PATCH /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id} Update reference data value in the specified reference data set POST /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id}/value_relationships Creates relationships for reference data value DELETE /v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id}/value_relationships/{relationship_id} Delete the relationship associated to reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id GET /v2/jobs Get list of jobs under a project or a space. POST /v2/jobs Create a new job. GET /v2/jobs/{job_id} Get the information of job identified by the ID. DELETE /v2/jobs/{job_id} Delete a specific job. PATCH /v2/jobs/{job_id} Update information of a job. GET /v2/jobs/serving_name/{serving_name} Get the availability of a given serving_name GET /v2/jobs/{job_id}/runs Get list of runs of a job. POST /v2/jobs/{job_id}/runs Start a run for a job. GET /v2/jobs/{job_id}/runs/{run_id} Get a specific run of a job. DELETE /v2/jobs/{job_id}/runs/{run_id} Delete a run. GET /v2/jobs/{job_id}/runs/{run_id}/logs Retrieve runtime log of a run. POST /v2/jobs/{job_id}/runs/{run_id}/cancel Cancel a run. POST /v2/jobs/{job_id}/runs/{run_id}/pause Pause a run. POST /v2/jobs/{job_id}/runs/{run_id}/resume Resume a run. GET /v1/knowledge_accelerators/asset_assign_terms/status/{process_id} Gets the status of assigning terms to the asset POST /v1/knowledge_accelerators/asset_assign_terms Assigns terms to the asset using the specified strategy, for example industrymodels_ldm POST /v1/knowledge_accelerators/{ka_id}/copy_items Copy Knowledge Accelerator items into project GET /v1/knowledge_accelerators/{id} Get a specific Knowledge Accelerator POST /v1/knowledge_accelerators/{ka_id}/import_items Import specified Knowledge Accelerator items into the glossary GET /v1/knowledge_accelerators/import_items Get what Knowledge Accelerator items are currently imported into glossary GET /v1/knowledge_accelerators Get all Knowledge Accelerators GET /v3/enforcement/governance_types list all governance types GET /v3/enforcement/governance_types/{governance_type_name} retrieve a governanceType GET /v3/enforcement/lhs/udp list user defined rule predicate terms POST /v3/enforcement/lhs/udp create user defined left hand side term GET /v3/enforcement/lhs/udp/{lhsTermId} get a user defined left hand side term DELETE /v3/enforcement/lhs/udp/{lhsTermId} delete a user defined left hand side term GET /v3/enforcement/policy_metrics/analysis/3d retrieve and aggregate policy related metrics GET /v3/enforcement/policy_metrics retrieve and aggregate policy related metrics GET /v3/enforcement/roles list all roles in policy engine. POST /v3/enforcement/roles create a custom role GET /v3/enforcement/roles/{role_id} retrieve a role PUT /v3/enforcement/roles/{role_id} update a custom category role DELETE /v3/enforcement/roles/{role_id} delete a custom category role GET /v3/enforcement/roles/permissions list all permissions in policy engine. PUT /v3/enforcement/rules/sync/{rule_id} Sync a rule GET /v3/enforcement/rules/{rule_id} retrieve a rule PUT /v3/enforcement/rules/{rule_id} update a rule DELETE /v3/enforcement/rules/{rule_id} delete a rule GET /v3/enforcement/rules list all rules POST /v3/enforcement/rules create a rule GET /v3/enforcement/rules/export export all rules GET /v3/enforcement/rules/{rule_id}/terms retrieve terms used in a rule POST /v3/enforcement/rules/import import rules GET /v3/enforcement/settings retrieve tenant settings PUT /v3/enforcement/settings update tenant settings GET /v2/projects List projects GET /v2/projects/total Get project total GET /v2/projects/{project_id} Get project PATCH /v2/projects/{project_id} Update project GET /v2/projects/{project_id}/members List members POST /v2/projects/{project_id}/members Create members DELETE /v2/projects/{project_id}/members Delete members PATCH /v2/projects/{project_id}/members Update members GET /v2/projects/{project_id}/members/{user_name} Get member DELETE /v2/projects/{project_id}/members/{user_name} Delete member GET /v2/projects/{project_id}/tags List tags POST /v2/projects/{project_id}/tags Create tags DELETE /v2/projects/{project_id}/tags Delete tags PATCH /v2/projects/{project_id}/tags Update tags POST /v2/projects/{project_id}/tags/{tag_name} Create tag DELETE /v2/projects/{project_id}/tags/{tag_name} Delete tag GET /v2/projects/{project_id}/settings/folders Get folders settings PUT /v2/projects/{project_id}/settings/folders Update folders settings POST /transactional/v2/projects Create project as a transaction DELETE /transactional/v2/projects/{project_id} Delete project as a transaction GET /transactional/v2/projects/{project_id}/transactions/{transaction_id} Get status of import transaction GET /v3/workflows Get all available workflows POST /v3/workflows/all/query Query available workflows GET /v3/workflows/{workflow_id} Get a workflow by id GET /v3/workflows/{workflow_id}/artifacts Get artifacts managed by the workflow POST /v3/workflow_user_tasks/{task_id}/actions Update a task POST /v3/workflow_user_tasks/unclaim Unclaim tasks POST /v3/workflow_user_tasks/candidates Add candidate users to tasks POST /v3/workflow_user_tasks/actions Update multiple tasks GET /v3/workflow_user_tasks Get all user tasks that involve the current user GET /v3/workflow_user_tasks/{task_id} Get a user task by id GET /v3/workflow_templates/all/task_categories_by_type Get all possible task categories grouped by workflow type GET /v3/workflow_templates/all/task_categories Get all possible task categories GET /v3/workflow_stats/user_task_status Get the current user task status (summary by state)