Introduction to IBM Knowledge Catalog as a Service You can use the IBM Knowledge Catalog as a Service APIs to establish business vocabulary, import and enrich data assets, analyze data quality, define
| Method | Path | Summary |
|---|---|---|
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| Get a list of data quality scores for a given asset | ||
| Validate data contract against ODCS schema | ||
| List data contracts in the project | ||
| Create data contract | ||
| Delete data contracts | ||
| Upload data contract file | ||
| List data contracts in the catalog | ||
| Create data contract in catalog | ||
| Delete data contracts from catalog | ||
| Upload data contract file to catalog | ||
| Validate data contract content for catalog | ||
| Get data contract from catalog | ||
| Replace data contract in catalog | ||
| Get data contract | ||
| Update data contract | ||
| 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 | ||
| 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 Registration with synchronization status for reporting service | ||
| Register for reporting service | ||
| Delete Registration for reporting service (if synchronization not started) | ||
| Update Registration for reporting service | ||
| Start synchronization of IKC data into reporting database | ||
| Pause synchronization of IKC data into reporting database | ||
| Resume synchronization of IKC data into reporting database | ||
| Stop synchronization of IKC data into reporting database | ||
| Reset Registration for reporting service (Stop Sync and Delete Registration) | ||
| Get list of sample queries | ||
| 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 | ||
| Create a metadata enrichment area asset | ||
| Create or update metadata enrichment settings | ||
| Retrieve metadata enrichment settings | ||
| edit a metadata enrichment area asset | ||
| Retrieve details of a Metadata Enrichment Area asset | ||
| Delete a metadata enrichment 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 | ||
| Create a job to publish the data assets and configure the list of data assets to be included in the job. | ||
| Get a list of supported datasource types | ||
| Restart the pending a job run | ||
| edit a metadata import asset | ||
| Retrieve details of a Metadata Import | ||
| delete a metadata import asset | ||
| 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 |