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
| Method | Path | Summary |
|---|---|---|
| Archive the asset container | ||
| Get archive information of the asset container | ||
| Get configurations | ||
| Replace or create configurations | ||
| Restore the asset container | ||
| List all asset lists defined for an account | ||
| Create a new asset list | ||
| Delete asset lists | ||
| Retrieve an asset list identified by ID | ||
| Delete an asset list identified by ID | ||
| Update the metadata of an asset list | ||
| List the items of an asset list identified by ID | ||
| Retrieve an item in an asset list | ||
| Update an asset list item | ||
| Searches for relationship types | ||
| Creates an asset relationship type | ||
| Searches for relationship type ends | ||
| Finds relationship types that are used by an asset, column or governance artifact | ||
| deleteRelationshipType | ||
| Patches a relationship type | ||
| List all asset types defined for an account, catalog, project or space. | ||
| Creates an asset type in an account, catalog, project or space. | ||
| Retrieves an asset type of a given name. | ||
| Replace an asset type | ||
| Deletes an asset type | ||
| Finds relationship types for an asset type | ||
| Search for asset metadata within assets of the specified type | ||
| Get the status of an account scope or global scope asset type. | ||
| Create an asset | ||
| Get one or more assets. | ||
| Marks existing assets for delete | ||
| Get assets membership for a specific user | ||
| Copies one or more assets and, if deep copy option is on, their related assets from a source container to a target container. | ||
| Create one or more assets. | ||
| Patch one or more assets. | ||
| Gets the status of asset copy operation | ||
| Create a PUT signed url for an object or a file | ||
| Gets the status of a deep copy operation | ||
| Bulk search duplicate assets | ||
| Search duplicate assets | ||
| Get an ibm_data_source asset | ||
| Publish an asset from a project which is only referenced in that project | ||
| Get an asset | ||
| Marks an existing asset for delete | ||
| Update an asset | ||
| Clone an asset | ||
| Add/Update asset collaborators | ||
| Deep copies an asset and its related assets to a catalog, project, or space | ||
| Update the owner of an asset | ||
| Update privacy settings of an asset | ||
| Promote an asset | ||
| Publish an asset | ||
| Finds related assets | ||
| Searches for relationships | ||
| Create asset relationships | ||
| Deletes asset relationships | ||
| Finds relationship types used by an asset | ||
| Finds related assets | ||
| Create asset relationships | ||
| Deletes asset relationships | ||
| Determine if a relationship exists between an asset and a target artifact | ||
| Create an attachment | ||
| Get an attachment | ||
| Delete an attachment | ||
| Update attachment metadata | ||
| Mark an attachment as transfer complete | ||
| Auto update attachment's datasource_type from connection asset | ||
| Get resources info for an attachment | ||
| Increase resources for an attachment | ||
| List all attributes | ||
| Create an attribute | ||
| Get an attribute | ||
| Delete an attribute | ||
| Update attributes | ||
| Get asset document conflicts | ||
| Delete asset document conflicts | ||
| Get the image of asset | ||
| Upload an image for asset | ||
| Delete the image of asset | ||
| Get asset or column notes | ||
| Create notes on an asset | ||
| Get an asset or column note | ||
| Delete an asset or a column note | ||
| Update an asset or column note | ||
| Get ratings of an asset | ||
| Rate an asset | ||
| Get the count of each rating value for the specified asset | ||
| Delete an asset rating | ||
| Use this API to update an asset rating. | ||
| Get a list of revisions for an asset | ||
| Commit a revision of an asset | ||
| Delete a revision | ||
| Find and repair stuck temporary design documents by creating cache entries that resume their processing | ||
| Gets the status of a temporary design document repair operation | ||
| Reconfigure the asset container | ||
| invalidateRoleCacheEntry | ||
| Add a task result to the task | ||
| Add a task result to the task | ||
| Get metrics of the asset lists | ||
| Get metrics of the users who accessed the catalogs | ||
| List all catalogs for a specific account | ||
| Create a catalog | ||
| Retrieve the default catalog | ||
| Create the default catalog | ||
| Rehome one or more synced assets. | ||
| Monitor status of rehome task | ||
| Get a catalog by catalog ID | ||
| Delete a catalog by catalog ID | ||
| Update catalog | ||
| List all properties of a catalog | ||
| Update catalog properties | ||
| Get a single property in a catalog | ||
| Update catalog connections | ||
| Get the catalog state | ||
| Export as a zip file containing appropriate csv files for the selected assets | ||
| Process an import asset | ||
| Request temporary security credentials | ||
| Get a catalog-level collection by collection ID | ||
| Update a catalog-level collection for a catalog | ||
| Delete a catalog-level collection by collection id | ||
| List all members of the catalog | ||
| Add members to a catalog | ||
| Delete members from a catalog | ||
| Get catalog membership for a specific user | ||
| Delete a member from a catalog | ||
| Update members in a catalog | ||
| Create a data asset | ||
| Get a data asset | ||
| Get columns of a data asset | ||
| Create a folder asset | ||
| Get a folder asset | ||
| Get a signed URL of an item to be downloaded | ||
| List all assets in the trash (Marked for delete) | ||
| Get count of all assets in the trash (Marked for delete) | ||
| Delete all assets from trash | ||
| Get a soft-deleted object from trash | ||
| Delete an asset from the trash | ||
| Restore an asset from the trash | ||
| List defined connections | ||
| Define connection | ||
| Get connection | ||
| Delete connection | ||
| Update connection | ||
| Copy connection | ||
| Discover assets | ||
| Discover assets | ||
| Discover data asset | ||
| List actions | ||
| Perform action | ||
| Download a file | ||
| Upload a file | ||
| Delete a file | ||
| List files | ||
| Migrate files | ||
| List defined types of data sources | ||
| Define data source type | ||
| Get details for type of data source | ||
| Delete data source type | ||
| Update datasource type | ||
| Create a metadata enrichment area asset | ||
| Retrieve metadata enrichment settings | ||
| Create or update metadata enrichment settings | ||
| Retrieve details of a Metadata Enrichment Area asset | ||
| Delete a metadata enrichment asset | ||
| edit a metadata enrichment area asset | ||
| Add or remove assets from data scope | ||
| Assign business terms to data assets | ||
| Assign business terms to columns of data assets | ||
| Assign or remove a data class to columns of data assets | ||
| Remove business terms from columns of data assets. | ||
| Adds or updates the review timestamp for given columns. | ||
| Removes review timestamp for given columns. | ||
| Enrich selected data assets | ||
| Remove business terms from data assets | ||
| Review a given list of data assets. | ||
| Removes review timestamp from the given assets | ||
| Publish all assets or a subset of assets of a Metadata Enrichment Area to a catalog | ||
| Create a Metadata Import asset | ||
| Bulk delete data assets in Metadata discovery | ||
| Bulk delete metadata import assets in Metadata discovery | ||
| Bulk publish data assets in Metadata discovery | ||
| Get a list of supported datasource types | ||
| Reconcile the status of the job run record w.r.t the Discovery status | ||
| Restart the pending a job run | ||
| Validate the attempt to delete job associated with Metadata import asset | ||
| Validates a SAP Business Metadata connection | ||
| Retrieve details of a Metadata Import | ||
| delete a metadata import asset | ||
| edit a metadata import asset | ||
| Start a Metadata Import job | ||
| cancel a Metadata Import run | ||
| List data profiles | ||
| Create data profile | ||
| Get data profile | ||
| Delete data profile | ||
| Update data profile | ||
| Update data profiles | ||
| Stop profiling process | ||
| Get profiling logs | ||
| Get the list of data quality dimensions available. | ||
| Modify asset level classification | ||
| Export data profile | ||
| Import data profile | ||
| This filters rows from the frequency distribution. | ||
| Get data profile options | ||
| Create data profile options | ||
| Delete data profile options | ||
| Update the data profile options. | ||
| Persist profiling results | ||
| Update data profile results status | ||
| Get bivariate results of given asset. | ||
| Persist bivariate results of given asset. | ||
| Migrate data profile quality results to new Data Quality service | ||
| List Hummingbird tasks | ||
| Create a Hummingbird task | ||
| Stop Hummingbird tasks | ||
| Delete Hummingbird tasks | ||
| Get HB task | ||
| Delete Hummingbird task | ||
| Start Hummingbird task | ||
| Stop Hummingbird task | ||
| Get Hummingbird task logs | ||
| Get service information | ||
| List all data quality rules or a subset of them | ||
| Create data quality rule | ||
| Delete data quality rules | ||
| Validate data quality rule | ||
| Get data quality rule | ||
| Delete data quality rule | ||
| Update data quality rule | ||
| Run data quality rule | ||
| Get data quality rule from catalog | ||
| List history of all data quality rule run results or a subset of them | ||
| Get the data quality rule run | ||
| List all data quality definitions or a subset of them | ||
| Create data quality definition | ||
| Delete data quality definitions | ||
| Validate data quality definition expression | ||
| Get data quality definition | ||
| Replace data quality definition | ||
| Delete data quality definition | ||
| Update data quality definition | ||
| Get data quality definition from catalog | ||
| Update data quality definition in catlog | ||
| List all data quality dimensions | ||
| Get project settings for data quality rules | ||
| Replace project settings for data quality rules | ||
| Get data quality assets | ||
| Create Data quality assets | ||
| Get a data quality asset | ||
| Delete data quality asset | ||
| Update or patch a data quality asset | ||
| Search data quality asset with given native id and type | ||
| Get data quality checks | ||
| Create data quality checks | ||
| Get a data quality check | ||
| Delete a data quality check | ||
| Update or patch a data quality check | ||
| Search for a data quality check by its native id and type | ||
| Get a list of data quality dimensions | ||
| Create a data quality dimension | ||
| Get the data quality dimension with the given identifier | ||
| Delete the data quality dimension with the given identifier. | ||
| Update a data quality dimension as specified in the payload details of the request | ||
| Search for data quality dimensions by name or part of their names | ||
| Get a list of data quality issues | ||
| Create a data quality issue | ||
| Get the data quality issue with the given identifier | ||
| Update a data quality issue as specified in the payload details of the request. | ||
| Search for a data quality issue by its native id | ||
| Create several data quality issues. The related DQ assets referenced by their native ID are created if they do not already exist | ||
| Get a list of data quality scores for a given asset | ||
| Get a list of data quality scores for a given assets | ||
| List environments. | ||
| Create a new environment. | ||
| Retrieve an environment. | ||
| Delete an environment. | ||
| Update an environment. | ||
| List hardware specifications. | ||
| Create a new hardware specification. | ||
| Retrieve a hardware specification. | ||
| Delete a hardware specification. | ||
| Update a hardware specification. | ||
| List software specifications. | ||
| Create a new software specification. | ||
| Update a software specification. | ||
| Retrieve a software specification. | ||
| Delete a software specification. | ||
| Add a package extension to a software specification. | ||
| Remove a package extension from a software specification. | ||
| List package extensions. | ||
| Create a new package extension. | ||
| Mark file upload complete. | ||
| Update a package extension. | ||
| Retrieve a package extension. | ||
| Delete a package extension. | ||
| A update operation allowing you to update artifacts based on a simple query. | ||
| Test if sss is up. | ||
| Execute a query based on the Lucene Syntax | ||
| Execute a query and pass in a structured query conforming to the Elasticsearch Domain Specific Language. | ||
| This API will return all available pre search filters | ||
| Creates a category in the glossary | ||
| Start category boostrap process | ||
| Get status of category bootstrap process | ||
| Get history status of category bootstrap process | ||
| Retrieves category hierarchy paths for given artifact ids of categories | ||
| Retrieves category hierarchy paths for given artifact ids of categories | ||
| Retrieves the special [uncategorized] category | ||
| Deletes the category with a given guid | ||
| Retrieves category with given guid | ||
| Updates category with given id | ||
| Removes an artifact from its secondary category | ||
| Adds an artifact to a category | ||
| Retrieves collaborators for given artifact id of a category | ||
| Creates single collaborator for given category | ||
| Deletes single collaborator | ||
| List the relationships of the given type for the specified category | ||
| Remove a relationship from category | ||
| Get role usage statistics | ||
| Returns list of categories which has specific role assigned, along with number of assignments for users and groups | ||
| Creates a classification in the glossary | ||
| Retrieves classification with given guid and status | ||
| Deletes a draft or published version of an artifact | ||
| Retrieves classification with given guid | ||
| Updates a draft or published artifact | ||
| List the associations of the given type for the specified classification | ||
| Create relationships for an artifact in the glossary | ||
| Deletes relationships for an artifact in the glossary | ||
| Retrieves the data classes matching specified parameters. | ||
| Creates a draft data class in the glossary | ||
| Retrieves data class with given guid and status | ||
| Deletes a draft or published version of an artifact | ||
| Retrieves data class with given guid | ||
| Updates a draft or published artifact | ||
| List the relationships of the given type for the specified data class | ||
| Create relationships for an artifact in the glossary | ||
| Deletes relationships for an artifact in the glossary | ||
| Business Glossary Heartbeat | ||
| Tenant init and status | ||
| Tenant init and status | ||
| Creates draft terms in the glossary | ||
| Retrieves versions of a term for the given artifact_id and status | ||
| Deletes a draft or published version of an artifact | ||
| Gets the term in the glossary with a given version id | ||
| Updates a draft or published artifact | ||
| List the relationships for the specified term | ||
| Create relationships for an artifact in the glossary | ||
| Deletes relationships for an artifact in the glossary | ||
| Exports custom attribute definitions to a json file | ||
| Import values for custom attribute definitions from specified json file | ||
| Export values of all supported types to a ZIP file | ||
| Import values from specified ZIP file | ||
| Cleanup ZIP import process | ||
| Import of assets status | ||
| Get artifacts of given type that are either published or drafts matching specified criteria | ||
| Retrieves custom attribute definitions with given artifact type | ||
| Creates custom attribute definition in the glossary | ||
| Deletes the custom attribute definition with a given artifact_id | ||
| Retrieves custom attribute definition with given artifact_id | ||
| Updates custom attribute definition with given artifact_id | ||
| Delete a list of draft or published versions of given artifact_type | ||
| Exports values of a specified type to a csv file | ||
| Import values from specified csv file | ||
| Search for a list of drafts of given artifact_type | ||
| Get the latest published version of the specified artifact | ||
| Changes the parent category of a published artifact with given id | ||
| Get development logs & Comments for a draft artifact version | ||
| Get development logs & Comments for a draft artifact version with development log id | ||
| Add a comment for a draft artifact version | ||
| Delete a comment on a draft artifact version | ||
| Update a comment on a draft artifact version | ||
| Get development logs & Comments for a draft artifact version | ||
| Creates a policy in the glossary | ||
| Retrieves versions of a policy for the given artifact_id and status | ||
| Deletes a draft or published version of an artifact | ||
| Retrieves versions of a policy for the given artifact_id and status | ||
| Updates policy with given artifact id and version id | ||
| Updates DPR rule relationships of a published policy using its artifact id and version id | ||
| List the relationships for the specified policy | ||
| Create relationships for an artifact in the glossary | ||
| Deletes a relationship from a draft policy | ||
| Retrieves relationships for a given artifact type, artifact_id and artifact version_id | ||
| Creates a rule in the glossary | ||
| Retrieves rule with given artifact_id and status | ||
| Deletes a draft or published version of an artifact | ||
| Retrieves rule with given guid | ||
| Updates rule with given id | ||
| List the relationships of the given type for the specified rule | ||
| Create relationships for an artifact in the glossary | ||
| Deletes a relationship of a rule artifact | ||
| Create a reference data set | ||
| Retrieve a reference data set with given artifact_id and status | ||
| Delete a reference data set with given artifact_id and version_id | ||
| Retrieve a reference data set with given artifact_id and version_id | ||
| Update a reference data set with given artifact id and version id | ||
| Create Custom Column definitions | ||
| Delete a Custom Column definition by column_id | ||
| Retrieve a Custom Column definition with given column_id | ||
| Update Custom Column properties with given column_id | ||
| List the relationships of the given type for the specified reference data set | ||
| Associate Reference data set identified by artifact_id and version_id with other governance artifacts | ||
| Delete the relationship associated to reference data set with specified artifact_id and version_id | ||
| Import reference data values from csv file to the reference data set with specified artifact_id and version_id | ||
| Request cancellation of a ongoing reference data values import process with specified import_id | ||
| Get current state of reference data values import process with specified import_id | ||
| Creates relationships for reference data values | ||
| Retrieve a reference data value relationships with given reference data set artifact_id and version_id and reference data value artifact_id | ||
| Search for reference data value(s) details with given RDS artifact_id and version_id using specific code or text value filter | ||
| Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids | ||
| Remove or update reference data values for the specified reference data set | ||
| Add reference data value to the specified reference data set | ||
| Add or update reference data values for the specified reference data set | ||
| Exports values of a specified reference data set with specified artifact_id and version_id to a csv file | ||
| Delete the reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id | ||
| Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids | ||
| Update reference data value in the specified reference data set | ||
| Creates relationships for reference data value | ||
| 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 list of jobs under a project or a space. | ||
| Create a new job. | ||
| Get the information of job identified by the ID. | ||
| Delete a specific job. | ||
| Update information of a job. | ||
| Get the availability of a given serving_name | ||
| Get list of runs of a job. | ||
| Start a run for a job. | ||
| Get a specific run of a job. | ||
| Delete a run. | ||
| Retrieve runtime log of a run. | ||
| Cancel a run. | ||
| Pause a run. | ||
| Resume a run. | ||
| Copy Knowledge Accelerator items into project | ||
| Get a specific Knowledge Accelerator | ||
| Import specified Knowledge Accelerator items into the glossary | ||
| Get what Knowledge Accelerator items are currently imported into glossary | ||
| Get all Knowledge Accelerators | ||
| Get asset lineage | ||
| Get asset lineage summary | ||
| Returns the event identified by event_id. | ||
| Publishes lineage event. | ||
| Get summary statistics of activities on a project/catalog/space asset | ||
| Create a new notebook. | ||
| Retrieve the details of a large number of notebooks inside a project. | ||
| Delete a particular notebook, including the notebook asset. | ||
| Revert the main notebook to a version. | ||
| Update a particular notebook. | ||
| Create a new version. | ||
| List the versions of a notebook. | ||
| Retrieve a notebook version. | ||
| Delete a notebook version. | ||
| list all governance types | ||
| retrieve a governanceType | ||
| list user defined rule predicate terms | ||
| create user defined left hand side term | ||
| get a user defined left hand side term | ||
| delete a user defined left hand side term | ||
| retrieve and aggregate policy related metrics | ||
| retrieve and aggregate policy related metrics | ||
| list all roles in policy engine. | ||
| create a custom role | ||
| retrieve a role | ||
| update a custom category role | ||
| delete a custom category role | ||
| list all permissions in policy engine. | ||
| Sync a rule | ||
| retrieve a rule | ||
| update a rule | ||
| delete a rule | ||
| list all rules | ||
| create a rule | ||
| export all rules | ||
| retrieve terms used in a rule | ||
| import rules | ||
| retrieve tenant settings | ||
| update tenant settings | ||
| List projects | ||
| Get project total | ||
| Get project | ||
| Update project | ||
| List members | ||
| Create members | ||
| Delete members | ||
| Update members | ||
| Get member | ||
| Delete member | ||
| List tags | ||
| Create tags | ||
| Delete tags | ||
| Update tags | ||
| Create tag | ||
| Delete tag | ||
| Get folders settings | ||
| Update folders settings | ||
| Create a new space | ||
| Retrieve the spaces | ||
| Retrieve the space | ||
| Delete the space | ||
| Update the space | ||
| Retrieve the space members | ||
| Add a member to space | ||
| Retrieve the space member information | ||
| Remove the space member | ||
| Update the space member | ||
| Retrieve the asset exports | ||
| Start the asset export process | ||
| Cancel the asset export process | ||
| Retrieve the asset export | ||
| Download the asset export content | ||
| Retrieve the asset imports | ||
| Start the asset import process | ||
| Cancel the asset import process | ||
| Retrieve the asset import | ||
| Create project as a transaction | ||
| Delete project as a transaction | ||
| Get status of import transaction |