Introduction to IBM Knowledge Catalog as a Service
Note: this documentation page is under construction. Refer to Watson Data API documentation page for full description of APIs provided by IBM Knowledge Catalog.
You can use the IBM Knowledge Catalog as a Service APIs to establish business vocabulary, import and enrich data assets, analyze data quality, define data protection rules, and more.
IBM Knowledge Catalog as a Service builds on top of the common core functionality for Data and AI SaaS products. The common core functionality provides fundamental features, such as managing catalogs, projects, assets and connections. You can view common core functionality APIs here.
If you are looking for the IBM Knowledge Catalog software APIs, see here.
For more information, see these resources:
Authentication
Before you can call a common core API you must first create an IAM 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:
- Log in to IBM Cloud and select Manage > Access (IAM) > API keys.
- 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.
- With your API key, set up a REST API tool and run the following command to the right
You can read more about managing API keys at Understanding API keys documentation page.
- Use the value of the
access_tokenproperty for your API calls. Set theaccess_tokenvalue as the authorization header parameter for requests to the APIs. The format isAuthorization: Bearer <access_token_value_here>. For example:Authorization: Bearer eyJhbGciOiJIUz......sgrKIi8hdFs
To create a token by using the IBM Cloud CLI:
- Follow the steps to install the CLI, log in to IBM Cloud, and get the token
described in Getting an IAM API token programmatically.
Remove
Bearerfrom the returned IAM token value in your API calls.
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 'grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=MY_APIKEY'
Response
{
"access_token": "eyJhbGciOiJIUz......sgrKIi8hdFs",
"refresh_token": "SPrXw5tBE3......KBQ+luWQVY=",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1473188353
}
Error handling
Responses with 400-series or 500-series status codes are returned when a request cannot be completed. The body of these responses follows the error model, which contains a code field to identify the problem and a message field to explain how to solve the problem. Each individual endpoint has specific error messages. All responses with 500 or 503 status codes are logged and treated as a critical failure that requires an emergency fix.
Rate Limiting
The following rate limiting headers are supported by some of the common core service APIs:
- X-RateLimit-Limit: If rate limiting is active, this header indicates the number of requests permitted per hour;
- X-RateLimit-Remaining: If rate limiting is active, this header indicates the number of requests remaining in the current rate limit window;
- X-RateLimit-Reset: If rate limiting is active, this header indicates the time at which the current rate limit window resets, as a UNIX timestamp.
Methods
List data profiles
Status: Complete
Get the list of data profiles in the specified project or catalog for a given dataAsset, provided the caller has the necessary rights to do so. The returned results can be filtered by using one or more of the listed parameters.
| Field | Match type | Example | | --------------- | ------------ | ------------------------------ | | dataset_id | Equals | ?dataset_id=5210c7d-cf6b |
GET /v2/data_profiles
Request
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to include the entity component. If set to false, only the metadata component is populated in the response.
Default:
trueInclude minimum payload for profiling results. If set to true, only minimum required details for DPS are available in the response.
Default:
falseReturn the analysis results for specified column. This option will be ignored for data profile run using data flow.
Create data profile
Status: Complete
Creates a data profile for a given data set in the specified project or catalog, provided the caller has the necessary rights to do so. Subsequent calls to use the data profile must specify the relevant project or catalog ID that the data profile was created in.
The request payload must include the 'metadata' section containing the data set id and catalog/project id.
The request payload can have the 'entity' section which is optional specifying the data profile options. If these options are not specified, default options are taken. To create several data profiles at once in the specified project or catalog, specify an array of data set in the attribute dataset_ids instead of a single data set in the attribute dataset_id. In this case, the data profiles are created in a single job that can be found in the execution section of the returned data profile entity.
AMQP 1.0 Messages
When a new data profile is created, a message is fired with a state of the new data profile in the body.
Topic
v2.data_profiles.:guid.POST ,where the ":guid" represents the profile_id of the created Data Profile
Subscribe to it by using "v2.data_profiles.*.POST" Binding Key.
Example Message
Topic: v2.data_profiles.5210c7d-cf6b-4204-95d2-95d84ecbe382.POST
Message:
{
"event": "CREATE_DATA_PROFILE",
"actor": {
"user_name": "john@acme.com"
},
"published": "2015-05-10T15:04:15Z",
"url": { /* The href of the DataProfile created */}
"status_code": { /* The Http Status code , 201 if the DataProfile is created successfully */}
"state": { /* the data profile object equivalent to the one obtained by GET /v2/data_profiles/{profile_id} API */ }
"details": {
"catalog_id": "f3c59258-abdd-4e24-828b-0495ec519339",
"dataset_id": "e522db21-59e8-44ab-81b2-bb40c3030a6f",
"profile_id": "5165d439-96f0-40d4-90b2-93795deab61b",
"is_governed": false { /* set to true if the catalog is_governed else set it to false}
}
}
POST /v2/data_profiles
Request
Query Parameters
Whether to start the profiling service immediately after the data profile is created.
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
falseWhether to charge the bulk profiling to include term assignment charges.
Default:
false
The data profile to create.
Profiling specific metadata
Profiling specific metadata
Information about the number of records
The underlying asset entity.
- entity
The data profile definition.
The data profile definition.
Column metadata inferred by analysis.
The location url where the data profile is created.
Response
A data profile holds the data profiling controls, options and results of a data set.
Profiling specific metadata
Profiling specific metadata
Information about the number of records
The underlying asset entity.
- entity
The data profile definition.
The data profile definition.
Column metadata inferred by analysis.
The location url where the data profile is created.
Status Code
Success.
Accepted.
You are not authorized to create a data profile.
You are not permitted to perform this action.
The data profile cannot be found.
An error occurred. The data profile cannot be created.
No Sample Response
Get data profile
Status: Complete
Gets a data profile from a project or catalog, provided the call has the required right to do so.
GET /v2/data_profiles/{profile_id}Request
Path Parameters
The profile ID to use.
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Include minimum payload for profiling results. If set to true, only minimum required details for DPS are available in the response.
Default:
false
Response
A data profile holds the data profiling controls, options and results of a data set.
Profiling specific metadata
Profiling specific metadata
Information about the number of records
The underlying asset entity.
- entity
The data profile definition.
The data profile definition.
Column metadata inferred by analysis.
The location url where the data profile is created.
Status Code
Success.
You are not authorized to get the data profile you specified.
You are not permitted to perform this action.
The data profile you specified cannot be found.
An error occurred. The data profile you specified cannot be fetched.
No Sample Response
Delete data profile
Status: Complete
Deletes a specified data profile in a project or catalog, provided the caller has the necessary rights to do so.
The data profile is not deleted if the profiling process is still running unless the stop_in_progress_runs parameter is set to true.
DELETE /v2/data_profiles/{profile_id}Request
Path Parameters
The profile ID to use.
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to stop all running profiling processes. Data profiles that are running must be stopped before they can be deleted.
Default:
falseWhether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
Update data profile
Status: Complete
Updates a data profile in the project or catalog specified in the data profile, provided the caller has the necessary rights to do so.
During update, the entire data profile is replaced, apart from any read-only or response-only attributes.
If the profiling processes is running and the start parameter is set to true, then a data profile is only updated if the stop_in_progress_runs parameter is set to true.
The updates must be specified by using the JSON patch format, described in RFC 6902.
AMQP 1.0 Messages
When a data profile is modified, a message is fired with a state of the modified data profile in the body.
Topic
v2.data_profiles.:guid.PATCH
Subscribe to it by using "v2.data_profiles.*.PATCH" Binding Key.
Example Message
Topic: v2.data_profiles.5210c7d-cf6b-4204-95d2-95d84ecbe382.PATCH
Message:
{
"event": "UPDATE_DATA_PROFILE",
"actor": {
"user_name": "john@acme.com",
},
"published": "2015-05-10T15:04:15Z",
"url": { /* The href of the DataProfile created */}
"status_code": { /* The Http Status code , 200 if the DataProfile is updated successfully */}
"state": { /* the data profile object equivalent to the one obtained by GET /v2/data_profiles/{profile_id} API */ }
"details": {
"catalog_id": "f3c59258-abdd-4e24-828b-0495ec519339",
"dataset_id": "e522db21-59e8-44ab-81b2-bb40c3030a6f",
"profile_id": "5165d439-96f0-40d4-90b2-93795deab61b",
"is_governed": false { /* set to true if the catalog is_governed else set it to false}
}
}
PATCH /v2/data_profiles/{profile_id}Request
Path Parameters
The profile ID to use.
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to stop all running profiling processes. Data profiles that are running must be stopped before they can be deleted.
Default:
falseWhether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
falseWhether to start the profiling service immediately after the data profile is updated.
The updates to make in the data profile.
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data profile holds the data profiling controls, options and results of a data set.
Profiling specific metadata
Profiling specific metadata
Information about the number of records
The underlying asset entity.
- entity
The data profile definition.
The data profile definition.
Column metadata inferred by analysis.
The location url where the data profile is created.
Status Code
Success.
You are not authorized to update the data profile you specified.
You are not permitted to perform this action.
The data profile you specified cannot be found.
An error occurred. The data profile you specified cannot be updated.
No Sample Response
Update data profiles
Status: Complete
Updates data profiles in the project or catalog for one or more assets, provided the caller has the necessary rights to do so.
During update, the entire data profiles are replaced, apart from any read-only or response-only attributes.
If any profiling process is running and the start parameter is set to true, then a data profile is only updated if the stop_in_progress_runs parameter is set to true.
The updates must be specified by using the JSON patch format, described in RFC 6902.
AMQP 1.0 Messages
When a data profile is modified, a message is fired with a state of the modified data profile in the body.
Topic
v2.data_profiles.:guid.PATCH
Subscribe to it by using "v2.data_profiles.*.PATCH" Binding Key.
Example Message
Topic: v2.data_profiles.5210c7d-cf6b-4204-95d2-95d84ecbe382.PATCH Message:
{
"event": "UPDATE_DATA_PROFILE",
"actor": {
"user_name": "john@acme.com",
},
"published": "2015-05-10T15:04:15Z",
"url": { /* The href of the DataProfile created */}
"status_code": { /* The Http Status code , 200 if the DataProfile is updated successfully */}
"state": { /* the data profile object equivalent to the one obtained by GET /v2/data_profiles/{profile_id} API */ }
"details": {
"catalog_id": "f3c59258-abdd-4e24-828b-0495ec519339",
"dataset_id": "e522db21-59e8-44ab-81b2-bb40c3030a6f",
"profile_id": "5165d439-96f0-40d4-90b2-93795deab61b",
"is_governed": false { /* set to true if the catalog is_governed else set it to false}
}
}
POST /v2/data_profiles/bulk
Request
Query Parameters
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
The updates to make in the one or more data profiles.
The ID of the profile asset
Contains updates to an object via a PATCH request, as specified by the JSON patch format in RFC 6902
Response
Contains updates to more than one asset via a POST request, as specified by the JSON patch format in RFC 6902
Contains respone details for one asset in a bulk assets update response, as specified by the JSON patch format in RFC 6902
Trace key associated with the current request
Status Code
Success.
You are not authorized to update the data profile you specified.
You are not permitted to perform this action.
The catalog / project you specified cannot be found.
An error occurred. The catalog / project you specified cannot be updated.
No Sample Response
Stop profiling process
Status: Complete
Stops an in-progress profiling run in the specified project or catalog, provided the caller has the necessary rights to do so. This API will request the action to be performed and return, not perform the action and wait for it to complete.
PUT /v2/data_profiles/{profile_id}/executionRequest
Path Parameters
The profile ID to use.
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
The requested action to perform on the profile run.
The requested action (Response only).
Allowable values: [
stop,stop_all]
Get profiling logs
Status: Complete
Get the logs for the data profile job run on data set in a project or catalog.
GET /v2/data_profiles/{profile_id}/logsRequest
Path Parameters
The profile ID to use.
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Response
A collection of data profile job run log entries.
A collection of data profile job run log entries.
Status Code
Success.
You are not authorized to get the profiling logs.
You are not permitted to perform this action.
The data profile you specified cannot be found.
An error occurred. Failed to get profiling logs.
No Sample Response
Modify asset level classification
Status: Complete
Modifies asset level classification detail in the data_profile attribute in the specified project or catalog, provided the caller has the necessary rights to do so. This API is used for CRUD operations on asset level classification.
The patch request for classification should contain the classification details that are to be added to the data_profile attribute.
The updates must be specified by using the JSON patch format, described in RFC 6902.
PATCH /v2/data_profiles/classification
Request
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
The asset level classification details that are added to the data_profile attribute.
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
Custom data to be associated with a given object
Status Code
Success.
Invalid classification details provided as part of the patch call.
You are not authorized to modify the data_profile attribute with asset level classification details.
You are not permitted to perform this action.
The asset classification cannot be found.
An error occurred. The data_profile attribute cannot be modified with asset level classification detail.
No Sample Response
Export data profile
Status: Complete
Export data profile of dataset in a project or catalog. (For internal use only)
GET /v2/data_profiles/export
Request
Query Parameters
The ID of the data set to use.
The ID of the export task ID to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Response
List of file paths that hold the profiling results. These files should be added to the project export archive.
Status Code
Success.
You are not authorized to persist results.
You are not permitted to perform this action.
Asset or profile is missing
An error occurred. The profiling results cannot be saved.
This API is not Implemented.
No Sample Response
Import data profile
Status: Complete
Import data profile of dataset in a project or catalog. (For internal use only)
POST /v2/data_profiles/import
Request
Query Parameters
The ID of the data set to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
The data profile to import.
Source path where the import archive is deflated. If this value is provided, the profiling results are read from source_path/assets/profiling directory by setting the root=true. If this value is not provided, results files are read from profiling directory by setting the root=false.
Map of the old asset ids to new asset ids
- asset_ref_map
IBM cloud IAM user id of the creator of the asset.
Possible values: 1 ≤ length ≤ 100
Example:
IBMid-270002ABCD
This filters rows from the frequency distribution.
This filters rows from the frequency distribution.
POST /v2/data_profiles/{profile_id}/unique_valuesRequest
Path Parameters
The profile ID to use.
filters to get frequency distribution
Example:
dataset_idExample:
col1Example:
project_idExample:
catalog_idDefault:
falseExample:
some_valueExample:
10Example:
AAAExample:
100Possible values: 0 ≤ value ≤ 1000
Example:
100Example:
INT8Example:
10Example:
5Example:
2Example:
AAAExample:
U
Response
list of frequency distribution result of the column
Example:
120frequency distribution result
Status Code
Success.
You are not authorized to get the key analysis you specified.
You are not permitted to perform this action.
The key analysis task you specified cannot be found.
An error occurred. The data profile you specified cannot be fetched.
No Sample Response
Get data profile options
Status: Complete
Get the data profile options for the Account specified in the IAM token. If the account level data profile options is not available check if it is specified at project or catalog account level, provided the caller has the necessary rights to do so.
GET /v2/data_profiles/options
Request
Query Parameters
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
Response
Definition of a data profile options.
Metadata about data profile options
The underlying asset entity.
- entity
The options of the profiling execution.
Status Code
Success.
You are not permitted to perform this action.
You are not authorized to list the available data profiles options.
Not Found.
An error occurred. The data profiles options cannot be listed.
This API is not Implemented.
No Sample Response
Create data profile options
Status: Complete
Creates a data profile options for a given Account Id in the specified project or catalog, provided the caller has the necessary rights to do so.
POST /v2/data_profiles/options
Request
Query Parameters
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
The data profile option to create.
Metadata about data profile options
The underlying asset entity.
- entity
The options of the profiling execution.
Response
Definition of a data profile options.
Metadata about data profile options
The underlying asset entity.
- entity
The options of the profiling execution.
Status Code
Success.
You are not authorized to create data profile options.
You are not permitted to perform this action.
The data profile options cannot be found.
An error occurred. The data profile options cannot be created.
This API is not Implemented.
No Sample Response
Delete data profile options
Status: Complete
Delete the list of data profile options in the specified project or catalog, provided the caller has the necessary rights to do so. If the user specifies the catalog_id or the project_id then the data profile options specified for the catalog or project is deleted. If none of the query parameters,catalog_id or project_id is specified, the default is to delete the account level data profile options.
DELETE /v2/data_profiles/options
Request
Query Parameters
Comma separated list of the BSS Account IDs to use (restriced usage).
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
Update the data profile options.
Status: Complete
Updates the data profile options for a given Account in the specified project or catalog, provided the caller has the necessary rights to do so. The data profile options that can be modified are max_row_count,row_percentage,max_distribution_size,max_numeric_stats_bin disabled flag in classification options,ibm_class_codes and custom_class_codes.
If the user specifies the catalog_id or the project_id then the data profile options specified for the catalog or project is updated. Update the account level data profile options if catalog_id or project_id is not specified.
PATCH /v2/data_profiles/options
Request
Query Parameters
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).
Default:
false
The data profile options to add.
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
Definition of a data profile options.
Metadata about data profile options
The underlying asset entity.
- entity
The options of the profiling execution.
Status Code
Success.
You are not authorized to update the data profile options.
You are not permitted to perform this action.
The data profile options you specified cannot be found.
An error occurred. The data profile options cannot be updated.
This API is not Implemented.
No Sample Response
Persist profiling results
Status: Complete
Persist profiling results of dataset in a project or catalog. (For internal use only)
POST /v2/data_profiles/results
Update data profile results status
Status: Complete
Update data profile result status of dataset in a project or catalog. (For internal use only)
POST /v2/data_profiles/results/status
Request
Query Parameters
The ID of the data set to use.
The tenant ID to use.
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
The ID to be used for tracking end to end flow.
The data profile result status to update.
The data profile status.
Get bivariate results of given asset.
Status: Complete
Get bivariate results of dataset in a project or catalog. (For internal use only)
GET /v2/data_profiles/bivariate_results
Persist bivariate results of given asset.
Status: Complete
Persist bivariate results of dataset in a project or catalog. (For internal use only)
POST /v2/data_profiles/bivariate_results
Migrate data profile quality results to new Data Quality service
Status: Complete
Migrate data profile quality results of dataset in a project or catalog to new Data Quality service.
POST /v2/data_profiles/migrate
Request
Query Parameters
The ID of the catalog to use. catalog_id or project_id is required.
The ID of the project to use. catalog_id or project_id is required.
The ID of the data set to use.(Use comma separated data set Id's for multiple data sets)
Response
Migration status logging to track progress.
Status Code
Successfully initiated migration process.
Bad request. Provided parameters could be invalid.
You are not authorized, either token is expired or invalid.
You are not permitted to perform this action. Only Editor or Admin are allowed.
Catalog or Project not found.
An error occurred. The profiling results cannot be migrated to data quality service.
This API is not Implemented.
No Sample Response
List Hummingbird tasks
Status: Complete
Get the list of Hummingbird tasks for a specified accout or type, provided the caller has the necessary rights to do so.
GET /v1/hb_tasks
Request
Query Parameters
The BSS Account ID to use.
The type of the job.
Fetch complete details of job.
Default:
false
Response
Collection of HB tasks.
The ID of the task
The ID of the account
Indicates if account plan is free plan
Type of the job
The job payload
The id to track complete flow
Priority of the HB job
The ID of the HB job
Timestamp of task creation
Timestamp of job submission
Timestamp of job completion
The duration for which job was run
The number of times the job was retried
Status of the HB job
Possible values: [
REQUESTED,SUBMITTED,RUNNING,COMPLETED,ERROR,STOPPED,STOPPED_CAPACITY_UNIT_EXCEEDED,QUEUED]The ID of the project where the spark job logs need to be saved. If this value is not provided or is invalid then the spark job logs will be stored in default COS bucket.
A RuntimeRegistrationParameters holds details to be sent to runtimes api to report CUH for HB job.
A ComputeUnits holds details to determine if a particular account has surpassed its CUH.
Status Code
Success.
You are not permitted to perform this action.
You are not authorized to list the available Hummingbird tasks.
Not Found.
An error occurred. The HB tasks cannot be listed.
No Sample Response
Request
The Hummingbird task to create.
The ID of the account
Indicates if account plan is free plan
Type of the job
The job payload
The id to track complete flow
Status of the HB job
Allowable values: [
REQUESTED,QUEUED]Default:
REQUESTEDPriority of the HB job
Default:
1The ID of the project where the spark job logs need to be saved. If this value is not provided or is invalid then the spark job logs will be stored in default COS bucket.
A RuntimeRegistrationParameters holds details to be sent to runtimes api to report CUH for HB job.
A ComputeUnits holds details to determine if a particular account has surpassed its CUH.
Response
An HbTaskResponse holds details about Hummingbird job and the status of task in queue.
The ID of the task
The ID of the account
Indicates if account plan is free plan
Type of the job
The job payload
The id to track complete flow
Priority of the HB job
The ID of the HB job
Timestamp of task creation
Timestamp of job submission
Timestamp of job completion
The duration for which job was run
The number of times the job was retried
Status of the HB job
Possible values: [
REQUESTED,SUBMITTED,RUNNING,COMPLETED,ERROR,STOPPED,STOPPED_CAPACITY_UNIT_EXCEEDED,QUEUED]The ID of the project where the spark job logs need to be saved. If this value is not provided or is invalid then the spark job logs will be stored in default COS bucket.
A RuntimeRegistrationParameters holds details to be sent to runtimes api to report CUH for HB job.
A ComputeUnits holds details to determine if a particular account has surpassed its CUH.
Status Code
Success.
You are not authorized to create a Hummingbird task.
You are not permitted to perform this action.
The data profile cannot be found.
An error occurred. The Hummingbird task cannot be created.
No Sample Response
Stop Hummingbird tasks
Status: Complete
Stops given Hummingbird task ids. If the Hummingbird task is already completed or is not found then it will be ignored. If the task is locked by other process then it will be ignored as well.
POST /v1/hb_tasks/stop
Response
A StopHbTasksResponse holds details about stop Hummingbird tasks response.
The array of hb_task_id that were already completed. These Hummingbird tasks will be ignored.
The array of hb_task_id that were not found. These Hummingbird tasks will be ignored.
The array of hb_task_id that were actually stopped
The array of hb_task_id that were locked by other process.
Status Code
Success.
You are not authorized to cancel Hummingbird tasks.
You are not permitted to perform this action.
An error occurred. The Hummingbird tasks cannot be stopped.
No Sample Response
Delete Hummingbird tasks
Status: Complete
Delete given Hummingbird task ids. If a Hummingbird task is not found then it will be ignored. If the Hummingbird task is running and stop_in_progress_job is not true then it will be ignored. If the task is locked by other process then it will be ignored as well.
POST /v1/hb_tasks/delete
Request
Query Parameters
Stop running job.
Default:
false
The Hummingbird task ids to delete.
The array of hb_task_id to use during bulk processing
Response
A StopHbTasksResponse holds details about stop Hummingbird tasks response.
The array of hb_task_id that were deleted.
The array of hb_task_id that were not found. These Hummingbird tasks will be ignored.
The array of hb_task_id that are running
The array of hb_task_id that were locked by other process.
Status Code
Success.
You are not authorized to cancel a Hummingbird task.
You are not permitted to perform this action.
An error occurred. The Hummingbird tasks cannot be deleted.
No Sample Response
Response
An HbTaskResponse holds details about Hummingbird job and the status of task in queue.
The ID of the task
The ID of the account
Indicates if account plan is free plan
Type of the job
The job payload
The id to track complete flow
Priority of the HB job
The ID of the HB job
Timestamp of task creation
Timestamp of job submission
Timestamp of job completion
The duration for which job was run
The number of times the job was retried
Status of the HB job
Possible values: [
REQUESTED,SUBMITTED,RUNNING,COMPLETED,ERROR,STOPPED,STOPPED_CAPACITY_UNIT_EXCEEDED,QUEUED]The ID of the project where the spark job logs need to be saved. If this value is not provided or is invalid then the spark job logs will be stored in default COS bucket.
A RuntimeRegistrationParameters holds details to be sent to runtimes api to report CUH for HB job.
A ComputeUnits holds details to determine if a particular account has surpassed its CUH.
Status Code
Success.
You are not authorized to get the data profile you specified.
You are not permitted to perform this action.
The HB task you specified cannot be found.
An error occurred. The HB task you specified cannot be fetched.
No Sample Response
Delete Hummingbird task
Status: Complete
Deletes a specified Hummingbird task.
This api will throw an exception if stop_in_progress_job parameter is not true and if job is running.
DELETE /v1/hb_tasks/{hb_task_id}Get Hummingbird task logs
Status: Complete
Get the spark job logs for Hummingbird task. In order to retrieve the job logs, the HB spark job must be successfully submitted. This will generate a job_id. When successful, this api would return the Hummingbird spark job log.
GET /v1/hb_tasks/{hb_task_id}/logsList all data quality rules or a subset of them
Get a list of data quality rules in the project.
GET /data_quality/v3/projects/{project_id}/rulesRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The start token of the resource from where the page should begin.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20Comma-separated list of data quality rule identifiers.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710
Response
A collection of data quality rules to be returned.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
A collection of data quality rules.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality rules in the specified project.
An error occurred. The list of data quality rules could not be returned.
{"total_count":100,"limit":50,"first":{"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules?limit=50"},"rules":[{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"is_valid":true,"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf","name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Create data quality rule
Create a data quality rule.
POST /data_quality/v3/projects/{project_id}/rulesRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Data quality rule to create.
Example: {"name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}
The name of the data quality rule. The rule name must be unique in the given project. If no unique name is provided, the quality rule will not be created.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
The description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource. If this property is omitted, no data quality dimension is associated with the resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule. If this property is omitted, no output records are saved.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a value for
data_stageis provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Representation of the data stage flow resource to create. If this property is omitted, no subflow is created for the data quality rule.
Response
A data quality rule defines an executable applying a boolean expression on bound columns.
The name of the data quality rule. The name of the quality rule will be unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5Flag indicating whether the rule is valid or not.
The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a
data_stageelement is provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Data stage flow details.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create data quality rules in the specified project.
An error occurred. The data quality rule could not be created.
{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"is_valid":true,"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf","name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Delete data quality rules
Delete the data quality rules for the given list of rule identifiers.
DELETE /data_quality/v3/projects/{project_id}/rulesRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
Comma-separated list of data quality rule identifiers.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710The option to delete related output tables when deleting data quality rules.
Default:
falseThe option to cancel unfinished jobs before deleting or updating data quality rules.
Default:
false
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality rules in the specified project.
An error occurred. The data quality rules cannot be deleted.
{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Validate data quality rule
Check the validity of the data quality rule.
POST /data_quality/v3/projects/{project_id}/validate_ruleRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Data quality rule to validate.
Example: {"name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}
The name of the data quality rule. The rule name must be unique in the given project. If no unique name is provided, the quality rule will not be created.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
The description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource. If this property is omitted, no data quality dimension is associated with the resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule. If this property is omitted, no output records are saved.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a value for
data_stageis provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Representation of the data stage flow resource to create. If this property is omitted, no subflow is created for the data quality rule.
Response
A data quality rule defines an executable applying a boolean expression on bound columns.
The name of the data quality rule. The name of the quality rule will be unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5Flag indicating whether the rule is valid or not.
The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a
data_stageelement is provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Data stage flow details.
Status Code
The data quality rule is valid.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to validate data quality rules in the specified project.
The data quality rule is invalid. See the error message for the cause.
{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"is_valid":true,"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf","name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Get data quality rule
Gets the data quality rule with the given identifier.
GET /data_quality/v3/projects/{project_id}/rules/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
A data quality rule defines an executable applying a boolean expression on bound columns.
The name of the data quality rule. The name of the quality rule will be unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5Flag indicating whether the rule is valid or not.
The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a
data_stageelement is provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Data stage flow details.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality rule with the given identifier from the specified project.
The data quality rule cannot be found.
An error occurred. The data quality rule with the given identifier cannot be returned.
{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"is_valid":true,"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf","name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Delete data quality rule
Delete the data quality rule with the given identifier.
DELETE /data_quality/v3/projects/{project_id}/rules/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The option to delete related output tables when deleting data quality rules.
Default:
falseThe option to cancel unfinished jobs before deleting or updating data quality rules.
Default:
false
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality rule from the specified project.
The data quality rule cannot be found.
An error occurred. The data quality rule cannot be deleted.
{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Update data quality rule
Updates a data quality rule as specified in the payload details of the update rule request. The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be patched:
- name (value can only be replaced)
- definition (value can only be replaced)
- description (value can be added, removed, or replaced)
- dimension (value can be added, removed, or replaced)
- input (value can be added, removed or replaced)
- output (value can be added, removed, or replaced)
- joins (value can be added, removed, or replaced)
- sampling (value can be added, removed, or replaced)
- data_stage/propagate_all_incoming_columns (value can be added, removed, or replaced)
PATCH /data_quality/v3/projects/{project_id}/rules/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The option to cancel unfinished jobs before deleting or updating data quality rules.
Default:
falseThe option to keep the current data quality rule input binding relationships while updating the data quality rule.
Default:
false
The updates to make in the data quality rule.
Example: [{"op":"replace","path":"/description","value":"Column col1 has fewer or the same number of values as column col2"}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data quality rule defines an executable applying a boolean expression on bound columns.
The name of the data quality rule. The name of the quality rule will be unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5Flag indicating whether the rule is valid or not.
The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a
data_stageelement is provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Data stage flow details.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality rule in the specified project.
The data quality rule cannot be found.
An error occurred. The data quality rule was not updated.
{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"is_valid":true,"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf","name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Run data quality rule
Run the data quality rule with the given identifier.
POST /data_quality/v3/projects/{project_id}/rules/{id}/executeRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
The representation of a data quality rule execution.
Identity of a job associated with a rule.
Identity of a run associated with a job, which in turn is associated with a a rule.
The status of the rule run.
The name of the user that ran the rule.
Possible values: 1 ≤ length ≤ 50
Example:
IBMid-270002ABCDResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfNumber of passing records.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
900Number of failing records.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100Data quality rule input details.
The output details of a data quality rule.
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Number of records tested.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
1000The start time of the rule run.
Possible values: 20 ≤ length ≤ 24
The end time of the rule run.
Possible values: 20 ≤ length ≤ 24
Name of the result.
Possible values: 1 ≤ length ≤ 200
Example:
execution1A list of execution results per definition.
Possible values: 1 ≤ number of items ≤ 100
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to run the data quality rule in the specified project.
The data quality rule cannot be found.
An error occurred. The data quality rule cannot be run.
{"name":"table1.col1LessOrEqualTable2.col2","job":{"id":"aa398b69-3e91-4830-877a-91a8e21f56de"},"job_run":{"id":"aa398b69-3e91-4830-877a-91a8e21f5123"},"status":{"state":"analyzed"},"started_at":"2022-02-01T18:10:02.000Z","ended_at":"2022-02-01T18:11:02.000Z","run_by":"IBMid-270002ABCD","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"input":{"definitions":[{"bound_expression":"TEST.table1.col1<=TEST.table2.col2"}]},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"aa398b69-3e91-4830-877a-91a8e21f56de"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"output_table":{"id":"5d4254a6-0c9e-4a02-bc24-4a89eee06f12"},"tested_record_count":1000,"passing_record_count":987,"failing_record_count":13,"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf/executions/7b3f3a79-6412-480b-a20c-393a3f7adabc"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Get data quality rule from catalog
Gets the data quality rule from catalog with the given identifier.
GET /data_quality/v3/catalogs/{catalog_id}/rules/{id}Request
Path Parameters
The identifier of the catalog to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
A data quality rule defines an executable applying a boolean expression on bound columns.
The name of the data quality rule. The name of the quality rule will be unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
address_exists_ruleData quality rule input details.
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5Flag indicating whether the rule is valid or not.
The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality rule. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Rule to check address exists.Identity of a data quality dimension resource.
Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then
dimensionwill be ignored.The output details of a data quality rule.
The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a
data_stageelement is provided.Possible values: 1 ≤ number of items ≤ 50
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Data stage flow details.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality rule with the given identifier from the specified catalog.
The data quality rule cannot be found.
An error occurred. The data quality rule with the given identifier cannot be returned.
{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"is_valid":true,"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf","name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"input":{"definitions":[{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":1,"bindings":[{"variable_name":"col1","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col1","type":"column"}}]},{"definition":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"disambiguator":2,"bindings":[{"variable_name":"col2","target":{"data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"column_name":"col2","type":"column"}}]}]},"joins":[{"type":"inner_join","left_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"right_data_asset":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93xyz"},"left_column_name":"col1","right_column_name":"col2"}],"dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"apply_all_present_dimensions":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
List history of all data quality rule run results or a subset of them
Gets the list of data quality rule runs. By default, the runs are sorted newest to oldest.
GET /data_quality/v3/projects/{project_id}/rules/{rule_id}/executionsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The start token of the resource from where the page should begin.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20The property name by which the results should be sorted. For descending order, use the hyphen (-) prefix with the value. If you omit this query parameter, the order value is
-started_at, which means, results are sorted by thestarted_atvalue in descending order. The allowed fields arestarted_at,passing_record_count,failing_record_count,tested_record_count,status.state.Possible values: 1 ≤ length ≤ 128
Response
Data quality rule run history
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
A list of rule run results, sorted based on the value of the
sortquery parameter.Possible values: 1 ≤ number of items ≤ 50
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality rule history in the specified project.
An error occurred. The data quality rule history could not be returned.
{"limit":20,"total_count":100,"first":{"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/c19cde3a-5940-4c7a-ad0f-ee18f5f29c12/executions?limit=20"},"executions":[{"name":"table1.col1LessOrEqualTable2.col2","description":"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2","job":{"id":"aa398b69-3e91-4830-877a-91a8e21f56de"},"job_run":{"id":"aa398b69-3e91-4830-877a-91a8e21f5123"},"status":{"state":"analyzed"},"started_at":"2022-02-01T18:10:02.000Z","ended_at":"2022-02-01T18:11:02.000Z","run_by":"IBMid-270002ABCD","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"aa398b69-3e91-4830-877a-91a8e21f56de"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"output_table":{"id":"5d4254a6-0c9e-4a02-bc24-4a89eee06f12"},"tested_record_count":1000,"bound_expression":["TEST.table1.col1<=TEST.table2.col2"],"passing_record_count":987,"failing_record_count":13,"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf/executions/7b3f3a79-6412-480b-a20c-393a3f7adabc"}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Get the data quality rule run
Gets the data quality rule run result with the given identifier.
GET /data_quality/v3/projects/{project_id}/rules/{rule_id}/executions/{id}Request
Path Parameters
The data quality rule identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The run identifier to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
The representation of a data quality rule execution.
Identity of a job associated with a rule.
Identity of a run associated with a job, which in turn is associated with a a rule.
The status of the rule run.
The name of the user that ran the rule.
Possible values: 1 ≤ length ≤ 50
Example:
IBMid-270002ABCDResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfNumber of passing records.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
900Number of failing records.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100Data quality rule input details.
The output details of a data quality rule.
The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source.
Number of records tested.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
1000The start time of the rule run.
Possible values: 20 ≤ length ≤ 24
The end time of the rule run.
Possible values: 20 ≤ length ≤ 24
Name of the result.
Possible values: 1 ≤ length ≤ 200
Example:
execution1A list of execution results per definition.
Possible values: 1 ≤ number of items ≤ 100
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality rule run result in the specified project.
An error occurred. The result of data quality rule run could not be returned.
{"name":"table1.col1LessOrEqualTable2.col2","job":{"id":"aa398b69-3e91-4830-877a-91a8e21f56de"},"job_run":{"id":"aa398b69-3e91-4830-877a-91a8e21f5123"},"status":{"state":"analyzed"},"started_at":"2022-02-01T18:10:02.000Z","ended_at":"2022-02-01T18:11:02.000Z","run_by":"IBMid-270002ABCD","sampling":{"size":2500,"interval":13,"sampling_type":"every_nth"},"input":{"definitions":[{"bound_expression":"TEST.table1.col1<=TEST.table2.col2"}]},"output":{"columns":[{"variable_name":"col1","name":"out1","type":"rule_variable","disambiguator":1},{"name":"out2","type":"column","source_column":{"data_asset":{"id":"aa398b69-3e91-4830-877a-91a8e21f56de"},"column_name":"col1","type":"column"}},{"expression":"col1-col2","name":"out4","type":"rule_expression","disambiguator":2},{"metric":"system_time","name":"out5","type":"metric"}],"database":{"records_type":"all_records","update_type":"append","location":{"connection":{"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf"},"schema_name":"TEST","table_name":"output"}},"maximum_record_count":500},"output_table":{"id":"5d4254a6-0c9e-4a02-bc24-4a89eee06f12"},"tested_record_count":1000,"passing_record_count":987,"failing_record_count":13,"id":"7b3f3a79-6412-480b-a20c-393a3f7addbf","href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf/executions/7b3f3a79-6412-480b-a20c-393a3f7adabc"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
List all data quality definitions or a subset of them
Gets the list of all data quality definitions.
GET /data_quality/v3/projects/{project_id}/definitionsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The start token of the resource from where the page should begin.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20Comma-separated list of data quality definition identifiers.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710
Response
An array of data quality definitions.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
A collection of existing definitions.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality definitions in the specified project.
An error occurred. The list of data quality definitions cannot be returned.
{"total_count":100,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions?limit=200"},"definitions":[{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Create data quality definition
Creates a data quality definition in the specified project.
POST /data_quality/v3/projects/{project_id}/definitionsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Data quality definition to create.
Example: {"name":"col1LessOrEqualCol2","description":"Column col1 has fewer or the same number of values as column col2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"}}
The name of the data quality definition. The name of the definition must be unique in the given project. If no unique name is provided, the REST call fails.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource. If this property is omitted, no data quality dimension is associated with the resource.
Response
A data quality definition defines a boolean rule along with the variables.
The name of the data quality definition. The name of the quality definition is unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create a definition in the specified project.
An error occurred. The definition was not created.
{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Delete data quality definitions
Delete the data quality definitions with the given identifiers.
DELETE /data_quality/v3/projects/{project_id}/definitionsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
Comma separated list of data quality definition identifiers.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality definitions in the specified project or catalog.
An error occurred. The data quality definitions cannot be deleted.
{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Validate data quality definition expression
Validate the specified definition expression.
POST /data_quality/v3/projects/{project_id}/validate_definitionRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
True if the expression to validate is an output column expression. False if the expression to validate is a data quality definition expression. Default value is false.
Data quality definition to validate.
Example: {"name":"col1LessOrEqualCol2","description":"Column col1 has fewer or the same number of values as column col2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"}}
The name of the data quality definition. The name of the definition must be unique in the given project. If no unique name is provided, the REST call fails.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource. If this property is omitted, no data quality dimension is associated with the resource.
Response
This response contains the rule expression variables and their types.
The list of variables in this expression. This field is set if the rule is valid (
is_valid=true).Possible values: 1 ≤ number of items ≤ 100
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to validate the data quality definition in the specified project or catalog.
An error occurred. The data quality definitions could not be validated.
{"variables":[{"name":"col1","type":"numeric","usage":"input_data"},{"name":"col2","type":"numeric","usage":"input_data"}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Get data quality definition
Gets the data quality definition with the given identifier.
GET /data_quality/v3/projects/{project_id}/definitions/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality definition identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
A data quality definition defines a boolean rule along with the variables.
The name of the data quality definition. The name of the quality definition is unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality definition with the given ID from the specified project or catalog.
The data quality definition cannot be found.
An error occurred. The data quality definition with the given identifier could not be returned.
{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Replace data quality definition
Replace a data quality definition.
PUT /data_quality/v3/projects/{project_id}/definitions/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality definition identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Data quality definition to replace.
Example: {"name":"col1LessOrEqualCol2","description":"Column col1 has fewer or the same number of values as column col2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"}}
The name of the data quality definition. The name of the definition must be unique in the given project. If no unique name is provided, the REST call fails.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource. If this property is omitted, no data quality dimension is associated with the resource.
Response
A data quality definition defines a boolean rule along with the variables.
The name of the data quality definition. The name of the quality definition is unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update data quality definitions in the specified project or catalog.
An error occurred. The data quality definition was not updated.
{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Delete data quality definition
Delete the data quality definition with the given identifier.
DELETE /data_quality/v3/projects/{project_id}/definitions/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality definition identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality definition from the specified project.
The data quality definition cannot be found.
An error occurred. The data quality definition cannot be deleted.
{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Update data quality definition
Updates a data quality definition as specified in the payload details of the update definition request. The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be patched.
- name (value can only be replaced)
- description (value can be added, removed, or replaced)
- expression (value can only be replaced)
- dimension (value can be added, removed, or replaced)
PATCH /data_quality/v3/projects/{project_id}/definitions/{id}Request
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality definition identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The updates to make in the data quality definition.
Example: [{"op":"replace","path":"/description","value":"Column col1 has fewer or the same number of values as column col2"}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data quality definition defines a boolean rule along with the variables.
The name of the data quality definition. The name of the quality definition is unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality definition in the specified project.
The data quality definition cannot be found.
An error occurred. The data quality definition was not updated.
{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Get data quality definition from catalog
Gets the data quality definition from catalog with the given identifier.
GET /data_quality/v3/catalogs/{catalog_id}/definitions/{id}Request
Path Parameters
The identifier of the catalog to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality definition identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
A data quality definition defines a boolean rule along with the variables.
The name of the data quality definition. The name of the quality definition is unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality definition with the given ID from the specified project or catalog.
The data quality definition cannot be found.
An error occurred. The data quality definition with the given identifier could not be returned.
{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Update data quality definition in catlog
Updates a data quality definition as specified in the payload details of the update definition request. The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be patched.
- dimension (value can be added, removed, or replaced)
PATCH /data_quality/v3/catalogs/{catalog_id}/definitions/{id}Request
Path Parameters
The identifier of the catalog to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality definition identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The updates to make in the data quality definition.
Example: [{"op":"replace","path":"/description","value":"Column col1 has fewer or the same number of values as column col2"}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data quality definition defines a boolean rule along with the variables.
The name of the data quality definition. The name of the quality definition is unique in a given project.
Possible values: 1 ≤ length ≤ 200
Example:
Address exists definitionThe expression of the data quality definition.
Possible values: 1 ≤ length ≤ 10000
Example:
field0 existsResource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The location URL of a resource.
Possible values: 1 ≤ length ≤ 512
Example:
https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbfThe description of the data quality definition. If this property is omitted, no description is set.
Possible values: 1 ≤ length ≤ 5000
Example:
Definition to check if address existsIdentity of a data quality dimension resource.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality definition in the specified catalog.
The data quality definition cannot be found.
An error occurred. The data quality definition was not updated.
{"description":"Column col1 has fewer or the same number of values as column col2","id":"7b3f3a79-6412-480b-a20c-393a3f7adoi","name":"col1LessOrEqualCol2","expression":"col1 <= col2","dimension":{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93abc"},"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf"}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
List all data quality dimensions
Gets the list of all data quality dimensions
GET /data_quality/v3/projects/{project_id}/dimensionsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The start token of the resource from where the page should begin.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20
Response
A collection of data quality dimensions.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality dimensions.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You are not permitted to get data quality dimensions of the specified project.
An error occurred. The list of data quality dimensions cannot be returned.
{"limit":20,"total_count":100,"first":{"href":"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/dimensions?limit=20"},"dimensions":[{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"Completeness","description":"The proportion of data stored against the potential for 100%.","creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"},{"id":"57561203-36e6-4bb0-adfb-ece981fba845","name":"Uniqueness","description":"No entity instance (`abc`) will be recorded more than once based on how `abc` is identified.","creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"},{"id":"a3134282-ed85-4140-ae61-e5f712a61985","name":"Timeliness","description":"The degree to which data represent reality from the required point in time.","creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"},{"id":"ec453723-669c-48bb-82c1-11b69b3b8c93","name":"Validity","description":"Data is valid if it conforms to the syntax (format, type, range) of its definition.","creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"},{"id":"5f66813e-adb1-4f3f-a65f-40e3066aac07","name":"Accuracy","description":"The degree to which data correctly describes the real world object or event being described.","creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"},{"id":"5f66813e-adb1-4f3f-a65f-40e3066aa123","name":"Consistency","description":"The absence of difference when comparing two or more representations of an object against a definition.","creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Get project settings for data quality rules
Gets the project settings for data quality rules.
GET /data_quality/v3/projects/{project_id}/settingsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
Project settings.
In rules containing equality tests between strings, this property indicates whether the values to be tested should consider trailing spaces.
This property indicates whether to trim the value of the data type char/varchar before using that value in comparison.
This property indicates whether values of data quality rule variables have to be casted automatically to the type expected in the data quality rule expression.
The maximum length of String values when executing data quality rules.
Possible values: 1 ≤ value ≤ 1024
Example:
512In rules with multiple definitions, indicates if definitions evaluating as null (undefined) have to be considered failing (false) or passing (true).
This property indicates whether group keys for aggregations in the data quality rule are case sensitive or not.
If set to true, a string surrounded by double quotes in an expression will be treated as a variable instead of string literal value.
The heap size in MB of the Java stages needed to implement data rules.
Possible values: 1 ≤ value ≤ 2048
Example:
512In rules of the form "IF condition THEN test", this property indicates how data records that do not fulfil the condition have to be evaluated. If the property is not set, the data records are not counted. Otherwise, the records are counted as failing (false) or as passing (true) as defined.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality rule settings in the specified project.
An error occurred. The project settings for data quality rules could not be returned.
{"default_else_value":true,"ignore_trailing_spaces":false,"implicit_casting":true,"max_string_length":1024,"allow_quoted_variables":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Replace project settings for data quality rules
Replace project settings for data quality rules.
PUT /data_quality/v3/projects/{project_id}/settingsRequest
Path Parameters
The identifier of the project to use.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Project settings for data quality rules.
Example: {"default_else_value":true,"ignore_trailing_spaces":false,"implicit_casting":true,"max_string_length":1024,"allow_quoted_variables":false}
In rules of the form "IF condition THEN test", this property indicates how data records that do not fulfil the condition have to be evaluated. If the property is not set, the data records are not counted. Otherwise, the records are counted as failing (false) or as passing (true) as defined.
In rules containing equality tests between strings, this property indicates whether the values to be tested should consider trailing spaces.
Default:
falseThis property indicates whether to trim the value of the data type char/varchar before using that value in comparison.
Default:
trueThis property indicates whether values of data quality rule variables have to be casted automatically to the type expected in the data quality rule expression.
Default:
trueThe maximum length of String values when executing data quality rules.
Possible values: 1 ≤ value ≤ 1024
Default:
1024Example:
512In rules with multiple definitions, indicates if definitions evaluating as null (undefined) have to be considered failing (false) or passing (true).
Default:
trueThis property indicates whether group keys for aggregations in the data quality rule are case sensitive or not.
Default:
trueIf set to true, a string surrounded by double quotes in an expression will be treated as a variable instead of string literal value.
Default:
falseThe heap size in MB of the Java stages needed to implement data rules.
Possible values: 1 ≤ value ≤ 2048
Default:
256Example:
512
Response
Project settings.
In rules containing equality tests between strings, this property indicates whether the values to be tested should consider trailing spaces.
This property indicates whether to trim the value of the data type char/varchar before using that value in comparison.
This property indicates whether values of data quality rule variables have to be casted automatically to the type expected in the data quality rule expression.
The maximum length of String values when executing data quality rules.
Possible values: 1 ≤ value ≤ 1024
Example:
512In rules with multiple definitions, indicates if definitions evaluating as null (undefined) have to be considered failing (false) or passing (true).
This property indicates whether group keys for aggregations in the data quality rule are case sensitive or not.
If set to true, a string surrounded by double quotes in an expression will be treated as a variable instead of string literal value.
The heap size in MB of the Java stages needed to implement data rules.
Possible values: 1 ≤ value ≤ 2048
Example:
512In rules of the form "IF condition THEN test", this property indicates how data records that do not fulfil the condition have to be evaluated. If the property is not set, the data records are not counted. Otherwise, the records are counted as failing (false) or as passing (true) as defined.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to define project settings for data quality rules in the specified project.
An error occurred. The project settings for data quality rules were not created or updated.
{"default_else_value":true,"ignore_trailing_spaces":false,"implicit_casting":true,"max_string_length":1024,"allow_quoted_variables":false}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The start token of the resource from where the page should begin. If omitted, begins with first resource.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
falseThe type of the resource to search. If omitted, filtering on type is not applied
Possible values: 1 ≤ length ≤ 200
Response
A collection of data quality assets.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality assets.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality assets.
An error occurred. The list of data quality assets cannot be returned.
{"total_count":1,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v4/assets?limit=200"},"assets":[{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","name":"CUSTOMERS","type":"data_asset","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","weight":1,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
Data quality asset to create.
Example: {"native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","name":"CUSTOMERS","type":"data_asset","weight":1}
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
CUSTOMERSUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_assetThe weight of this asset in the computation of the data quality scores
The Id of an eventual parent, or null if this asset has no parent
- parent
The type of the IBM Knowledge Catalog asset
Possible values: 1 ≤ length ≤ 200
Example:
DataSetThe identity of the IBM Knowledge Catalog asset this DQ asset is referring to
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field
- virtualized_asset
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Response
A data asset on which data quality is measured.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
CUSTOMERSUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_assetThe weight of this asset in the computation of the data quality scores
Possible values: 0 ≤ value ≤ 1
Eventual children of this asset. If omitted, no children for this asset.
Possible values: 0 ≤ number of items ≤ 100000
The Id of an eventual parent, or null if this asset has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The type of the IBM Knowledge Catalog asset
Possible values: 1 ≤ length ≤ 200
Example:
DataSetThe identity of the IBM Knowledge Catalog asset this DQ asset is referring to
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field
- virtualized_asset
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success
The given payload is invalid and the asset is not created.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create a data quality asset.
The data quality asset exists already and cannot be created.
An error occurred. The data quality asset cannot be created.
{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","name":"CUSTOMERS","type":"data_asset","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","weight":1,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}{"trace":"6vbjp9d2t4s9b2ckyspdw4vft","status_code":400,"errors":[{"code":"missing_required_field","message":"Bad Request: {\"trace\":\"8f7b7693-1f08-4b4a-b2bd-5732d06ad19e\", \"errors\":[{\"code\":\"invalid_parameter\", \"message\":\"COMSV3006E: Missing or Invalid asset id\", \"target\":{\"name\":\"asset\",\"type\":\"parameter\"}}]}"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"28izpw5l1a4orh823i6bkqmm","status_code":409,"errors":[{"code":"already_exists","message":"The dimension with name 'Completeness' already exists."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Get a data quality asset
Get the data quality asset with the given identifier.
GET /data_quality/v4/assets/{id}Request
Path Parameters
The data quality asset identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
false
Response
A data asset on which data quality is measured.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
CUSTOMERSUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_assetThe weight of this asset in the computation of the data quality scores
Possible values: 0 ≤ value ≤ 1
Eventual children of this asset. If omitted, no children for this asset.
Possible values: 0 ≤ number of items ≤ 100000
The Id of an eventual parent, or null if this asset has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The type of the IBM Knowledge Catalog asset
Possible values: 1 ≤ length ≤ 200
Example:
DataSetThe identity of the IBM Knowledge Catalog asset this DQ asset is referring to
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field
- virtualized_asset
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality asset.
The data quality asset with the given ID cannot be found.
An error occurred. The data quality asset cannot be returned.
{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","name":"CUSTOMERS","type":"data_asset","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","weight":1,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Delete data quality asset
Delete the data quality asset with the given identifier and all its children recursively
DELETE /data_quality/v4/assets/{id}Request
Path Parameters
The data quality asset identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
If true, delete all children recursively. Otherwise, only selected one is deleted.
Default:
false
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality asset.
The data quality asset cannot be found.
An error occurred. The data quality asset cannot be deleted.
{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Update or patch a data quality asset
Update a data quality asset as specified in the payload details of the request.
The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be updated: - /name (value can only be replaced) - /weight (value can only be replaced)
PATCH /data_quality/v4/assets/{id}Request
Path Parameters
The data quality asset identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The updates to make in the data quality rule.
Example: [{"op":"replace","path":"/description","value":"The proportion of data stored against the potential for 100% of the data."}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data asset on which data quality is measured.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
CUSTOMERSUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_assetThe weight of this asset in the computation of the data quality scores
Possible values: 0 ≤ value ≤ 1
Eventual children of this asset. If omitted, no children for this asset.
Possible values: 0 ≤ number of items ≤ 100000
The Id of an eventual parent, or null if this asset has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The type of the IBM Knowledge Catalog asset
Possible values: 1 ≤ length ≤ 200
Example:
DataSetThe identity of the IBM Knowledge Catalog asset this DQ asset is referring to
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field
- virtualized_asset
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality asset.
The data quality asset with the given ID cannot be found.
An error occurred. The data quality asset cannot be updated.
{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","name":"CUSTOMERS","type":"data_asset","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","weight":1,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Search data quality asset with given native id and type
Search for a data quality asset by its native id and type
POST /data_quality/v4/search_dq_asset
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The native id, as known by the DQ producer, of the resource to search. If not provided, other identity parameters must be provided.
Possible values: 1 ≤ length ≤ 500
The type of the resource to search. If omitted, filtering on type is not applied
Possible values: 1 ≤ length ≤ 200
The identity of the IBM Knowledge Catalog asset this DQ asset is referring to
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
false
Response
A data asset on which data quality is measured.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
CUSTOMERSUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_assetThe weight of this asset in the computation of the data quality scores
Possible values: 0 ≤ value ≤ 1
Eventual children of this asset. If omitted, no children for this asset.
Possible values: 0 ≤ number of items ≤ 100000
The Id of an eventual parent, or null if this asset has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The type of the IBM Knowledge Catalog asset
Possible values: 1 ≤ length ≤ 200
Example:
DataSetThe identity of the IBM Knowledge Catalog asset this DQ asset is referring to
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field
- virtualized_asset
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to search data quality assets.
The data quality asset cannot be found.
An error occurred. The data quality asset cannot be searched.
{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","name":"CUSTOMERS","type":"data_asset","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","weight":1,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The start token of the resource from where the page should begin. If omitted, begins with first resource.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
falseThe type of the resource to search. If omitted, filtering on type is not applied
Possible values: 1 ≤ length ≤ 200
Response
A collection of data quality checks.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality checks.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality checks.
An error occurred. The list of data quality checks cannot be returned.
{"total_count":1,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v4/checks?limit=200"},"checks":[{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","name":"check_uniqueness_of_id","dimension":{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"COMPLETENESS","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"type":"data_rule","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
Data quality check to create.
Example: {"dimension":{"id":"371114cd-5516-4691-8b2e-1e66edf66486"},"name":"check_uniqueness_of_id","type":"data_rule","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702"}
the dimension this check belongs to
- dimension
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe Id of an eventual parent, or null if this check has no parent
- parent
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Response
A data quality check, i.e. an action to measure data quality.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success
The given payload is invalid and the check is not created.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create a data quality check.
The data quality check exists already and cannot be created.
An error occurred. The data quality check cannot be created.
{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"check_uniqueness_of_id","dimension":{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"COMPLETENESS","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"type":"data_rule","native_id":"4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"6vbjp9d2t4s9b2ckyspdw4vft","status_code":400,"errors":[{"code":"missing_required_field","message":"Bad Request: {\"trace\":\"8f7b7693-1f08-4b4a-b2bd-5732d06ad19e\", \"errors\":[{\"code\":\"invalid_parameter\", \"message\":\"COMSV3006E: Missing or Invalid asset id\", \"target\":{\"name\":\"asset\",\"type\":\"parameter\"}}]}"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"28izpw5l1a4orh823i6bkqmm","status_code":409,"errors":[{"code":"already_exists","message":"The dimension with name 'Completeness' already exists."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Get a data quality check
Get the data quality check with the given identifier.
GET /data_quality/v4/checks/{id}Request
Path Parameters
The data quality check identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
false
Response
A data quality check, i.e. an action to measure data quality.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality check.
The data quality check with the given ID cannot be found.
An error occurred. The data quality check cannot be returned.
{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"check_uniqueness_of_id","dimension":{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"COMPLETENESS","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"type":"data_rule","native_id":"4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Delete a data quality check
Delete the data quality check with the given identifier and all its children recursively
DELETE /data_quality/v4/checks/{id}Request
Path Parameters
The data quality check identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
If true, delete all children recursively. Otherwise, only selected one is deleted.
Default:
false
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality check.
The data quality check cannot be found.
An error occurred. The data quality check cannot be deleted.
{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Update or patch a data quality check
Update a data quality check as specified in the payload details of the request.
The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be updated: - /name (value can only be replace) - /dimension/id (value can be add, remove or replace) - /details (value can be add, remove or replace)
PATCH /data_quality/v4/checks/{id}Request
Path Parameters
The data quality check identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The updates to make in the data quality rule.
Example: [{"op":"replace","path":"/description","value":"The proportion of data stored against the potential for 100% of the data."}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data quality check, i.e. an action to measure data quality.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality check.
The data quality check with the given ID cannot be found.
An error occurred. The data quality check cannot be updated.
{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"check_uniqueness_of_id","dimension":{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"COMPLETENESS","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"type":"data_rule","native_id":"4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Search for a data quality check by its native id and type
Search for a data quality check by its native id and type
POST /data_quality/v4/search_dq_check
Request
Query Parameters
The native id, as known by the DQ producer, of the resource to search.
Possible values: 1 ≤ length ≤ 500
The type of the resource to search.
Possible values: 1 ≤ length ≤ 200
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
false
Response
A data quality check, i.e. an action to measure data quality.
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to search data quality checks.
The data quality check cannot be found.
An error occurred. The data quality check cannot be searched.
{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"check_uniqueness_of_id","dimension":{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"COMPLETENESS","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"type":"data_rule","native_id":"4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Get a list of data quality dimensions
Get a list of data quality dimensions.
GET /data_quality/v4/dimensions
Request
Query Parameters
The start token of the resource from where the page should begin. If omitted, begins with first resource.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20
Response
A collection of data quality dimensions.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality dimensions.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality dimensions.
An error occurred. The list of data quality dimensions cannot be returned.
{"total_count":1,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v4/dimensions?limit=200"},"dimensions":[{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"Completeness","description":"The proportion of data stored against the potential for 100 percent.","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Request
Data quality dimension to create.
Example: {"name":"Completeness10","description":"The proportion of data stored against the potential for 100 percent represented as integer 10."}
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
CompletenessThe optional description of the dimension. Provide a description to understand the reason for its existence.
Possible values: 0 ≤ length ≤ 255
Example:
The proportion of data stored against the potential for 100 percent. If this property is omitted, no description is set.
Response
Flag indicating whether the dimension is a built-in dimension or not.
Status Code
Success
The given payload is invalid and the dimension is not created.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create a data quality dimension.
The data quality dimension exists already and cannot be created.
An error occurred. The data quality dimension cannot be created.
{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"Completeness","description":"The proportion of data stored against the potential for 100 percent.","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"}{"trace":"6vbjp9d2t4s9b2ckyspdw4vft","status_code":400,"errors":[{"code":"missing_required_field","message":"Bad Request: {\"trace\":\"8f7b7693-1f08-4b4a-b2bd-5732d06ad19e\", \"errors\":[{\"code\":\"invalid_parameter\", \"message\":\"COMSV3006E: Missing or Invalid asset id\", \"target\":{\"name\":\"asset\",\"type\":\"parameter\"}}]}"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"28izpw5l1a4orh823i6bkqmm","status_code":409,"errors":[{"code":"already_exists","message":"The dimension with name 'Completeness' already exists."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Get the data quality dimension with the given identifier
Get the data quality dimension with the given identifier.
GET /data_quality/v4/dimensions/{id}Request
Path Parameters
The data quality dimension identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
Flag indicating whether the dimension is a built-in dimension or not.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality dimension.
The data quality dimension with the given ID cannot be found.
An error occurred. The data quality dimension cannot be returned.
{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"Completeness","description":"The proportion of data stored against the potential for 100 percent.","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Delete the data quality dimension with the given identifier.
Delete the data quality dimension with the given identifier.
All data quality checks associated to this dimension will point to no dimension. All DQ scores stored for this dimension will be deleted
DELETE /data_quality/v4/dimensions/{id}Request
Path Parameters
The data quality dimension identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Response
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to delete the data quality dimension.
The data quality dimension cannot be found.
An error occurred. The data quality dimension cannot be deleted.
{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Update a data quality dimension
Update a data quality dimension as specified in the payload details of the request.
The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be updated: - /name (value can only be replaced) - /description (value can be added, removed, or replaced)
PATCH /data_quality/v4/dimensions/{id}Request
Path Parameters
The data quality dimension identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
The updates to make in the data quality rule.
Example: [{"op":"replace","path":"/description","value":"The proportion of data stored against the potential for 100% of the data."}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
Flag indicating whether the dimension is a built-in dimension or not.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality dimension.
The data quality dimension with the given ID cannot be found.
An error occurred. The data quality dimension cannot be updated.
{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"Completeness","description":"The proportion of data stored against the potential for 100 percent.","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Search for data quality dimensions by name or part of their names
Search for data quality dimensions by name or part of their names
POST /data_quality/v4/search_dq_dimension
Request
Query Parameters
The name of the resource to search or a part of the name of the resources to search.
Possible values: 1 ≤ length ≤ 200
Response
A collection of data quality dimensions.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality dimensions.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to search data quality dimensions.
An error occurred. The data quality dimension cannot be searched.
{"total_count":1,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v4/dimensions?limit=200"},"dimensions":[{"id":"371114cd-5516-4691-8b2e-1e66edf66486","name":"Completeness","description":"The proportion of data stored against the potential for 100 percent.","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-01T18:11:02.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The start token of the resource from where the page should begin. If omitted, begins with first resource.
Possible values: 1 ≤ length ≤ 512
Example:
g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Default:
200Example:
20Comma-separated list of data quality asset identifier to search issues of. If not provided, filtering on asset is not applied.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710Comma-separated list of data quality check id identifier to search issues of. If not provided, filtering on a check is not applied.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710Comma-separated list of data quality check native id identifier to search issues of. If not provided, filtering on a check is not applied. Only one of checkId or checkNativeId should be provided; if both are provided, an error will be thrown.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710The name or part of the name of data quality check identifier to search issues of. If not provided, filtering on name of check is not applied.
Possible values: 1 ≤ length ≤ 200
Comma-separated list of data quality dimension identifiers.
Possible values: 1 ≤ length ≤ 10000
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710If true, returns only the latest issue summary of each DQ check. If false, returns the latest and archived issues.
Default:
trueThe type of the resource to search. If omitted, filtering on type is not applied
Possible values: 1 ≤ length ≤ 200
If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
trueThe issue attribute to sort on. If omitted, sorting on last update time is applied
Allowable values: [
check_name,check_type,check_dimension_name,percent_occurrences,ignored,updated_at]Default:
updated_atExample:
check_nameThe direction to sort with. If omitted, sorting attribute descending is applied
Allowable values: [
asc,desc]Default:
descExample:
asc
Response
A collection of data quality issues.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality issues.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality issues.
An error occurred. The list of data quality issues cannot be returned.
{"total_count":1,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v4/issues?limit=200"},"issues":[{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd4382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","nativeId":"739e06f8-3gk2-4c4u-8ab7-e5682g06f05a"},"number_of_occurrences":123,"number_of_tested_records":456789,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
Data quality issue to create.
Example: {"check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a"},"number_of_occurrences":123,"number_of_tested_records":456789,"status":"actual","ignored":false}
the check that produces this issue
- check
The Id of the asset on which this issue was found
- reported_for
Flag indicating whether the issue is ignored or not.
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223The absolute number of occurrences of the issues which have been identified on the asset. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
123The total number of records which have been tested by the Data Quality Check. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
456789The relative frequency of the issue (percentage of tested records having the issue), as a number between 0.0 and 1.0. If omitted, it is calculated using number_of_occurrences and number_of_tested_records.
Possible values: 0 ≤ value ≤ 1
The status of the issue.
Allowable values: [
actual,aggregation]Default:
actualExample:
actual
Response
A data quality issue, i.e. a data quality problem detected during a check.
the check that produces this issue
- check
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
The Id of the asset on which this issue was found
- reported_for
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Flag indicating whether the issue is ignored or not.
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223The absolute number of occurrences of the issues which have been identified on the asset. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
123The total number of records which have been tested by the Data Quality Check. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
456789The relative frequency of the issue (percentage of tested records having the issue), as a number between 0.0 and 1.0. If omitted, it is calculated using number_of_occurrences and number_of_tested_records.
Possible values: 0 ≤ value ≤ 1
The status of the issue.
Possible values: [
actual,aggregation,archive]Example:
actual
Status Code
Success
The given payload is invalid and the issue is not created.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create a data quality issue.
The data quality issue exists already and cannot be created.
An error occurred. The data quality issue cannot be created.
{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","created_at":"2022-02-02T14:00:45.000Z","creator_id":"SYSTEM"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a"},"number_of_occurrences":123,"number_of_tested_records":456789,"status":"actual","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"6vbjp9d2t4s9b2ckyspdw4vft","status_code":400,"errors":[{"code":"missing_required_field","message":"Bad Request: {\"trace\":\"8f7b7693-1f08-4b4a-b2bd-5732d06ad19e\", \"errors\":[{\"code\":\"invalid_parameter\", \"message\":\"COMSV3006E: Missing or Invalid asset id\", \"target\":{\"name\":\"asset\",\"type\":\"parameter\"}}]}"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"28izpw5l1a4orh823i6bkqmm","status_code":409,"errors":[{"code":"already_exists","message":"The dimension with name 'Completeness' already exists."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Get the data quality issue with the given identifier
Get the data quality issue with the given identifier.
GET /data_quality/v4/issues/{id}Request
Path Parameters
The data quality issue identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
Response
A data quality issue, i.e. a data quality problem detected during a check.
the check that produces this issue
- check
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
The Id of the asset on which this issue was found
- reported_for
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Flag indicating whether the issue is ignored or not.
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223The absolute number of occurrences of the issues which have been identified on the asset. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
123The total number of records which have been tested by the Data Quality Check. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
456789The relative frequency of the issue (percentage of tested records having the issue), as a number between 0.0 and 1.0. If omitted, it is calculated using number_of_occurrences and number_of_tested_records.
Possible values: 0 ≤ value ≤ 1
The status of the issue.
Possible values: [
actual,aggregation,archive]Example:
actual
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the data quality issue.
The data quality issue with the given ID cannot be found.
An error occurred. The data quality issue cannot be returned.
{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","created_at":"2022-02-02T14:00:45.000Z","creator_id":"SYSTEM"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a"},"number_of_occurrences":123,"number_of_tested_records":456789,"status":"actual","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Update a data quality issue as specified in the payload details of the request.
Update a data quality issue as specified in the payload details of the request.
The updates must be specified by using the JSON patch format, described in RFC 6902.
The following attributes can be updated: - /ignored (value can only be replaced)
PATCH /data_quality/v4/issues/{id}Request
Path Parameters
The data quality issue identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The updates to make in the data quality rule.
Example: [{"op":"replace","path":"/description","value":"The proportion of data stored against the potential for 100% of the data."}]
The operation to be performed
Allowable values: [
add,remove,replace,move,copy,test]A JSON pointer to the field to update
A string containing a JSON pointer value
- value
Response
A data quality issue, i.e. a data quality problem detected during a check.
the check that produces this issue
- check
Name of a data quality resource.(Name need not be unique)
Possible values: 1 ≤ length ≤ 200
Example:
check_uniqueness_of_idUnique identifier set by the creator of the resource
Possible values: 1 ≤ length ≤ 500
Example:
4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47The type of the data quality resource
Possible values: 1 ≤ length ≤ 200
Example:
data_ruleThe optional eventual children of this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
An optional list of issues reported by this data quality check.
Possible values: 0 ≤ number of items ≤ 100000
- issues
the dimension this check belongs to
- dimension
Flag indicating whether the dimension is a built-in dimension or not.
The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The Id of an eventual parent, or null if this check has no parent
- parent
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223
The Id of the asset on which this issue was found
- reported_for
Resource identifier.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5
Flag indicating whether the issue is ignored or not.
Link to corresponding data quality component. No default link is available, it is empty if not provided.
Possible values: 1 ≤ length ≤ 500
Example:
/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223The absolute number of occurrences of the issues which have been identified on the asset. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
123The total number of records which have been tested by the Data Quality Check. If this is missing, percent_occurrences must be provided.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
456789The relative frequency of the issue (percentage of tested records having the issue), as a number between 0.0 and 1.0. If omitted, it is calculated using number_of_occurrences and number_of_tested_records.
Possible values: 0 ≤ value ≤ 1
The status of the issue.
Possible values: [
actual,aggregation,archive]Example:
actual
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to update the data quality issue.
The data quality issue with the given ID cannot be found.
An error occurred. The data quality issue cannot be updated.
{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","created_at":"2022-02-02T14:00:45.000Z","creator_id":"SYSTEM"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a"},"number_of_occurrences":123,"number_of_tested_records":456789,"status":"actual","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Search for a data quality issue by its native id
Search for a data quality issue by its native id
POST /data_quality/v4/search_dq_issue
Request
Query Parameters
The data quality asset identifier
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The data quality check identifier to search issues of.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
Response
A data quality issue, i.e. a data quality problem detected during a check on a given asset.
An array of previous data quality issues detected during the same check on the given asset.
Possible values: 0 ≤ number of items ≤ 100
An array of data quality issues detected during the same check on children of the given asset.
Possible values: 0 ≤ number of items ≤ 10000
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to search data quality issues.
The data quality issue cannot be found.
An error occurred. The data quality issue cannot be searched.
{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","created_at":"2022-02-02T14:00:45.000Z","creator_id":"SYSTEM"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a"},"number_of_occurrences":123,"number_of_tested_records":456789,"status":"actual","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z","archived_issues":[{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","created_at":"2022-02-02T14:00:45.000Z","creator_id":"SYSTEM"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a"},"number_of_occurrences":123,"number_of_tested_records":456789,"status":"archive","creator_id":"SYSTEM","created_at":"2022-02-01T14:00:45.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cfkvi16tv9bimp2rqve666na0","status_code":404,"errors":[{"code":"not_found","message":"Requested resource was not found.","more_info":"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data","target":{"type":"field","name":"name"}}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Create several data quality issues
Create several data quality issues. The related DQ assets referenced by their native ID are created if they do not already exist.
POST /data_quality/v4/create_issues
Request
Query Parameters
The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
If true, the assets will be refreshed, and any assets not present in the updated list will be deleted from the database. If false, no action will be taken.
Default:
false
Data quality issues to create and their related DQ assets.
Example: {"issues":[{"check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b"},"reported_for":{"native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","type":"profile"},"number_of_occurrences":123,"number_of_tested_records":456789,"ignored":false}],"assets":[{"name":"CUSTOMERS","type":"data_asset","native_id":"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702","weight":1}],"existing_checks":[{"id":"6be18374-573a-4cf8-8ab7-e428506e428b"}]}
list of issues to create.
Possible values: 0 ≤ number of items ≤ 100000
Optional list of assets to create. For each of these assets the system will check if an asset with the same native_id exists. If yes, it will ignore it, if not it will create it
Possible values: 0 ≤ number of items ≤ 100000
Optional list of existing checks. For each pair of (asset, check) given, system will create, update or remove an issue depending on the current issue stored for this pair and the new issue given in the payload (or not for deletion).
Possible values: 0 ≤ number of items ≤ 100000
- existing_checks
Response
A collection of data quality issues.
The maximum number of resources to return.
Possible values: 1 ≤ value ≤ 200
Example:
20Total number of resources available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100The link to a page in paginated collection.
An array of data quality issues.
Possible values: 1 ≤ number of items ≤ 200
The link to a page in paginated collection.
The link to a page in paginated collection.
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to create data quality issues.
An error occurred. The data quality issues cannot be created.
{"total_count":1,"limit":200,"first":{"href":"https://cloud.ibm.com/data_quality/v4/issues?limit=200"},"issues":[{"id":"046605b5-48d9-489e-b846-8ef96a7a1aba","check":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"MY_RULE","native_id":"cdcd4382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47","type":"ANY","creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"reported_for":{"id":"894d01fd-bdfc-4a4f-b68b-62751e06e06a","nativeId":"739e06f8-3gk2-4c4u-8ab7-e5682g06f05a"},"number_of_occurrences":123,"number_of_tested_records":456789,"creator_id":"SYSTEM","created_at":"2022-02-02T10:51:02.000Z"}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
Get a list of data quality scores for a given asset
Get a list of data quality scores for a given asset.
GET /data_quality/v4/scores
Request
Query Parameters
The data quality asset identifier
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5The ID of the catalog to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The ID of the project to use. A catalog_id or project_id is required.
Possible values: 1 ≤ length ≤ 100
The data quality dimension identifier. If not provided, filtering on dimension is not applied.
Possible values: 1 ≤ length ≤ 128
Example:
b1ba1d22-71a7-4adf-99b2-3c8ba19497f5If true include the children in the returned resource. If false, only return the resource without its eventual children.
Default:
falseQuery for scores older than the given number of days
Possible values: 0 ≤ value ≤ 10000
Default:
0
Response
A collection of data quality scores.
Total number of scores available.
Possible values: 0 ≤ value ≤ 9007199254740991
Example:
100Information of asset.
An array of data quality scores.
Possible values: 1 ≤ number of items ≤ 200
An array of data quality scores.
Possible values: 1 ≤ number of items ≤ 200
Status Code
Success.
Your authorization to access this method is missing, invalid, or expired.
You do not have permission to get the list of data quality scores.
An error occurred. The list of data quality scores cannot be returned.
{"total_count":100,"asset":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"CUSTOMERS"},"scores":[{"status":"actual","score":0.8,"number_of_checks":1,"timestamp":"2022-02-14T18:11:02Z","dimension_scores":[{"dimension":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"COMPLETENESS","description":"Dimension related to completeness","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.4,"timestamp":"2022-02-14T18:11:02Z"},{"dimension":{"id":"7be18374-573a-4cf8-8ab7-e428506e428b","name":"ACCURACY","description":"Dimension related to accuracy","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.7,"timestamp":"2022-02-13T18:11:02Z"}]},{"status":"archive","score":0.6,"number_of_checks":2,"timestamp":"2022-02-12T18:11:02Z","dimension_scores":[{"dimension":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"COMPLETENESS","description":"Dimension related to completeness","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.23,"timestamp":"2022-02-12T18:11:02Z"}]},{"status":"archive","score":0.7,"number_of_checks":2,"timestamp":"2022-02-11T18:11:02Z","dimension_scores":[{"dimension":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"COMPLETENESS","description":"Dimension related to completeness","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.23,"timestamp":"2022-02-11T18:11:02Z"}]}],"children":[{"asset":{"id":"5be18374-573a-4cf8-8ab7-e428506e428b","name":"ID"},"scores":[{"status":"actual","score":0.8,"number_of_checks":1,"timestamp":"2022-02-14T18:11:02Z","dimension_scores":[{"dimension":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"COMPLETENESS","description":"Dimension related to completeness","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.4,"timestamp":"2022-02-14T18:11:02Z"}]},{"status":"archive","score":0.6,"number_of_checks":1,"timestamp":"2022-02-12T18:11:02Z","dimension_scores":[{"dimension":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"COMPLETENESS","description":"Dimension related to completeness","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.23,"timestamp":"2022-02-12T18:11:02Z"}]},{"status":"archive","score":0.7,"number_of_checks":1,"timestamp":"2022-02-11T18:11:02Z","dimension_scores":[{"dimension":{"id":"6be18374-573a-4cf8-8ab7-e428506e428b","name":"COMPLETENESS","description":"Dimension related to completeness","is_default":false,"creator_id":"SYSTEM","created_at":"2022-02-02T14:00:45.000Z"},"score":0.23,"timestamp":"2022-02-11T18:11:02Z"}]}]}]}{"trace":"3tirwt88tsejqwh801zw88lek","status_code":403,"errors":[{"code":"not_authorized","message":"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE."}]}{"trace":"cwuhtyfus0m8f6e49e2g6m4hr","status_code":500,"errors":[{"code":"internal_error","message":"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'."}]}
retrieve a governanceType
Retrieves detailed information on a governance type. This includes all of the operations defined for the governance type and the allowed and default outcomes of each operation.
GET /v3/enforcement/governance_types/{governance_type_name}Response
Response for the /v3/enforcement/governance_types/{governanceTypeId} API
metadata object for policy API responses that have no metadata
entity object within the response for the /v3/enforcement/governance_types/{governanceTypeId} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
No Sample Response
create user defined left hand side term
Create a left hand side term to be used in rules defined in the policy engine.
POST /v3/enforcement/lhs/udp
Request
LHS RuleTerm JSON
Name of the custom LHS.
Display name of the custom LHS.
Property name of the LHS references. For Asset properties, use the path of the property in asset json. For user property, use the name of the mapped User SCIM attribute. (Custom user predicates are not supported in CPDaaS).
Source for the LHS reference. For custom asset predicate, use 'ASSET'. For custom user predicate use 'CONTEXTUAL' (Custom user predicates are not supported in CPDaaS).
Allowable values: [
ASSET, CONTEXTUAL]Description of the custom LHS.
Response
Response for the /v3/enforcement/udp/{termName} API
metadata object used in responses returned from policy management related APIs
entity object within the response for the /v3/enforcement/udp/{termName} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
No Sample Response
get a user defined left hand side term
Get the user defined left hand side term in the term cache of the policy engine.
GET /v3/enforcement/lhs/udp/{lhsTermId}Response
Response for the /v3/enforcement/udp/{termName} API
metadata object used in responses returned from policy management related APIs
entity object within the response for the /v3/enforcement/udp/{termName} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
No Sample Response
delete a user defined left hand side term
Delete a left hand side term in the term cache of the policy engine. This cache is maintained for performance and is used for evaluating policies. It is refreshed periodically from technical terms maintained in the glossary.
DELETE /v3/enforcement/lhs/udp/{lhsTermId}retrieve and aggregate policy related metrics
This API retrieves policy enforcement metrics based on query parameters, which include metric type, date range, policy, user, rule, governanceType, outcome, host type, cached, context operation, context location, asset type and asset location. It then sums these metrics according to a specified aggregation type.
GET /v3/enforcement/policy_metrics/analysis/3d
Request
Query Parameters
The type of metrics to return
Allowable values: [
enforcements,denials,operational_policies,operational_rules]The type of aggregation to perform on the selected metrics (days, months, years, policies, rules, users, governanceTypes, outcomes)
Allowable values: [
days,months,years,policies,rules,users,outcomes,governance_type,pep_host_types,is_pep_cache,context_operations,context_locations,asset_types,asset_locations]The type of aggregation to perform on the selected metrics (days, months, years, policies, rules, users, governanceTypes, outcomes)
Allowable values: [
days,months,years,policies,rules,users,outcomes,governance_type,pep_host_types,is_pep_cache,context_operations,context_locations,asset_types,asset_locations]ISO 8601 date/time specifying the starting time to return metrics data
ISO 8601 date/time specifying the ending time to return metrics data
The policy to return metrics of, or all policies if not specified
The rule to return metrics of, or all rules if not specified
The user to return metrics about, or all users if not specified
The governanceType to return metrics about, or all governanceTypes if not specified
Allowable values: [
Access,Classification,Curation,Lifecycle,ResourceControl,DMR,AIGovernance,DLR]The enforcement outcome to return metrics about, or all outcomes if not specified
The PEP host type to return metrics about, or all PEP host types if not specified
Metrics on decisions retrieved from cache versus from server, or both if not specified
The context operation to return metrics about, or all context operations if not specified
The context location to return metrics about, or all context locations if not specified
The asset type to return metrics about, or all asset types if not specified
The asset location to return metrics about, or all asset locations if not specified
The order to sort the metrics. The following values are allowed:
- aggregate, -aggregate -- ascending or descending order by the aggregate
- count, -count -- ascending or descending order by enforcement count
retrieve and aggregate policy related metrics
This API retrieves policy enforcement metrics based on query parameters, which include metric type, date range, policy, user, rule, governanceType, outcome, host type, cached, context operation, context location, asset type and asset location. It then sums these metrics according to a specified aggregation type.
GET /v3/enforcement/policy_metrics
Request
Query Parameters
The type of metrics to return
Allowable values: [
enforcements,denials,operational_policies,operational_rules]The type of aggregation to perform on the selected metrics (days, months, years, policies, rules, users, governanceTypes, outcomes)
Allowable values: [
days,months,years,policies,rules,users,outcomes,governance_type,pep_host_types,is_pep_cache,context_operations,context_locations,asset_types,asset_locations]ISO 8601 date/time specifying the starting time to return metrics data
ISO 8601 date/time specifying the ending time to return metrics data
The policy to return metrics of, or all policies if not specified
The rule to return metrics of, or all rules if not specified
The user to return metrics about, or all users if not specified
The governanceType to return metrics about, or all governanceTypes if not specified
Allowable values: [
Access,Classification,Curation,Lifecycle,ResourceControl,DMR,AIGovernance,DLR]The enforcement outcome to return metrics about, or all outcomes if not specified
The PEP host type to return metrics about, or all PEP host types if not specified
Metrics on decisions retrieved from cache versus from server, or both if not specified
The context operation to return metrics about, or all context operations if not specified
The context location to return metrics about, or all context locations if not specified
The asset type to return metrics about, or all asset types if not specified
The asset location to return metrics about, or all asset locations if not specified
The order to sort the metrics. The following values are allowed:
- aggregate, -aggregate -- ascending or descending order by the aggregate
- count, -count -- ascending or descending order by enforcement count
create a custom role
Creates a cusotm role. This will include a list of existing permissions to be associated with the role. Maximum length allowed for 'name' parameter: 80 characters, maximum length allowed for 'description' parameter: 1000 characters. Allowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter).
POST /v3/enforcement/roles
update a custom category role
Updates a custom category role. This API is also used to add and remove permissions from the custom category role. The permissions should be passed as an array of string that has permissions ids.Maximum length allowed for 'name' parameter: 80 characters, maximum length allowed for 'description' parameter: 1000 characters. If the parameter 'name' is modified, allowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter).
PUT /v3/enforcement/roles/{role_id}Sync a rule
Syncs a rule in DPS with its global search index. If rule is found in DPS, its global search index is updated. If rule is not found in DPS, its global search index is removed.
PUT /v3/enforcement/rules/sync/{rule_id}Response
Response for the /v3/enforcement/rules/{ruleId} API
metadata object used in responses returned from policy management related APIs
entity within the response for the /v3/enforcement/rules/{ruleId} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No Sample Response
retrieve a rule
Retrieves detailed information on a rule given the rule's identifier.
GET /v3/enforcement/rules/{rule_id}Response
Response for the /v3/enforcement/rules/{ruleId} API
metadata object used in responses returned from policy management related APIs
entity within the response for the /v3/enforcement/rules/{ruleId} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No Sample Response
update a rule
Updates a rule. Maximum length allowed for 'name' parameter: 80 characters, maximum length allowed for 'description' parameter: 1000 characters. If the parameter 'name' is modified, allowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter). The governance_type_id cannot be modified.
PUT /v3/enforcement/rules/{rule_id}Request
Path Parameters
Rule ID
Rule json
the displayed name for the rule
the name of a governance type of this rule
nested arrays representing an expression that is evaluated to determine if the action on the rule should be performed or enforced. See the description on the POST /v3/enforcement/rules for more details.
the action to perform or enforce when the rule triggers
a more detailed description of the rule
the state of the rule. Only the rules of policies in active are enforced.
Allowable values: [
draft,active,archived]
Response
Response for the /v3/enforcement/rules/{ruleId} API
metadata object used in responses returned from policy management related APIs
entity within the response for the /v3/enforcement/rules/{ruleId} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No Sample Response
list all rules
Lists all defined rules. This includes all rules associated with policies and rules not associated with any policy. When more than one filter criteria is specified, the resulting collection satisfies all the criteria.
GET /v3/enforcement/rules
Request
Query Parameters
Specify name of the rule to search for or use filter of the form 'contains:xx' to search for rules containing provided phrase as part of name or use filter of the form 'exact:xx' to search for rules with exact name.
Specify description of the rule to search for or use filter of the form 'contains:xx' to search for rules containing provided phrase as part of description.
If specified, only rules with a matching trigger expression will be returned.
If specified, only rules with a matching action will be returned.
If specified, only rules in the matching state will be returned.
Allowable values: [
draft,active,archived]If speficied, only rules with the matching governance type/types will be returned.
The order to sort the rules. The following values are allowed:
- name, -name -- ascending or descending order by the name
- modified_date, -modified_date -- ascending or descending order by modified date
Allowable values: [
name,-name,modified_date,-modified_date]The maximum number of Rules to return. The default value is 50.
Default:
50The index of the first matching Rule to include in the result. The default value is 0.
Default:
0
Response
Response for the /v3/enforcement/rules API
the limit as specified on the query or defaulted
the offset as specified on the query or the default value 0
total number of resources in the collection
link to the previous page of resources, if available
link to the previous page of resources, if available
link to the previous page of resources, if available
link to the previous page of resources, if available
list of rules
Status Code
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
No Sample Response
create a rule
Creates a rule. A rule has two key properties:
- a trigger defining when the rule should be enforced, and
- an action describing what operations to perform or outcome to enforce.
Trigger
A trigger is a boolean expression represented using nested arrays. The following describes the syntax:
Expression:
[ -conditions- ]
Conditions:
-predicate-
"NOT", -predicate-
-predicate-, "AND"|"OR", -conditions-
"NOT", -predicate-, "AND"|"OR", -conditions-
Predicate:
[ "$-term-", "EXISTS" ]
[ "$-term-", "EQUALS"|"LESS_THAN"|"GREATER_THAN"|"CONTAINS", "#-literal-"|"$-term-" ]
-expression-
where:
- -term- is a technical term defined in the term glossary.
- -literal- is a literal. For numerics a string representation of the number should be specified. For times, milliseconds are used (from Unix epoch). For boolean, #true and #false are used.
The definition of the operators in a predicate:
- EXISTS -- means that the term has a value of some kind.
- EQUALS -- evaluates to true if the left and right sides are equal.
- LESS_THAN -- evaluates to true if the left is less in numeric value than the right.
- GREATER_THAN -- evaluates to true if the left is greater in numeric value than the right.
- CONTAINS -- is meant to test an array term (such as Asset.Tags) with a single value. It evaluates to true if the value on the right side equals one of the values on the array on the left side.
However it will also supports a single value on the left, in which case it behaves just like EQUALS -- regular expressions or wildcards are not supported.
For all of the operators (except EXISTS), if the right hand side evaluates to an array, each value of the array is compared to the left side, according to the operator definition, and if any comparison is true then the result of the evaluation is true.
Examples:
[["$Asset.Type", "EQUALS", "#Project"]]
["NOT", ["$Asset.Tags", "CONTAINS", "#sensitive"], "AND", ["NOT", "$Asset.Tags", "CONTAINS", "#confidential"]]
[["$User.Name", "EQUALS", "$Asset.Owner"]]
Action
The action is an name with optional parameters or subaction describing an operation to perform. For simple actions like Deny, only the action name will be provided. For actions such as Transform, a subaction with parameters describing the type of transform is also provided. The allowed actions depends on the governance type.
Examples:
{"name": "Deny"}
{"name": "Transform", "subaction": {"name": "anonymizeColumns", "parameters": [{"name": "column_name", "value": "CCN"}]}}
The maximum length allowed for 'name' parameter is 80 characters, maximum length allowed for 'description' parameter: 1000 characters. Allowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter).
POST /v3/enforcement/rules
Request
Rule json
the displayed name for the rule
the name of a governance type of this rule
nested arrays representing an expression that is evaluated to determine if the action on the rule should be performed or enforced. See the description on the POST /v3/enforcement/rules for more details.
the action to perform or enforce when the rule triggers
a more detailed description of the rule
the state of the rule. Only the rules of policies in active are enforced.
Allowable values: [
draft,active,archived]
Response
Response for the /v3/enforcement/rules/{ruleId} API
metadata object used in responses returned from policy management related APIs
entity within the response for the /v3/enforcement/rules/{ruleId} API
Status Code
Merged with an existing 'ResourceControl' rule.
Created
Bad Request
Unauthorized
Forbidden
Internal Server Error
No Sample Response
export all rules
Export all defined rules as JSON.This includes all rules associated with policies and rules not associated with any policy.
GET /v3/enforcement/rules/export
Request
Query Parameters
The maximum number of Rules to return. The default value is 50.
Default:
50The index of the first matching Rule to include in the result. The default value is 0.
Default:
0For export between two different systems. If specified as true, the ids in rules will be converted to names and added as export_components in the exported file
Default:
false
import rules
Imports rules using content recieved as application/octet-stream media type. Assumes content to be in UTF-8 charset. Expects "rules" JSON array contained in a JSON objects. Ignores other fields. Rule GUID is prerserved. Retruns JSON array containing GUIDs of newly imported rules.
POST /v3/enforcement/rules/import
Request
Query Parameters
For import between two different systems. If specified as true, the names in export_components of the import file will be matched and converted to the target system's ids.
Default:
falseFor external imports, if specified as true, the whole import will fail if there are any rules that fail to match ids in the target system. If specified as false, an analysis report will be returned.
Default:
false
The input stream for reading imported terms
Response
Response for the /v3/enforcement/rules/export API and /v3/enforcement/rules/import
List containing details of rules that are successfully imported.
List containing details of rules that are failed to import.
List containing details of rules that are successfully matched.
Status Code
OK
Bad Request
Unauthorized
Forbidden
Content cannot be more than 1MB
Internal Server Error
No Sample Response
retrieve tenant settings
Retrieves governance information and settings about a particular tenant given the tenant identifier.
GET /v3/enforcement/settings
Response
Response for the /v3/enforcement/settings/{tenantId} API
metadata object used in responses returned from policy management related APIs
entity object within the response for the /v3/enforcement/settings/{tenantId} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No Sample Response
update tenant settings
Updates governance information and settings for the given tenant.
PUT /v3/enforcement/settings
Request
governedTenant json
Data protection rules convention. Choose DEAA for 'Locked' convention and AEAD for 'Unlocked' convention.
Allowable values: [
DEAA, AEAD]Data location rules convention. Choose DEAA for 'Locked' convention and AEAD for 'Unlocked' convention.
Allowable values: [
DEAA, AEAD]Default sovereignty to assign to assets if sovereignty is missing in data assets.
Enable data location rules enforcement.
Oldest - by creation date, Latest - by modified date, columns, Merge - merge annotations (terms and tags) of all aliases
Allowable values: [
Oldest, Latest, Merge]The rule action precedence for data protection rules. The actions, in order of leniency, are: Allow access, Mask and Filter, Deny access.
Allowable values: [
RESTRICTIVE, PERMISSIVE, HIERARCHICAL]The rule action precedence for data location rules. The actions, in order of leniency, are: Allow access, Mask and Filter, Deny access.
Allowable values: [
RESTRICTIVE, PERMISSIVE]The masking method precedence for data protection rules. The masking methods, in privacy order, are: Redact, Substitute, Obfuscate. The masking methods, in utility order, are: Obfuscate, Substitute, Redact.
Allowable values: [
RESTRICTIVE, PERMISSIVE]The masking method precedence for data location rules. The masking methods, in privacy order, are: Redact, Substitute, Obfuscate. The masking methods, in utility order, are: Obfuscate, Substitute, Redact.
Allowable values: [
RESTRICTIVE, PERMISSIVE]enable/disable business glossary terms inheritance for DPR/DLR enforcement
enable/disable dataclass terms inheritance for DPR/DLR enforcement
enable/disable classification terms inheritance for DPR/DLR enforcement
enable/disable business glossary term 1 level synonym relationship for DPR/DLR enforcement
Enable evaluation based on asset's lineage
This flag indicates if transform deep enforcement process using 'advanced' or 'classic'. The default value is advanced.
Allowable values: [
advanced, classic]Maximum combined number of DPR and DLR rules supported.
Enable/disable audit log for evaluation
Allowable values: [
false]
Response
Response for the /v3/enforcement/settings/{tenantId} API
metadata object used in responses returned from policy management related APIs
entity object within the response for the /v3/enforcement/settings/{tenantId} API
Status Code
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No Sample Response
Create a metadata enrichment area asset
Creates a new metadata enrichment asset and the corresponding job definition. If a data scope is provided the decoration of data scope assets will be started in background and the response will contain the execution ID of that background process. After background processing has finished a RabbitMQ event is sent to CAMS topic exchange CatalogServiceMessageHub with topic v2.metadata_enrichment.{mdeAreaId}.create_enrichment_area and message body as described in model RabbitMqNotificationMessage. If no data scope is provided an empty enrichment area is created without starting a background decoration task. In that case the field asyncExecutionInfo will be missing in the response. If query paramter enrichImmediate is true, which is the default setting, and the data scope is not empty a new enrichment job run will be triggered automatically.
POST /v2/metadata_enrichment/metadata_enrichment_area
Request
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
should enrichment be run immediately after area creation
Default:
true
Object containing information for creating a metadata enrichment area asset
name of the metadata enrichment asset
Example:
Sample enrichment- objective
- enrichment_options
- structured
true if profile is enabled for structured data. Required when creating and optional when updating.
true if assign terms is enabled for structured data. Required when creating and optional when updating.
true if analyze quality is enabled for structured data. Required when creating and optional when updating.
- unstructured
always true as profile is always enabled for unstructured data
true if assign terms is enabled for unstructured data
Required when creating and optional when updating.
- sampling
- structured
Set true to apply project level default settings to this metadata enrichment area.
Sampling method for this metadata enrichment area. The value is respected when project_default_settings is false. Possible values: [TOP, top, RANDOM, random]
Example:
topAnalysis method to use when sampling data. Either sample a
fixednumber of rows or a givenpercentageof all table rows. The value is respected when project_default_settings is false. Providing this attribute is optional, if not specified, the analysis method defaults tofixed. Possible values: [FIXED, fixed, PERCENTAGE, percentage]Example:
fixed- sample_size
Allowable values: [
BASIC,COMPREHENSIVE,CUSTOM,MODERATE,BASIC, MODERATE, COMPREHENSIVE, CUSTOM]- options
Enrich top # of rows / table.
Example:
100Classify based on # values / column.
Example:
10
- percentage_options
Percentage of rows to enrich, as decimal
Example:
0.8Minimum number of rows to include in sampling
Example:
100Maximum number of rows to include in sampling
Example:
100Classify based on # values/columns.
Example:
10
- unstructured
sampling method
Allowable values: [
RANDOM]- sample_size
Allowable values: [
BASIC,COMPREHENSIVE,MODERATE,BASIC, MODERATE, COMPREHENSIVE]
Data scope of reruns. Possible values: [DELTA, delta, ALL, all]
Example:
delta
description of the metadata enrichment area asset
Example:
This is a description for my sample metadata enrichment.Id of the catalog to metadata enrichment area assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5- job
Name of the metadata enrichment job
Example:
My Enrichment JobA cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.
Example:
0 3 21 13 1 ? 2019- schedule_info
Indicate a repeated job
Example:
trueA timestamp in epoch time, the scheduled job will be triggered after this timestamp.
Example:
1547578689512A timestamp in epoch time, the scheduled job will be triggered before this timestamp.
Example:
1547578689512
- publish_job
Id of the metadata publish job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the MDE area publish job
Example:
My MDE area publish JobA cron string defining when the job should be run. This is going to be always empty as publish is not scheduled to run.
- data_scope
IDs of assets to enrich metadata
- container_assets
list of tags
Response
An object containing information about a metadata enrichment area asset
- metadata
The metadata enrichment area id assigned by the system. Read-only
Example:
4412e9b2-3661-11e7-a919-92ebcb67fe33The type of the asset
Example:
metadata_enrichment_areaThe IAM ID of the user that created the asset
Example:
IBMid-550000FRA0Timestamp representing creation datetime of metadata enrichment area asset read-only
Example:
1631089384058The ID of the project which contains the asset.
Example:
487084de-de8d-4981-9205-952732a90b3d- usage
Example:
2019-01-15T18:58:09ZExample:
IBMid-550000FRA0Example:
1547578689512Example:
2019-01-15T18:58:09ZExample:
1547578689512Example:
IBMid-550000FRA0
list of tags
- entity
name of the metadata enrichment area asset
Example:
my_enrichmentdescription of the metadata enrichment area asset
Example:
Enrichment of assetsId of the catalog to metadata enrichment area assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5- job
Id of the metadata enrichment job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the metadata enrichment job
Example:
My Enrichment JobA cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.
Example:
0 3 21 13 1 ? 2019- schedule_info
Indicate a repeated job
Example:
trueA timestamp in epoch time, the scheduled job will be triggered after this timestamp.
Example:
1547578689512A timestamp in epoch time, the scheduled job will be triggered before this timestamp.
Example:
1547578689512
- data_asset_summary
- structured
Number of structured data assets
Example:
1203
- unstructured
Number of unstructured data assets
Example:
890
- objective
- enrichment_options
- structured
true if profile is enabled for structured data. Required when creating and optional when updating.
true if assign terms is enabled for structured data. Required when creating and optional when updating.
true if analyze quality is enabled for structured data. Required when creating and optional when updating.
- unstructured
always true as profile is always enabled for unstructured data
true if assign terms is enabled for unstructured data
Required when creating and optional when updating.
- sampling
- structured
Set true to apply project level default settings to this metadata enrichment area.
Sampling method for this metadata enrichment area. The value is respected when project_default_settings is false. Possible values: [TOP, top, RANDOM, random]
Example:
topAnalysis method to use when sampling data. Either sample a
fixednumber of rows or a givenpercentageof all table rows. The value is respected when project_default_settings is false. Providing this attribute is optional, if not specified, the analysis method defaults tofixed. Possible values: [FIXED, fixed, PERCENTAGE, percentage]Example:
fixed- sample_size
Possible values: [
BASIC,COMPREHENSIVE,CUSTOM,MODERATE,BASIC, MODERATE, COMPREHENSIVE, CUSTOM]- options
Enrich top # of rows / table.
Example:
100Classify based on # values / column.
Example:
10
- percentage_options
Percentage of rows to enrich, as decimal
Example:
0.8Minimum number of rows to include in sampling
Example:
100Maximum number of rows to include in sampling
Example:
100Classify based on # values/columns.
Example:
10
- unstructured
sampling method
Possible values: [
RANDOM]- sample_size
Possible values: [
BASIC,COMPREHENSIVE,MODERATE,BASIC, MODERATE, COMPREHENSIVE]
Data scope of reruns. Possible values: [DELTA, delta, ALL, all]
Example:
delta
The status of the MDE area. Possible values: [READY, ready, UPDATING, updating, DELETING, deleting, DELETION_PENDING, deletion_pending, FAILED, failed]
Example:
ready- publish_job
Id of the metadata publish job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the MDE area publish job
Example:
My MDE area publish JobA cron string defining when the job should be run. This is going to be always empty as publish is not scheduled to run.
- data_scope_processing
Example:
1631089384058If not null, retries after this interval in millisecond.
Example:
8000Error messages while setting data scope
Status Code
Success
Unauthorized
Forbidden
Error
No Sample Response
Retrieve metadata enrichment settings
Retrieve metadata enrichment settings
GET /v2/metadata_enrichment/metadata_enrichment_area/settings
Create or update metadata enrichment settings
Create or update metadata enrichment settings
PUT /v2/metadata_enrichment/metadata_enrichment_area/settings
Retrieve details of a Metadata Enrichment Area asset
Retrieve details of a metadata enrichment area asset
GET /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}Request
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
whether to include data asset count summary in the response
Default:
false
Response
An object containing information about a metadata enrichment area asset
- metadata
The metadata enrichment area id assigned by the system. Read-only
Example:
4412e9b2-3661-11e7-a919-92ebcb67fe33The type of the asset
Example:
metadata_enrichment_areaThe IAM ID of the user that created the asset
Example:
IBMid-550000FRA0Timestamp representing creation datetime of metadata enrichment area asset read-only
Example:
1631089384058The ID of the project which contains the asset.
Example:
487084de-de8d-4981-9205-952732a90b3d- usage
Example:
2019-01-15T18:58:09ZExample:
IBMid-550000FRA0Example:
1547578689512Example:
2019-01-15T18:58:09ZExample:
1547578689512Example:
IBMid-550000FRA0
list of tags
- entity
name of the metadata enrichment area asset
Example:
my_enrichmentdescription of the metadata enrichment area asset
Example:
Enrichment of assetsId of the catalog to metadata enrichment area assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5- job
Id of the metadata enrichment job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the metadata enrichment job
Example:
My Enrichment JobA cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.
Example:
0 3 21 13 1 ? 2019- schedule_info
Indicate a repeated job
Example:
trueA timestamp in epoch time, the scheduled job will be triggered after this timestamp.
Example:
1547578689512A timestamp in epoch time, the scheduled job will be triggered before this timestamp.
Example:
1547578689512
- data_asset_summary
- structured
Number of structured data assets
Example:
1203
- unstructured
Number of unstructured data assets
Example:
890
- objective
- enrichment_options
- structured
true if profile is enabled for structured data. Required when creating and optional when updating.
true if assign terms is enabled for structured data. Required when creating and optional when updating.
true if analyze quality is enabled for structured data. Required when creating and optional when updating.
- unstructured
always true as profile is always enabled for unstructured data
true if assign terms is enabled for unstructured data
Required when creating and optional when updating.
- sampling
- structured
Set true to apply project level default settings to this metadata enrichment area.
Sampling method for this metadata enrichment area. The value is respected when project_default_settings is false. Possible values: [TOP, top, RANDOM, random]
Example:
topAnalysis method to use when sampling data. Either sample a
fixednumber of rows or a givenpercentageof all table rows. The value is respected when project_default_settings is false. Providing this attribute is optional, if not specified, the analysis method defaults tofixed. Possible values: [FIXED, fixed, PERCENTAGE, percentage]Example:
fixed- sample_size
Possible values: [
BASIC,COMPREHENSIVE,CUSTOM,MODERATE,BASIC, MODERATE, COMPREHENSIVE, CUSTOM]- options
Enrich top # of rows / table.
Example:
100Classify based on # values / column.
Example:
10
- percentage_options
Percentage of rows to enrich, as decimal
Example:
0.8Minimum number of rows to include in sampling
Example:
100Maximum number of rows to include in sampling
Example:
100Classify based on # values/columns.
Example:
10
- unstructured
sampling method
Possible values: [
RANDOM]- sample_size
Possible values: [
BASIC,COMPREHENSIVE,MODERATE,BASIC, MODERATE, COMPREHENSIVE]
Data scope of reruns. Possible values: [DELTA, delta, ALL, all]
Example:
delta
The status of the MDE area. Possible values: [READY, ready, UPDATING, updating, DELETING, deleting, DELETION_PENDING, deletion_pending, FAILED, failed]
Example:
ready- publish_job
Id of the metadata publish job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the MDE area publish job
Example:
My MDE area publish JobA cron string defining when the job should be run. This is going to be always empty as publish is not scheduled to run.
- data_scope_processing
Example:
1631089384058If not null, retries after this interval in millisecond.
Example:
8000Error messages while setting data scope
Status Code
Success
Unauthorized
Forbidden
Not found
Gone
Error
No Sample Response
Delete a metadata enrichment asset
Delete a metadata enrichment area asset
DELETE /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}edit a metadata enrichment area asset
Edit a metadata enrichment area asset
PATCH /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}Request
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
Force the operation even when the metadata enrichment area is being updated.
Object carrying the update request.
name of the metadata enrichment area asset
Example:
Sample enrichmentdescription of the metadata enrichment area asset
Example:
This is a description for my sample metadata enrichment.Id of the catalog to metadata enrichment area assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5- job
Name of the metadata enrichment job
Example:
My Enrichment JobA cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.
Example:
0 3 21 13 1 ? 2019- schedule_info
Indicate a repeated job
Example:
trueA timestamp in epoch time, the scheduled job will be triggered after this timestamp.
Example:
1547578689512A timestamp in epoch time, the scheduled job will be triggered before this timestamp.
Example:
1547578689512
- publish_job
Id of the metadata publish job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the MDE area publish job
Example:
My MDE area publish JobA cron string defining when the job should be run. This is going to be always empty as publish is not scheduled to run.
- objective
- enrichment_options
- structured
true if profile is enabled for structured data. Required when creating and optional when updating.
true if assign terms is enabled for structured data. Required when creating and optional when updating.
true if analyze quality is enabled for structured data. Required when creating and optional when updating.
- unstructured
always true as profile is always enabled for unstructured data
true if assign terms is enabled for unstructured data
Required when creating and optional when updating.
- sampling
- structured
Set true to apply project level default settings to this metadata enrichment area.
Sampling method for this metadata enrichment area. The value is respected when project_default_settings is false. Possible values: [TOP, top, RANDOM, random]
Example:
topAnalysis method to use when sampling data. Either sample a
fixednumber of rows or a givenpercentageof all table rows. The value is respected when project_default_settings is false. Providing this attribute is optional, if not specified, the analysis method defaults tofixed. Possible values: [FIXED, fixed, PERCENTAGE, percentage]Example:
fixed- sample_size
Allowable values: [
BASIC,COMPREHENSIVE,CUSTOM,MODERATE,BASIC, MODERATE, COMPREHENSIVE, CUSTOM]- options
Enrich top # of rows / table.
Example:
100Classify based on # values / column.
Example:
10
- percentage_options
Percentage of rows to enrich, as decimal
Example:
0.8Minimum number of rows to include in sampling
Example:
100Maximum number of rows to include in sampling
Example:
100Classify based on # values/columns.
Example:
10
- unstructured
sampling method
Allowable values: [
RANDOM]- sample_size
Allowable values: [
BASIC,COMPREHENSIVE,MODERATE,BASIC, MODERATE, COMPREHENSIVE]
Data scope of reruns. Possible values: [DELTA, delta, ALL, all]
Example:
delta
list of tags
Response
An object containing information about a metadata enrichment area asset
- metadata
The metadata enrichment area id assigned by the system. Read-only
Example:
4412e9b2-3661-11e7-a919-92ebcb67fe33The type of the asset
Example:
metadata_enrichment_areaThe IAM ID of the user that created the asset
Example:
IBMid-550000FRA0Timestamp representing creation datetime of metadata enrichment area asset read-only
Example:
1631089384058The ID of the project which contains the asset.
Example:
487084de-de8d-4981-9205-952732a90b3d- usage
Example:
2019-01-15T18:58:09ZExample:
IBMid-550000FRA0Example:
1547578689512Example:
2019-01-15T18:58:09ZExample:
1547578689512Example:
IBMid-550000FRA0
list of tags
- entity
name of the metadata enrichment area asset
Example:
my_enrichmentdescription of the metadata enrichment area asset
Example:
Enrichment of assetsId of the catalog to metadata enrichment area assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5- job
Id of the metadata enrichment job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the metadata enrichment job
Example:
My Enrichment JobA cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.
Example:
0 3 21 13 1 ? 2019- schedule_info
Indicate a repeated job
Example:
trueA timestamp in epoch time, the scheduled job will be triggered after this timestamp.
Example:
1547578689512A timestamp in epoch time, the scheduled job will be triggered before this timestamp.
Example:
1547578689512
- data_asset_summary
- structured
Number of structured data assets
Example:
1203
- unstructured
Number of unstructured data assets
Example:
890
- objective
- enrichment_options
- structured
true if profile is enabled for structured data. Required when creating and optional when updating.
true if assign terms is enabled for structured data. Required when creating and optional when updating.
true if analyze quality is enabled for structured data. Required when creating and optional when updating.
- unstructured
always true as profile is always enabled for unstructured data
true if assign terms is enabled for unstructured data
Required when creating and optional when updating.
- sampling
- structured
Set true to apply project level default settings to this metadata enrichment area.
Sampling method for this metadata enrichment area. The value is respected when project_default_settings is false. Possible values: [TOP, top, RANDOM, random]
Example:
topAnalysis method to use when sampling data. Either sample a
fixednumber of rows or a givenpercentageof all table rows. The value is respected when project_default_settings is false. Providing this attribute is optional, if not specified, the analysis method defaults tofixed. Possible values: [FIXED, fixed, PERCENTAGE, percentage]Example:
fixed- sample_size
Possible values: [
BASIC,COMPREHENSIVE,CUSTOM,MODERATE,BASIC, MODERATE, COMPREHENSIVE, CUSTOM]- options
Enrich top # of rows / table.
Example:
100Classify based on # values / column.
Example:
10
- percentage_options
Percentage of rows to enrich, as decimal
Example:
0.8Minimum number of rows to include in sampling
Example:
100Maximum number of rows to include in sampling
Example:
100Classify based on # values/columns.
Example:
10
- unstructured
sampling method
Possible values: [
RANDOM]- sample_size
Possible values: [
BASIC,COMPREHENSIVE,MODERATE,BASIC, MODERATE, COMPREHENSIVE]
Data scope of reruns. Possible values: [DELTA, delta, ALL, all]
Example:
delta
The status of the MDE area. Possible values: [READY, ready, UPDATING, updating, DELETING, deleting, DELETION_PENDING, deletion_pending, FAILED, failed]
Example:
ready- publish_job
Id of the metadata publish job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the MDE area publish job
Example:
My MDE area publish JobA cron string defining when the job should be run. This is going to be always empty as publish is not scheduled to run.
- data_scope_processing
Example:
1631089384058If not null, retries after this interval in millisecond.
Example:
8000Error messages while setting data scope
Status Code
Success
Unauthorized
Forbidden
Not found
Gone
Error
No Sample Response
Add or remove assets from data scope
Add or remove assets from data scope
PATCH /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scopeRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
Force the operation even when the metadata enrichment area is being updated.
Object carrying the update request.
operation to perform
Allowable values: [
ADD,REMOVE,add, remove]Asset type. e.g. data_asset, metadata_import
Example:
data_assetID of the asset to add to or remove from the metadata enrichment area
Example:
30bc8c7a-ef65-4383-b9c6-d304bc191e26
Assign business terms to data assets
Add terms to given data assets. This api is executed synchronously. It verifies that all assets are part of the given MDE area. If validation fails method ends with an error.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/assign_termsRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
whether to process the request asynchronously
Default:
false
List of data assets and terms to assign
IDs of assets to enrich metadata
Assign business terms to columns of data assets
Add terms to given asset columns. This api is executed synchronously. It verifies that all assets are part of the given MDE area. If validation fails method ends with an error.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/assign_termsRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
whether to process the request asynchronously
Default:
false
List of columns of data assets and terms to assign
Assign or remove a data class to columns of data assets
Assign or remove data class to columns of data assets
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/dataclassRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
whether to process the request asynchronously
Default:
false
List of columns of data assets and id of data class and operation to be performed
Example:
b5568a7e-7fca-4824-8466-f18119096e81
Remove business terms from columns of data assets.
Removes either all terms or selected terms from given asset columns. When terms are provided with the payload only the given terms are removed from the given columns. If no terms are provided all terms are removed.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/remove_termsRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
whether to process the request asynchronously
Default:
false
List of columns of data assets and terms to assign
Adds or updates the review timestamp for given columns.
Adds/updates the 'reviewed' time stamp to/of the given asset columns.This api is executed synchronously. It fetches the assets that belong to the given columns via CAMS bulk get and verifies that all given assets are part of the given MDE area and are ready for review which means that either profiling or term assignment must be finished. It also validates that the columns exist on the asset. If validation fails the method returns an error. Otherwise for all given columns the review timestamp gets updated via CAMS bulk patch. Returns the new review timestamp.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/reviewRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
Array containing list of asset Ids with columns.
asset_id
Example:
75985844-aa3f-410f-82be-9788ffd6ec75columns of an asset
Removes review timestamp for given columns.
Removes the 'reviewed' time stamp from the given asset columns. This api is executed synchronously. It fetches alle assets that belong to the given columns via CAMS bulk get and verifies that all given assets are part of the given MDE area. Assets that have no review data are skipped. It also validates that the columns exist on the asset. If validation fails the method returns an error. Otherwise for all given columns the review timestamp will be removed via CAMS bulk patch.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/unreviewRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
Array containing list of asset Ids with columns.
asset_id
Example:
75985844-aa3f-410f-82be-9788ffd6ec75columns of an asset
Enrich selected data assets
Enrich selected data assets
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/enrichRemove business terms from data assets
Removes either all terms or selected terms from given list of data assets. When terms are provided with the payload only the given terms are removed from the given assets. If no terms are provided all terms are removed.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/remove_termsRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
whether to process the request asynchronously
Default:
false
List of data assets and terms to remove
IDs of assets to enrich metadata
Review a given list of data assets.
Adds/updates the 'reviewed' time stamp to/of given data assets. This api is executed synchronously. It fetches the given assets via CAMS bulk get and verifies that all given assets are part of the given MDE area and are ready for review which means that either profiling or term assignment must be finished. If validation fails the method returns an error. Otherwise the review timestamp of all assets gets updated via CAMS bulk patch. Returns the new review timestamp.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/reviewRemoves review timestamp from the given assets
Removes the 'reviewed' time stamp from the given data assets. This api is executed synchronously. It fetches the given assets via CAMS bulk get and verifies that all given assets are part of the given MDE area. Assets that have no review data are skipped. If validation fails the method returns an error. Otherwise the review timestamp is removed from of all assets via CAMS bulk patch.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/unreviewPublish all assets or a subset of assets of a Metadata Enrichment Area to a catalog
Publish assets asynchronously. If publishScope is 'selected_assets' either /asset_ids or /filter/search_criteria has to be specified. If publisScope is 'all_assets' none of both must be specified.
POST /v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/publish_assetsRequest
Path Parameters
Id of the metadata enrichment area asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
tells if all assets in mde area should be published or only selected assets
Allowable values: [
all_assets,selected_assets]
Publish assets to a catalog
catalog Id
Example:
ae568a7e-7fca-4824-8466-f18119096e82action if asset already exists
Allowable values: [
IGNORE,REPLACE,UPDATE,replace, update, ignore]Example:
updateIDs of assets to enrich metadata
- filter
type of search
Allowable values: [
CATALOG_SEARCH,catalog_search]Asset type for catalog search.
Example:
metadata_enrichment_area_infoJSON object for search payload
Examples:{ "query": "asset.name:Asset* AND metadata_enrichment_area_info.area_id:62df1c42-53cd-4503-a6f5-f020aaabca72" }- search_criteria
Request
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
If this value is set to true, a Job is created together. The relation is also done between mdetadata import asset. The response message includes entity.jobId. The job name is generated from the name of metadata import with a unique suffix.
Default:
falseA candidate of Job name. The job is created with a specified name. If the name already exists, an error is returned. The create_job parameter should be set to true.
Object containing information for creating a metadata import asset
name of the metadata import asset
Example:
db2_tables_importlabel to identify new architecture
- datasource_definition_info
- metadata_ingestion_info
- extraction_info
Example:
-Direct -Agent
List of the assets to be update with SAP Business Metdata
description of the metadata import asset
Example:
Import of a db2 tableThe type of the import. The possible values are 'metadata' and 'lineage'.
Allowable values: [
LINEAGE,LINEAGE_AND_DISCOVERY,METADATA,TERMGENERATION,TERMGENERATION_AND_METADATA,metadata, lineage, lineage_and_discovery, termgeneration_and_metadata, termgeneration]Id of the connection which is being discovered
Example:
96e2149d-6916-427b-bf98-a0cb989306d7List of connection_id which is being discovered
Examples:[ "69196df7-714f-416b-a49b-ea025cd5d5e7", "224a78fe-7946-4e10-b685-af7b5f047d0a" ]List of configuration/datasource files for which metadata/lineage has to be extracted.
Examples:[ { "asset_id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "technology": "erwin" } ]- file_configuration
List of workspace rootPath.
Examples:[ { "id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "path": "/Workspace/export_uc", "name": "Databricks_connection", "type": "Connection" } ]asset ref map when trying to export and import a project .
specify if name, description, column descriptions to be udpated during re-import.
Examples:[ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ]- business_extraction
- primary_category
- dictionary_connection
List of the data assets to be updated with Business Metadata
support advanced options of metadata import.
Examples:[ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ]Advanced settings for lineage
Examples:[ { "extract_extended_attributes": false, "performance_profile": "Complete" } ]Id of the catalog to import assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5Id of the project to import assets into
Example:
c5b3daa2-c880-4f83-9bfa-c50ff70d9f42Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33- scope
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_lineage
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_term_generation
list of assets.
Examples:[ "asset1", "asset2" ]
list of tags
Examples:[ "tag1", "tag2" ]check to disable or enable migrating MDI tags to data asset.
Example:
trueName of the metaBroker importflow
Example:
Run open Export- metadata_enrichment_area_info
Example:
2019-01-15T18:58:09ZExample:
96e2149d-6916-427b-bf98-a0cb989306d7
The goal the import. The possible values are 'metadata','lineage',
data_model,data_integration,data_integration_discover,business_intelligence,business_intelligence_discoverandopen_mantaAllowable values: [
BUSINESS_INTELLIGENCE,BUSINESS_INTELLIGENCE_DISCOVER,DATA_INTEGRATION,DATA_INTEGRATION_DISCOVER,DATA_MODEL,LINEAGE,METADATA,OPEN_MANTA,metadata, lineage, data_model, data_integration, data_integration_discover, business_intelligence, business_intelligence_discover, open_manta]Example:
metadata
Response
An object containing information about a metadata import asset
- metadata
The metadata import id assigned by the system. Read-only
The type of the asset
The IAM ID of the user that created the asset
Timestamp representing creation datetime of metadata import asset read-only
Example:
2019-01-15T18:58:09ZThe ID of the project which contains the asset.
- usage
Example:
2019-01-15T18:58:09ZExample:
IBMid-550000FRA0Example:
1547578689512Example:
2019-01-15T18:58:09ZExample:
1547578689512Example:
IBMid-550000FRA0
list of tags
Examples:[ "tag1", "tag2" ]
- entity
name of the metadata import asset
Example:
db2_tables_importlabel to identify new architecture
- datasource_definition_info
- metadata_ingestion_info
- extraction_info
Example:
-Direct -Agent
description of the metadata import asset
Example:
Import of a db2 tableThe type of the import. The possible values are 'metadata' and 'lineage'.
Example:
metadataId of the connection which is being imported
Example:
96e2149d-6916-427b-bf98-a0cb989306d7List of connection_id which is being discovered
List of configuration/datasource files for which metadata/lineage has to be extracted.
Examples:[ { "asset_id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "technology": "erwin" } ]- file_configuration
List of workspace rootPath.
Examples:[ { "id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "path": "/Workspace/export_uc", "name": "Databricks_connection", "type": "Connection" } ]Id of the catalog to import assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5Id of the project to import assets into
Example:
c5b3daa2-c880-4f83-9bfa-c50ff70d9f42Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Id of DataSourceDefinitionInfo
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Scanner name of DataSourceDefinitionInfo
Example:
Oracle- scope
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_lineage
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_term_generation
list of assets.
Examples:[ "asset1", "asset2" ]
The type of the data source. The possible values are 'database', 'file', and 'generic'.
Possible values: [
DATABASE,FILE,GENERIC,database, file, generic]Started time of the last run.
Example:
1547578689512Completed time of the last run.
Example:
1547578689512Number of runs.
Example:
10Version of metadata import.
Example:
1Name of the metabroker importflow
Example:
Run Open ExportMetaBroker importflow executionid
The number of assets imported newly since last importing.
Example:
10The number of assets updated since last importing.
Example:
5The number of assets removed since last importing.
Example:
3the flag if the metadata enrichment can work or not.
Example:
truecheck to disable or enable migrating MDI tags to data asset.
Example:
trueoptions while reimporting metadata.
Examples:[ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ]support advanced options of metadata import.
Examples:[ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ]Advanced settings for lineage
Examples:[ { "extract_extended_attributes": false, "performance_profile": "Complete" } ]- business_extraction
- primary_category
- dictionary_connection
List of the data assets to be updated with Business Metadata
- metadata_enrichment_area_info
Example:
2019-01-15T18:58:09ZExample:
96e2149d-6916-427b-bf98-a0cb989306d7
Contains warning message, if validation of metabroker scanner passes partially.
Example:
trueThe goal the import. The possible values are 'metadata','lineage',
data_model,data_integration,data_integration_discover,business_intelligence,business_intelligence_discoverandopen_mantaExample:
metadata
Status Code
Success
Unauthorized
Forbidden
Error
No Sample Response
Bulk delete data assets in Metadata discovery
Delete assets in bulk
POST /v2/metadata_imports/bulk_delete_assets
Request
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
The catalog_id and / or project_id must be provided. If catalog_id is provided, the catalog must exist and the caller must be an admin or editor member of the catalog. Only data discovery runs associated with the catalog will be returned.
Array containing list of data asset Ids.
Bulk delete metadata import assets in Metadata discovery
Delete metadata import assets in bulk
DELETE /v2/metadata_imports/bulk_delete_metadataImport_assets
Create a job to publish the data assets and configure the list of data assets to be included in the job.
Publish assets in bulk
POST /v2/metadata_imports/bulk_publish_assets
Request
Query Parameters
The connection_id may be optionally provided to retrieve data discovery runs associated with the connection.
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
The catalog_id and / or project_id must be provided. If catalog_id is provided, the catalog must exist and the caller must be an admin or editor member of the catalog. Only data discovery runs associated with the catalog will be returned.
mdi id to retrieve the MDI object
Array containing list of data asset Ids.
Get a list of supported datasource types
INTERNAL: Get list of supported connection types.
GET /v2/metadata_imports/connections
Response
datasource id
Example:
96e2149d-6916-427b-bf98-a0cb989306d7Whether datasource supports scoping.
Example:
trueWhether datasource supports manta.
Example:
trueWhether datasource is of type relational database.
Indicates whether data be can fetched from this connection type, It will be true for SCAPI connections and false for manta only connections.
Example:
true
Status Code
Success
Unauthorized
Forbidden
Error
No Sample Response
Restart the pending a job run
Restart the pending a job run. It should be called after restore from the backup data. This API is not unavailable on IBM Cloud. The Admin role is necessary to call this API.
POST /v2/metadata_imports/recover_task
Request
Object containing information for recovering import
The timestamp when the data was restored (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339)
Example:
2022-04-13T14:59:04ZThe status that will be restarted. The possible values are 'starting' and 'running'. The 'running' includes 'starting' status, too.
Allowable values: [
RUNNING,STARTING,starting, running]
Retrieve details of a Metadata Import
Retrieve details of a metadata import
GET /v2/metadata_imports/{metadata_import_id}Request
Path Parameters
Id of the metadata import asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
Response
An object containing information about a metadata import asset
- metadata
The metadata import id assigned by the system. Read-only
The type of the asset
The IAM ID of the user that created the asset
Timestamp representing creation datetime of metadata import asset read-only
Example:
2019-01-15T18:58:09ZThe ID of the project which contains the asset.
- usage
Example:
2019-01-15T18:58:09ZExample:
IBMid-550000FRA0Example:
1547578689512Example:
2019-01-15T18:58:09ZExample:
1547578689512Example:
IBMid-550000FRA0
list of tags
Examples:[ "tag1", "tag2" ]
- entity
name of the metadata import asset
Example:
db2_tables_importlabel to identify new architecture
- datasource_definition_info
- metadata_ingestion_info
- extraction_info
Example:
-Direct -Agent
description of the metadata import asset
Example:
Import of a db2 tableThe type of the import. The possible values are 'metadata' and 'lineage'.
Example:
metadataId of the connection which is being imported
Example:
96e2149d-6916-427b-bf98-a0cb989306d7List of connection_id which is being discovered
List of configuration/datasource files for which metadata/lineage has to be extracted.
Examples:[ { "asset_id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "technology": "erwin" } ]- file_configuration
List of workspace rootPath.
Examples:[ { "id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "path": "/Workspace/export_uc", "name": "Databricks_connection", "type": "Connection" } ]Id of the catalog to import assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5Id of the project to import assets into
Example:
c5b3daa2-c880-4f83-9bfa-c50ff70d9f42Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Id of DataSourceDefinitionInfo
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Scanner name of DataSourceDefinitionInfo
Example:
Oracle- scope
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_lineage
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_term_generation
list of assets.
Examples:[ "asset1", "asset2" ]
The type of the data source. The possible values are 'database', 'file', and 'generic'.
Possible values: [
DATABASE,FILE,GENERIC,database, file, generic]Started time of the last run.
Example:
1547578689512Completed time of the last run.
Example:
1547578689512Number of runs.
Example:
10Version of metadata import.
Example:
1Name of the metabroker importflow
Example:
Run Open ExportMetaBroker importflow executionid
The number of assets imported newly since last importing.
Example:
10The number of assets updated since last importing.
Example:
5The number of assets removed since last importing.
Example:
3the flag if the metadata enrichment can work or not.
Example:
truecheck to disable or enable migrating MDI tags to data asset.
Example:
trueoptions while reimporting metadata.
Examples:[ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ]support advanced options of metadata import.
Examples:[ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ]Advanced settings for lineage
Examples:[ { "extract_extended_attributes": false, "performance_profile": "Complete" } ]- business_extraction
- primary_category
- dictionary_connection
List of the data assets to be updated with Business Metadata
- metadata_enrichment_area_info
Example:
2019-01-15T18:58:09ZExample:
96e2149d-6916-427b-bf98-a0cb989306d7
Contains warning message, if validation of metabroker scanner passes partially.
Example:
trueThe goal the import. The possible values are 'metadata','lineage',
data_model,data_integration,data_integration_discover,business_intelligence,business_intelligence_discoverandopen_mantaExample:
metadata
Status Code
Success
Unauthorized
Forbidden
Not found
Gone
Error
No Sample Response
delete a metadata import asset
delete a metadata import asset
DELETE /v2/metadata_imports/{metadata_import_id}edit a metadata import asset
edit a metadata import asset
PATCH /v2/metadata_imports/{metadata_import_id}Request
Path Parameters
Id of the metadata import asset.
Query Parameters
The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.
Object carrying the update request.
name of the metadata import asset
Example:
db2_tables_importdescription of the metadata import asset
Example:
Import of a db2 tableId of the connection which is being discovered
Example:
96e2149d-6916-427b-bf98-a0cb989306d7Id of the catalog to import assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5Id of the project to import assets into
Example:
c5b3daa2-c880-4f83-9bfa-c50ff70d9f42Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Name of the metabroker importflow
Example:
Run Open Export- scope
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
list of tags
Examples:[ "tag1", "tag2" ]the flag if the metadata enrichment can work or not.
Example:
truecheck to disable or enable migrating MDI tags to data asset.
Example:
trueasset ref map when trying to export and import a project .
specify if name, description, column descriptions to be udpated during re-import.
Examples:[ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ]support advanced options of metadata import.
Examples:[ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ]Advanced settings for lineage
Examples:[ { "extract_extended_attributes": false, "performance_profile": "Complete" } ]- metadata_ingestion_info
- extraction_info
Example:
-Direct -Agent
- datasource_definition_info
- file_configuration
- scope_lineage
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
label to identify new architecture
Response
An object containing information about a metadata import asset
- metadata
The metadata import id assigned by the system. Read-only
The type of the asset
The IAM ID of the user that created the asset
Timestamp representing creation datetime of metadata import asset read-only
Example:
2019-01-15T18:58:09ZThe ID of the project which contains the asset.
- usage
Example:
2019-01-15T18:58:09ZExample:
IBMid-550000FRA0Example:
1547578689512Example:
2019-01-15T18:58:09ZExample:
1547578689512Example:
IBMid-550000FRA0
list of tags
Examples:[ "tag1", "tag2" ]
- entity
name of the metadata import asset
Example:
db2_tables_importlabel to identify new architecture
- datasource_definition_info
- metadata_ingestion_info
- extraction_info
Example:
-Direct -Agent
description of the metadata import asset
Example:
Import of a db2 tableThe type of the import. The possible values are 'metadata' and 'lineage'.
Example:
metadataId of the connection which is being imported
Example:
96e2149d-6916-427b-bf98-a0cb989306d7List of connection_id which is being discovered
List of configuration/datasource files for which metadata/lineage has to be extracted.
Examples:[ { "asset_id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "technology": "erwin" } ]- file_configuration
List of workspace rootPath.
Examples:[ { "id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "path": "/Workspace/export_uc", "name": "Databricks_connection", "type": "Connection" } ]Id of the catalog to import assets into
Example:
342b07da-fbe5-4a0a-94ee-ab89696975d5Id of the project to import assets into
Example:
c5b3daa2-c880-4f83-9bfa-c50ff70d9f42Id of the metadata import job
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Id of DataSourceDefinitionInfo
Example:
330c6256-3661-11e7-a919-92ebcb67fe33Scanner name of DataSourceDefinitionInfo
Example:
Oracle- scope
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_lineage
list of paths
Examples:[ "/schema1/table1" ]include list in path
Examples:[ "/table2", "/table3" ]exclude list in path
Examples:[ "table4", "table5" ]
- scope_term_generation
list of assets.
Examples:[ "asset1", "asset2" ]
The type of the data source. The possible values are 'database', 'file', and 'generic'.
Possible values: [
DATABASE,FILE,GENERIC,database, file, generic]Started time of the last run.
Example:
1547578689512Completed time of the last run.
Example:
1547578689512Number of runs.
Example:
10Version of metadata import.
Example:
1Name of the metabroker importflow
Example:
Run Open ExportMetaBroker importflow executionid
The number of assets imported newly since last importing.
Example:
10The number of assets updated since last importing.
Example:
5The number of assets removed since last importing.
Example:
3the flag if the metadata enrichment can work or not.
Example:
truecheck to disable or enable migrating MDI tags to data asset.
Example:
trueoptions while reimporting metadata.
Examples:[ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ]support advanced options of metadata import.
Examples:[ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ]Advanced settings for lineage
Examples:[ { "extract_extended_attributes": false, "performance_profile": "Complete" } ]- business_extraction
- primary_category
- dictionary_connection
List of the data assets to be updated with Business Metadata
- metadata_enrichment_area_info
Example:
2019-01-15T18:58:09ZExample:
96e2149d-6916-427b-bf98-a0cb989306d7
Contains warning message, if validation of metabroker scanner passes partially.
Example:
trueThe goal the import. The possible values are 'metadata','lineage',
data_model,data_integration,data_integration_discover,business_intelligence,business_intelligence_discoverandopen_mantaExample:
metadata
Status Code
Success
Unauthorized
Forbidden
Not found
Gone
Error
No Sample Response
Creates a category in the glossary
This method can be used to create a new category in the glossary.
POST /v3/categories
Request
Represents a category to be created.
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Artifact ID of a parent category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Indicates that it is a reference copy of an artifact managed in an external metadata server.
Used by reporting service for authorization. Can be set only for root level categories.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]
Response
- Response returned on creating a category.
It differs from its base class ({@link CreateResponse}) because it does not include {@code /version/{version_id}} in paths of returned URLs (the categories API does not have such endpoints, only {@code GET /categories/{category_id}}).
IDs of the created items.
Status Code
The category has been created successfully.
Bad Request
Unauthorized
Forbidden
UniqueConstraintViolation - category with given name and parent already exists.
Internal Server Error
{ "resources": [ { "href": "/v3/categories/285b7b78-3d64-48e6-a9b6-e02f4c32295f", "artifact_id": "285b7b78-3d64-48e6-a9b6-e02f4c32295f", "version_id": "12e37d76-f28b-4dc9-a35e-0c3e30f9f8ea_0", "global_id": "18091466-981e-4113-8943-2ddf162bff6d_285b7b78-3d64-48e6-a9b6-e02f4c32295f", "entity_type": "category" } ] }
Start category boostrap process
Assigns default owners and view permissions for root categories without any role assignments set
POST /v3/categories/collaborators/bootstrap
Response
Bootstrap Status
Current bootstrap status
Possible values: [
NOT_STARTED,NEW,IN_PROGRESS,SUCCEEDED,FAILED,STALLED]Number of records already bootstrapped successfully
Overall outcome of the bootstrap process. Set once bootstrapping is finished.
Current bootstrap activity
Bootstrap process errors
Total number of records to be processed by the bootstrap process
Status Code
The boostrap process started successfully
The boostrap is already in progress
Unauthorized
Internal Server Error
IN_PROGRESS
{ "status": "IN_PROGRESS", "current_step": "Bootstrapping category e39ada11-8338-3704-90e3-681a71e7c839", "completed_records": 0, "total_records": 3 }
Get status of category bootstrap process
Get status of category bootstrap process
GET /v3/categories/collaborators/bootstrap/status
Response
Bootstrap Status
Current bootstrap status
Possible values: [
NOT_STARTED,NEW,IN_PROGRESS,SUCCEEDED,FAILED,STALLED]Number of records already bootstrapped successfully
Overall outcome of the bootstrap process. Set once bootstrapping is finished.
Current bootstrap activity
Bootstrap process errors
Total number of records to be processed by the bootstrap process
Status Code
Bootstrap status fetched successfully
Unauthorized
Internal Server Error
IN_PROGRESS
{ "status": "IN_PROGRESS", "current_step": "Bootstrapping category e39ada11-8338-3704-90e3-681a71e7c839", "completed_records": 0, "total_records": 3 }NEW
{ "status": "NEW", "current_step": "Initializing role assignment bootstrap process", "completed_records": 0 }NOT_STARTED
{ "status": "NOT_STARTED" }SUCCEEDED
{ "status": "SUCCEEDED", "completion_message": "Bootstrap process completed", "completed_records": 3, "total_records": 3 }
Get history status of category bootstrap process
Get history status of category bootstrap process
GET /v3/categories/collaborators/bootstrap/status/history
Response
Response returned on retrieving bootstrap status history.
Bootstrap status history list
Status Code
Bootstrap status history fetched successfully
Unauthorized
Internal Server Error
SUCCEEDED
{ "bootstrap_status_history": [ { "status": "SUCCEEDED", "completion_message": "No categories requiring bootstrap process", "completed_records": 0, "total_records": 0 }, { "status": "SUCCEEDED", "completion_message": "Bootstrap process completed", "completed_records": 3, "total_records": 3 } ] }
Retrieves category hierarchy paths for given artifact ids of categories
This method can be used for retrieving hierarchy paths of categories
GET /v3/categories/hierarchy
Request
Query Parameters
The id of the category whose path is fetched
Possible values: 1 ≤ length ≤ 100, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Response
Response returned on retrieving hierarchy path for category.
IDs and names of categories in category hierarchy path for each category id
Status Code
The hierarchy paths of categories have been retrieved successfully
Unauthorized
The category with given {guid} does not exist in the glossary.
Internal Server Error
{ "category_hierarchy_paths": [ { "category_id": "b50f0822-eff3-4912-932e-aa61e5e7ac9a", "category_hierarchy_path": [ { "artifact_id": "4c4b18ae-010c-4986-a308-93c6f22095d6", "name": "category name 1", "user_access": true }, { "artifact_id": "fedc7149-5504-4ea9-aca7-3ad025be6f7d", "name": "category name 2", "user_access": true } ] } ] }
Retrieves category hierarchy paths for given artifact ids of categories
This method can be used for retrieving hierarchy paths of categories
POST /v3/categories/hierarchy
Request
Query Parameters
The maximum number of categories to return - must be at least 1 and cannot exceed 1000. The default value is 10.
Possible values: 1 ≤ value ≤ 1000
Default:
10The index of the first matching category to include in the result.
List of glossary resources
{
"resources": [
{
"artifact_id": "2b9bb7cf-502e-43a2-9ecc-645e909cba33"
}
]
}List of resources.
Response
Response returned on retrieving hierarchy path for category.
IDs and names of categories in category hierarchy path for each category id
Status Code
The hierarchy paths of categories have been retrieved successfully
Unauthorized
Internal Server Error
{ "resources": [ { "metadata": { "artifact_type": "category", "artifact_id": "2b9bb7cf-502e-43a2-9ecc-645e909cba33", "version_id": "5b6a662e-10d5-47fd-b485-655521ee491a_0", "source_repository_id": "2513bb40-5ce0-440e-9aa7-f473d1c22f9f", "source_repository_name": "WKC_BG_2513bb40-5ce0-440e-9aa7-f473d1c22f9f", "global_id": "2513bb40-5ce0-440e-9aa7-f473d1c22f9f_2b9bb7cf-502e-43a2-9ecc-645e909cba33", "created_by": "System", "created_at": "2023-11-13T06:50:09.240Z", "modified_by": "System", "modified_at": "2023-11-13T06:50:09.240Z", "revision": "0", "name": "child of child2 category", "short_description": "child of child2-sd", "state": "PUBLISHED", "tags": [], "read_only": false }, "entity": { "parent_category_id": "b02920a4-09ae-4a62-a25f-03a2d7ba0507", "reporting_authorized": false, "long_description": "child of child2-ld", "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false } } ], "offset": 0, "last": { "href": "/v3/categories/hierarchy?limit=10&offset=0", "offset": "0" }, "set_uri": false, "limit": 10, "count": 1, "first": { "href": "/v3/categories/hierarchy?limit=10&offset=0", "offset": "0" } }
Deletes the category with a given guid
This method can be used to delete a category.
Note! The category must be empty. It can contain neither child categories nor artifacts.
DELETE /v3/categories/{category_id}Request
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Response
Glossary archive response object
Guids of the archived objects.
Guids of the deleted objects.
Guids of the updated objects.
Status Code
The category has been deleted successfully.
Bad Request
Unauthorized
Forbidden
The category with given {guid} does not exist in the glossary.
Internal Server Error
No Sample Response
Retrieves category with given guid
This method can be used for retrieving details of a category.
GET /v3/categories/{category_id}Request
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
When set to true fetch category relationships user has access to. It returns at most 1000 relationships. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Deprecated, functionality will be replaced by new one introduced in the feature releases.Default:
trueIf this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
true
Response
Represents a category object - which contains metadata and category entity.
Represents a category.
Metadata of the entity.
Status Code
The category has been retrieved successfully.
Unauthorized
Forbidden
The category with given {guid} does not exist in the glossary.
Internal Server Error
No Sample Response
Updates category with given id
This method can be used to update a category with given id.
It may be an update of its name, description, etc..
PATCH /v3/categories/{category_id}Request
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})
Category to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "short desc updated"}
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1Artifact ID of a parent category. This is read only property and should not be changed.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Indicates that it is a reference copy of an artifact managed in an external metadata server.
Used by reporting service for authorization. Can be set only for root level categories.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]
Response
Represents a category object - which contains metadata and category entity.
Represents a category.
Metadata of the entity.
Status Code
The category has been updated successfully.
Bad Request
Unauthorized
Forbidden
The category with given {guid} does not exist in the glossary.
The category was modified by another user.
Internal Server Error
No Sample Response
Removes an artifact from its secondary category
It can be used to remove a secondary category assignment for an artifact. It does not allow to remove an artifact from a primary category as a primary category assignment is obligatory.
DELETE /v3/categories/{category_id}/artifacts/{artifact_id}Request
Path Parameters
The artifact ID or the global ID of a category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The artifact ID or the global ID of an artifact to be removed from a (secondary) category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Response
Status Code
A secondary category assignment removed.
Attempt to remove an artifact from its primary category failed, because a primary category assignment is mandatory.
Unauthorized
The category with the given {category_id} does not exist in the glossary.
Internal Server Error
No Sample Response
Adds an artifact to a category
It can be used to set a primary category for an artifact (replacing an old primary category assignment if existed) as well as to add an artifact to a secondary category.
PUT /v3/categories/{category_id}/artifacts/{artifact_id}Request
Path Parameters
The artifact ID or the global ID of a category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The artifact ID or the global ID of an artifact to be added to the category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Assignment of an artifact to a category
Type of the artifact to be added to a category
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
data_classtrue when a primary category should be set for an artifact, false when the artifact should be added to a secondary category
Example:
true
Response
Assignment of an artifact to a category
Type of the artifact to be added to a category
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
data_classtrue when a primary category should be set for an artifact, false when the artifact should be added to a secondary category
Example:
true
Status Code
An existing category assignment updated (e.g. changed from secondary to primary).
A new category assignment created.
Unauthorized
The category with the given {category_id} or the artifact with the given {artifact_id} does not exist in the glossary.
Internal Server Error
No Sample Response
Retrieves collaborators for given artifact id of a category
Single collaborator is an users with assigned roles in context of given category. A role comes with rights to access the category, its sub-categories and artifacts and potential responsibilities.
GET /v3/categories/{category_id}/collaboratorsRequest
Path Parameters
The artifact ID or the global ID of a category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If this parameter is true, the returned list contains collaborators not only for given category, but also for all parent categories, up to root category.
Default:
trueIf set then the returned list will be reduced to collaborators with given roles only. Maximum allowed number of roles is 100
Possible values: 1 ≤ length ≤ 100, Value must match regular expression
.*
Creates single collaborator for given category
To create collaborator one needs to provide id of the collaborating user and the name of the role he will be permitted. Collaborator is effective for given category and whole tree of its subcategories.
POST /v3/categories/{category_id}/collaboratorsRequest
Path Parameters
The artifact ID or the global ID of a category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
New collaborator data representing user with assigned role. It will be created in the context of specific category.
Id of the user to be assigned to given role
Possible values: 1 ≤ length ≤ 73, Value must match regular expression
.*Role to be assigned
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Type of the user. When not provided defaults to USER
Allowable values: [
USER,GROUP]
Response
Category permission list for given category id
Category Artifact Id
Category Name
Create Time
DPS Rule Id
Id
Principal Id
Role
User type
Status Code
The collaborator has been created successfully.
Bad Request
Unauthorized
UniqueConstraintViolation - collaborator with the same role and user id already exists for given category.
Internal Server Error
No Sample Response
Deletes single collaborator
Collaborator represents single user together with single role that gives him certain privileges in context of given category.
DELETE /v3/categories/{category_id}/collaborators/{collaborator_id}Request
Path Parameters
The artifact ID or the global ID of a category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The id of the collaborator.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
List the relationships of the given type for the specified category
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/categories/{category_id}/relationshipsRequest
Path Parameters
The artifact ID of the category.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_categoryhas_types_categoryis_a_parent_category_forgrouped_assetsowned_byclassificationscustomall
Note:alldoes not return category hierarchy.Possible values: 1 ≤ length ≤ 255, Value must match regular expression
^(((is_a_type_of_category|has_types_category|is_a_parent_category_for|grouped_assets|owned_by|classifications|custom),?)+)|all$Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4Is custom relationship reversed?
Default:
falseIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Default:
falseRetrieves target parent category name of the relationship entity.
Default:
falseThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Default:
0
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Remove a relationship from category
Currently we support a custom relationship removal from category by relationship ID.
DELETE /v3/categories/{category_id}/relationships/{relationship_id}Request
Path Parameters
The artifact ID of the category to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Get role usage statistics
Get list of roles assigned in glossary, along with number of categories where specific role is used.
GET /v3/category_role_statistics
Response
List of role usage summary
List of roles assigned in glossary, along with number of categories which have role assigned
Status Code
Success
Unauthorized
Internal Server Error
SUCCEEDED
{ "role_assignment_statistics": [ { "role": "custom_role1", "number_of_categories": 1 }, { "role": "custom_role2", "number_of_categories": 2 }, { "role": "owner", "number_of_categories": 2 }, { "role": "viewer", "number_of_categories": 2 } ] }
Returns list of categories which has specific role assigned, along with number of assignments for users and groups
Category statistics
GET /v3/category_statistics
Request
Query Parameters
Role for which statistics are to be retrieved
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
List of category statistic items
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
SUCCEEDED
{ "offset": 0, "last": { "href": "v3/category_statistics?offset=0&role=custom_role2", "offset": 0 }, "set_uri": false, "resources": [ { "category_artifact_id": "788e7609-5d1d-4f5f-a2e2-0011f8c726cf", "category_name": "Example category", "category_hierarchy_path": [ { "artifact_id": "4562a011-563d-40c2-ae28-80f64cd8d934", "name": "Parent of example category", "user_access": true }, { "artifact_id": "e6abcaba-203f-4f43-8bc3-f4f25aa96f19", "name": "Root category", "user_access": true } ], "users_assignments_count": 2, "groups_assignments_count": 1 } ], "limit": 10, "count": 1, "first": { "href": "v3/category_statistics?offset=0&role=custom_role2", "offset": 0 } }
Creates a classification in the glossary
This method is used to create a classification in the glossary.
POST /v3/classifications
Request
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
New classification entity
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1Secondary categories the artifact belongs to.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The child classification relationships in the classification type hierarchy.
The parent category of the artifact.
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
The long description of an artifact.The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
Relationships to categories.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
short descriptionThe steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
The workflow state of an artifact
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
PUBLISHED
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Success
Bad Request
Unauthorized
Not found
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Retrieves classification with given guid and status
This method can be used for retrieving details of an ACTIVE classification. Only ACTIVE is supported
GET /v3/classifications/{artifact_id}/versionsRequest
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Filter by classification status.
Available statuses: DRAFTartifacts which are being created or modified and not in use PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
PUBLISHEDComma-separated list of relationship types.
Available types: is_a_type_of_classificationhas_types_classificationshas_types_classifications_hierarchycategoriesparent_categorytermsdata_classespoliciesrulesreference_datarelated_categoriescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
List of paginated artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Deletes a draft or published version of an artifact
If the artifact state is DRAFT, then the draft version is deleted.
If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .
If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.
If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.
Administrator role is required.
DELETE /v3/classifications/{artifact_id}/versions/{version_id}Request
Path Parameters
The guid of the classification to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the classification to delete.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
A draft version has been successfully created for deleting the published artifact.
The artifact has been deleted successfully.
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Retrieves classification with given guid
This method can be used for retrieving details of an ACTIVE or DRAFT classification.
GET /v3/classifications/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the classification to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the classification to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_classificationhas_types_classificationshas_types_classifications_hierarchycategoriesparent_categorytermsdata_classespoliciesrulesreference_datarelated_categoriescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10
Updates a draft or published artifact
If a published version is updated, a draft version is created from the published version and the draft version is updated with the requested changes and returned.If any relationships of the artifact are updated, then the updated relationships are returned as a paginated list limited by the give limit parameter. The relationships that are not updated are not returned.
PATCH /v3/classifications/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the classification to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the classification to be updated.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
The classification to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Secondary categories the artifact belongs to.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The child classification relationships in the classification type hierarchy.
The parent category of the artifact.
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
The long description of an artifact.The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
Relationships to categories.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
short descriptionThe steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
List the associations of the given type for the specified classification
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/classifications/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifactId of the classification
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The versionId of the classification
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_classificationhas_types_classificationshas_types_classifications_hierarchycategoriesparent_categorytermsdata_classespoliciesrulesreference_datarelated_categoriescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4Is custom relationship reversed?
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Retrieves target parent category name of the relationship entity.
The maximum number of associations to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Create relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.
POST /v3/classifications/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact id of the classification to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the classification to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Relationships to be created.
Category relationships.
The relationships to data classes.
The child classification relationships in the classification type hierarchy.
The parent category of the artifact.
The parent category of the artifact.
The relationships to categories.
The relationships to business terms.
Deletes relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and deletes the relationship from the draft version. And, it returns the details of the draft version.
DELETE /v3/classifications/{artifact_id}/versions/{version_id}/relationships/{relationship_id}Request
Path Parameters
The artifact id of the classification to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the classification to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Retrieves the data classes matching specified parameters.
This method is used to retrieve the data classes that the user have permissions and they match specified parameters.
GET /v3/data_classes
Request
Custom Headers
Allowable values: [
application/json,application/xml]
Query Parameters
Comma-separated list of dataclass statuses.
Available statuses: PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime DELETEDartifacts which have been deleted Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Default:
PUBLISHEDTo filter data classes based on enabled property. The enabled query parameter accepts (Yes, No, Both) where Yes is the default value. This option is not applicable for format=xml.
Default:
BothIf this parameter is set to true, then Dataclass' xml definitions are returned. If parameter is not set its default value is 'true'
Default:
trueIf this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'false'.
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
A filter to artifacts that have been created / updated / deleted since the given timestamp in this format: [yyyy-MM-ddTHH:mm:ss.SSSZ]
Possible values: length = 24, Value must match regular expression
^\d{4}(-\d\d(-\d\d(T\d\d:\d\d(:\d\d)?(\.\d+)?(([+-]\d\d:\d\d)|Z)?)?)?)?$The maximum number of data_classes to return - must be at least 1 and cannot exceed 1000. The default value is 10.
Possible values: 1 ≤ value ≤ 1000
Default:
10The index of the first matching data_class to include in the result.
Response
Presents a paginated list of DataClasses
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Creates a draft data class in the glossary
This method is used to create a draft data class in the glossary. If the effective start date of selected reference data set is a future date, then effective start date of data class will be same as that of selected reference data set effective start date.
POST /v3/data_classes
Request
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
Data class to be created.
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify additional applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
all_dataTo specify additional regular expression; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
.*To specify allow substring match boolean flag; ( This property is applicable for data class type: ValidValues )
To specify applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
all_dataTo specify case sensitive boolean flag; ( This property is applicable for data class type: ValidValues )
Secondary categories the artifact belongs to.
Unique class code given to the data class.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
class code1Relationships to classifications.
To specify column name match
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
^[a-zA-Z]*$List of custom attributes with their values.
Custom relationships to asset
To specify the type of data class: ColumnSimilarity, Java, ReferenceDataSet, Regex, Script, Undefined, UnstructuredFilter, ValidValues
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
^(ColumnSimilarity|Java|Regex|Script|Undefined|UnstructuredFilter|ValidValues|ReferenceDataSet|Fingerprint|OtherMatchingCriteria)$DataType: numeric, string, date, time, timestamp
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "numeric", "string", "date", "time", "timestamp" ]The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
This flag indicates whether the data class can be used for data profiling or not.
Data class example
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
example1To specify expression; ( This property is applicable for data class type: UnstructuredFilter )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
expressionList of immediate child data classes in the data class type hierarchy.
The parent category of the artifact.
To specify Java class name; ( This property is applicable for data class type: Java )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify language: JavaScript, DataRule; ( This property is applicable for data class type: Script )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*To specify maximum data length
To specify minimum data length
The parent category of the artifact.
Data class priority used while profiling.
To specify properties; ( This property is applicable for data class type: Java )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The provider of data class
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify reference columns metadata; ( This property is applicable for data class type: ColumnSimilarity )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Indicates that it is a reference copy of an artifact managed in an external metadata server.
To specify regular expression; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
^[a-zA-Z]*$To specify scope: value, column, dataset_columns, dataset; ( This property is applicable for data class types: Script & Java )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
^(value|column|dataset_columns|dataset)$To specify script name; ( This property is applicable for data class type: Script )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify squeeze consecutive white spaces boolean flag; ( This property is applicable for data class type: ValidValues )
The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
The percentage of threshold.
To specify valid value reference file path; ( This property is applicable for data class type: ValidValues )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify valid values; ( This property is applicable for data class type: ValidValues )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The workflow state of an artifact
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Success
Bad Request
Unauthorized
Not found
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Retrieves data class with given guid and status
This method can be used for retrieving details of an ACTIVE or DRAFT data class. Only ACTIVE is allowed as status right now
GET /v3/data_classes/{artifact_id}/versionsRequest
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Filter by dataclass status.
Available statuses: DRAFTartifacts which are being created or modified and not in use PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
PUBLISHEDComma-separated list of relationship types.
Available types: is_a_type_of_data_classhas_types_data_classeshas_types_data_class_hierarchyparent_categorycategoriestermsclassificationspoliciesrulesreference_datacustomall
Note:alldoes not return data class hierarchy.Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
List of paginated artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
The data class has been retrieved successfully.
Bad Request
Unauthorized
The data class with given {guid} does not exist in the glossary.
Internal Server Error
No Sample Response
Deletes a draft or published version of an artifact
If the artifact state is DRAFT, then the draft version is deleted.
If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .
If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.
If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.
Administrator role is required.
DELETE /v3/data_classes/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the dataclass to delete.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the dataclass to delete.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
A draft version has been successfully created for deleting the published artifact.
The artifact has been deleted successfully.
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Retrieves data class with given guid
This method can be used for retrieving details of an ACTIVE or DRAFT data class.
GET /v3/data_classes/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact ID of the data class to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the data class to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_data_classhas_types_data_classeshas_types_data_class_hierarchyparent_categorycategoriestermsclassificationspoliciesrulesreference_datacustomall
Note:alldoes not return data class hierarchy.Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10
Updates a draft or published artifact
If a published version is updated, a draft version is created from the published version and the draft version is updated with the requested changes and returned.If any relationships of the artifact are updated, then the updated relationships are returned as a paginated list limited by the give limit parameter. The relationships that are not updated are not returned.
PATCH /v3/data_classes/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the data class to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the data class to be updated.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
The data class to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}If the effective start date of selected reference data set is a future date, then effective start date of data class will be same as that of selected reference data set effective start date.
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*To specify additional applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
all_dataTo specify additional regular expression; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
.*To specify allow substring match boolean flag; ( This property is applicable for data class type: ValidValues )
To specify applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
all_dataTo specify case sensitive boolean flag; ( This property is applicable for data class type: ValidValues )
Secondary categories the artifact belongs to.
Unique class code given to the data class.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
class code1Relationships to classifications.
To specify column name match
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
^[a-zA-Z]*$List of custom attributes with their values.
Custom relationships to asset
To specify the type of data class: ColumnSimilarity, Java, ReferenceDataSet, Regex, Script, Undefined, UnstructuredFilter, ValidValues
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
^(ColumnSimilarity|Java|Regex|Script|Undefined|UnstructuredFilter|ValidValues|ReferenceDataSet|Fingerprint|OtherMatchingCriteria)$DataType: numeric, string, date, time, timestamp
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "numeric", "string", "date", "time", "timestamp" ]The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
This flag indicates whether the data class can be used for data profiling or not.
Data class example
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
example1To specify expression; ( This property is applicable for data class type: UnstructuredFilter )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
expressionList of immediate child data classes in the data class type hierarchy.
The parent category of the artifact.
To specify Java class name; ( This property is applicable for data class type: Java )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify language: JavaScript, DataRule; ( This property is applicable for data class type: Script )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*To specify maximum data length
To specify minimum data length
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1The parent category of the artifact.
Data class priority used while profiling.
To specify properties; ( This property is applicable for data class type: Java )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The provider of data class
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify reference columns metadata; ( This property is applicable for data class type: ColumnSimilarity )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Indicates that it is a reference copy of an artifact managed in an external metadata server.
To specify regular expression; ( This property is applicable for data class type: Regex )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
^[a-zA-Z]*$To specify scope: value, column, dataset_columns, dataset; ( This property is applicable for data class types: Script & Java )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
^(value|column|dataset_columns|dataset)$To specify script name; ( This property is applicable for data class type: Script )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify squeeze consecutive white spaces boolean flag; ( This property is applicable for data class type: ValidValues )
The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
The percentage of threshold.
To specify valid value reference file path; ( This property is applicable for data class type: ValidValues )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*To specify valid values; ( This property is applicable for data class type: ValidValues )
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
List the relationships of the given type for the specified data class
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/data_classes/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact ID of the data class to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the data class to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_data_classhas_types_data_classeshas_types_data_class_hierarchyparent_categorycategoriestermsclassificationspoliciesrulesreference_datacustomall
Note:alldoes not return data class hierarchy.Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4Is custom relationship reversed?
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Retrieves target parent category name of the relationship entity.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Create relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.
POST /v3/data_classes/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact ID of the data class to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the data class to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Relationships to be created.
Category relationships.
The relationships to classifications.
New list of child data classes in the data class type hierarchy.
The parent category of the artifact.
The parent category of the artifact.
The relationships to business terms.
Deletes relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and deletes the relationship from the draft version. And, it returns the details of the draft version.
DELETE /v3/data_classes/{artifact_id}/versions/{version_id}/relationships/{relationship_id}Request
Path Parameters
The artifact ID of the data class to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the data class to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Business Glossary Heartbeat
Returns the build details and health of the dependent services
GET /v3/glossary_status/heartbeat
Response
Holds business glossary build information and DB2 connection status information
Build information.
Status of DB2.
Example:
UPThe status of the external Rabbit MQ listener.
Example:
CONNECTEDThe status of the internal Rabbit MQ listener.
Example:
CONNECTEDOK indicates that the service is up and running.
Example:
OKThe version of the build.
Example:
2.0.0.1000
Status Code
Success
Internal Server Error
No Sample Response
Creates draft terms in the glossary
If the unique constraint on the name or display name of the term is violated, the method fails with 409 Conflict response.
POST /v3/glossary_terms
Request
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
Terms to be created. The terms array must contain at least 1 term, and cannot exceed 100 terms.
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1The list of abbreviations of a business term.
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Secondary categories the artifact belongs to.
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
Example
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The list of child business terms in the business term containment hierarchy.
The list of child business terms in the business term type hierarchy.
Name of the user who has created the term in the original source for imported term.
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*The timestamp when the term was created in the original source for imported term.
Possible values: 10 ≤ length ≤ 32
The usage of the term in the original source for imported term.
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*The list of parent business terms in the business term type hierarchy.
The list of parent business terms in the business term containment hierarchy.
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
The list of related business terms.
The list of business terms that are replaced by this business term.
The list of business terms that replace this business term.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The list of synonym business terms.
System business reference of a business term.
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Example:
SAP:MANDANT,AWS:XYZ123The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The workflow state of an artifact
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Success
Bad Request
Unauthorized
Not found
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Retrieves versions of a term for the given artifact_id and status
Retrieval of the versions of ACTIVE state is supported.
GET /v3/glossary_terms/{artifact_id}/versionsRequest
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Filter by term status.
Available statuses: DRAFTartifacts which are being created or modified and not in use PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
PUBLISHEDComma-separated list of relationship types.
Available types: is_a_type_of_termshas_type_termshas_types_term_hierarchysynonym_termsrelated_termsdata_classesis_of_termshas_termscategoriesparent_categoryclassificationspoliciesrulesreference_datareference_data_valuescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
List of paginated artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Deletes a draft or published version of an artifact
If the artifact state is DRAFT, then the draft version is deleted.
If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .
If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.
If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.
Administrator role is required.
DELETE /v3/glossary_terms/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the term to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the term to delete.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
A draft version has been successfully created for deleting the published artifact.
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Gets the term in the glossary with a given version id
This method can be used for retrieving details of an ACTIVE or DRAFT term.
GET /v3/glossary_terms/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the term to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the term to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_termshas_type_termshas_types_term_hierarchysynonym_termsrelated_termsdata_classesis_of_termshas_termscategoriesparent_categoryclassificationspoliciesrulesreference_datareference_data_valuescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Updates a draft or published artifact
If a published version is updated, a draft version is created from the published version and the draft version is updated with the requested changes and returned.If any relationships of the artifact are updated, then the updated relationships are returned as a paginated list limited by the give limit parameter. The relationships that are not updated are not returned.
PATCH /v3/glossary_terms/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the term to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the term to be updated.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
The business term to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out. If a relationship of the term is updated, then the updated relationship as returned as a paginated list limited by the give limit parameter. Relationships that are not updated are not returned.
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*The list of abbreviations of a business term.
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Secondary categories the artifact belongs to.
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
Example
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The list of child business terms in the business term containment hierarchy.
The list of child business terms in the business term type hierarchy.
Name of the user who has created the term in the original source for imported term.
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*The timestamp when the term was created in the original source for imported term.
Possible values: 10 ≤ length ≤ 32
The usage of the term in the original source for imported term.
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*The list of parent business terms in the business term type hierarchy.
The list of parent business terms in the business term containment hierarchy.
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
The list of related business terms.
The list of business terms that are replaced by this business term.
The list of business terms that replace this business term.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The list of synonym business terms.
System business reference of a business term.
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Example:
SAP:MANDANT,AWS:XYZ123The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*
List the relationships for the specified term
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/glossary_terms/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The guid of the Term
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The versionID of the Term
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: is_a_type_of_termshas_type_termshas_types_term_hierarchysynonym_termsrelated_termsdata_classesis_of_termshas_termscategoriesparent_categoryclassificationspoliciesrulesreference_datareference_data_valuescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4Is custom relationship reversed?
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Retrieves target parent category name of the relationship entity.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Create relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.
POST /v3/glossary_terms/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact ID of the term to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the term to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Relationships to be created.
Category relationships.
The relationships to the classifications.
The relationships to the data classes.
The list of child business terms in the business term containment hierarchy.
The list of child business terms in the business term type hierarchy.
The list of parent business terms in the business term type hierarchy.
The list of parent business terms in the business term containment hierarchy.
The parent category of the artifact.
The list of related business terms.
The list of business terms that are replaced by this business term.
The list of business terms that replace this business term.
The list of synonym business terms.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Success
Bad Request
Unauthorized
Not found
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Deletes relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and deletes the relationship from the draft version. And, it returns the details of the draft version.
DELETE /v3/glossary_terms/{artifact_id}/versions/{version_id}/relationships/{relationship_id}Request
Path Parameters
The artifact ID of the term to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the term to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Exports custom attribute definitions to a json file
This method can be used to export custom attribute definitions to a json file.
POST /v3/governance_artifact_types/custom_attribute_definitions/export
Request
Query Parameters
The comma-separated list of supported custom attribute types. Allowed values are text, date, number, enum, relationship, all, all_without_relationship.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
text,dateThe artifact type which a custom attribute definition applies to. Allowed values are category, glossary_term, data_class, policy, rule, classification, reference_data
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term,policyThe related artifact type which a custom attribute definition for relationship applies to. Allowed values are category, glossary_term, data_class, policy, rule, classification, reference_data
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term,policy
The list of custom attribute definitions artifact ids to be exported.
An example for resources with ids for custom attribute definitions
An example for resources with ids for custom attribute definitions
{
"resources": [
{
"artifact_id": "455b7b78-3d64-48e6-a9b6-e02f4c32295f"
}
]
}List of resources.
Import values for custom attribute definitions from specified json file
This method can be used to import values custom attribute definitions from specified json file.
POST /v3/governance_artifact_types/custom_attribute_definitions/import
Request
Query Parameters
Determines if only custom properties or custom relationships or both types will be imported. Allowed values: ALL, PROPERTY, RELATIONSHIP.
Allowable values: [
ALL,PROPERTY,RELATIONSHIP]Default:
ALLIf async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.
Form Parameters
File
Possible values: 1 ≤ length ≤ 2147483647
Response
Glossary Import Status
Children statuses
Completion time
Creation time
Error message
Heartbeat time
Heartbeater id
List of import messages
Operations count
- operations_count
Operations count
- any property
Operations count
Process Id
Status
Step message
Step number
Tenant Id
Total steps
Workflow Id
Status Code
Import of assets has been completed
Import of assets has been started
Unauthorized
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Export values of all supported types to a ZIP file
This method can be used to export values of all supported types to a ZIP file.
GET /v3/governance_artifact_types/export
Request
Query Parameters
This specifies if artifact ID numbers should be included in exported files, or not. Possible values: "always", artifact ID numbers are included for artifacts, and "never", not included at all.
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
alwaysExample:
alwaysThe comma-separated list of supported artifact types. Allowed values are all, category, classification, data_class, glossary_term, policy, rule, reference_data and role_assignment.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Default:
allExample:
category,glossary_termThe comma-separated list of categories ID numbers, or "all_top_level", which means all top-level categories.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Default:
all_top_levelExample:
e39ada11-8338-3704-90e3-681a71e7c839,c305c9fe-3223-48a0-b146-228a782bc7e4If parameter "include_custom_attribute_definitions" is set to true, information about suitable custom attribute definitions will be included in zip
Default:
falseIf parameter "include_development_log" is set to true, development log content will be included in zip
Default:
false
Import values from specified ZIP file
This method can be used to import values from specified ZIP file.
POST /v3/governance_artifact_types/import
Request
Query Parameters
Import merge option, valid values:
all - imported values will replace existing values in catalog
specified - imported values that are not empty replace existing values in catalog
empty - imported values replace only empty values in catalog.Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
specifiedExample:
specified
Form Parameters
File
Possible values: 1 ≤ length ≤ 2147483647
Response
Glossary Import Status
Children statuses
Completion time
Creation time
Error message
Heartbeat time
Heartbeater id
List of import messages
Operations count
- operations_count
Operations count
- any property
Operations count
Process Id
Status
Step message
Step number
Tenant Id
Total steps
Workflow Id
Status Code
Import of assets has been completed
Import of assets has been started
Unauthorized
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Cleanup ZIP import process
This method can be used to cleanup specified stalled ZIP import process that crashed or hanged. Note: This feature is experimental - the API and scope are subject to change. Should not be used on imports that are alive or pending as it can lead to unpredictable results.
POST /v3/governance_artifact_types/import/cleanup/{process_id}Import of assets status
Import of assets status
GET /v3/governance_artifact_types/import/status/{process_id}Request
Path Parameters
Import process id
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})
Query Parameters
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Default:
0
Response
Glossary Import Status
Children statuses
Completion time
Creation time
Error message
Heartbeat time
Heartbeater id
List of import messages
Operations count
- operations_count
Operations count
- any property
Operations count
Process Id
Status
Step message
Step number
Tenant Id
Total steps
Workflow Id
Status Code
Import status available
Unauthorized
Internal Server Error
No Sample Response
Get artifacts of given type that are either published or drafts matching specified criteria
This method can be used for retrieving artifacts of given type that are:
- published,
- drafts matching specified criteria (starts_with, substring, workflow_status, created_by, modified_by, enabled).
GET /v3/governance_artifact_types/{artifact_type}Request
Path Parameters
The artifact type. Allowed values are all, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
Query Parameters
First character of artifact, applicable only for draft artifact search.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
TesFilter on substring, applicable only for draft artifact search.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
estFilter by workflow status.
Available statuses (if no status is specified, all drafts are retrieved): publishedPublishing (applicable only for draft artifact search)Publish failed (applicable only for draft artifact search)Not started (applicable only for draft artifact search)Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
NOT_STARTEDFilter by creator of artifact, applicable only for draft artifact search.
Possible values: 1 ≤ length ≤ 73, Value must match regular expression
.*Example:
IBMid-1234567ABCFilter by editor of artifact, applicable only for draft artifact search.
Possible values: 1 ≤ length ≤ 73, Value must match regular expression
.*Example:
IBMid-1234567ABCFilter Results based on enabled flag for dataclass,
yeswill give enabled dataclass,nowill give disabled andbothshall return all, applicable only for draft artifact search.Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
yesThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Value on which results need to be sorted, valid sort parameters are NAME, MODIFIED, CREATED, TYPE.Prefix hyphen (-) for descending order, applicable only for draft artifact search.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
-NAME
Response
List of paginated workflow artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Artifacts have been retrieved successfully.
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Retrieves custom attribute definitions with given artifact type
This method can be used for retrieving details of custom attribute definitions.
GET /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitionsRequest
Path Parameters
The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
Query Parameters
Is the artifact type defined as related artifact type or not, in case of "RELATIONSHIP" type only!
Response
Used to facilitate serialization and correct swagger documentation.
Custom Attribute Definition Entity
Metadata of the entity.
Status Code
The custom attribute definitions have been retrieved successfully.
Unauthorized
The custom attribute definition with given {artifact_id} does not exist.
Internal Server Error
No Sample Response
Creates custom attribute definition in the glossary
This method can be used to create custom attribute definition in the glossary.
POST /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitionsRequest
Path Parameters
The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
Custom attribute definition to be created.
Name of custom attribute
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
ca def 1Type of custom attribute values
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
TEXTSet of artifact types
Possible values: 1 ≤ length ≤ 32, contains only unique items, Value must match regular expression
.*Examples:[ "glossary_term" ]Set of restricted category artifact ids
Possible values: length = 36, contains only unique items, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*The default value of the custom attribute
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
xyzDescription
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
description of custom attribute definitionSpecifies whether custom attribute values should be displayed in child assets
Example:
trueList of predefined values. Supported only for the type ENUM.
Maximum length of custom attribute values of the type string
Example:
500Maximum
Minimum length of custom attribute values of the type string
Example:
5Minimum
Specifies whether the custom attribute can have more than one value
Example:
trueSpecifies whether custom attribute values should be read only
Example:
trueSet of related artifact types
Possible values: 1 ≤ length ≤ 32, contains only unique items, Value must match regular expression
.*Set of restricted related category artifact ids
Possible values: length = 36, contains only unique items, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*Reversed Custom Attribute relationship name which may be display on the related artifact
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Term related to categorySpecifies whether custom attribute definition should be global search
Example:
true
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The custom attribute definition has been created successfully.
Bad Request
Unauthorized
UniqueConstraintViolation - custom attribute definition with given name already exists.
Internal Server Error
No Sample Response
Deletes the custom attribute definition with a given artifact_id
This method is used to delete the custom attribute definition with a given artifact_id (guid).
DELETE /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id}Request
Path Parameters
The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact_id of the custom attribute definition to be purged.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-030745831313
Response
Glossary archive response object
Guids of the archived objects.
Guids of the deleted objects.
Guids of the updated objects.
Status Code
The custom attribute definition has been deleted successfully.
Bad Request
Unauthorized
The custom attribute definition with given {artifact_id} does not exist.
Internal Server Error
No Sample Response
Retrieves custom attribute definition with given artifact_id
This method can be used for retrieving details of a custom attribute definition.
GET /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id}Request
Path Parameters
The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact_id of the custom attribute definition to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
d4a5e6e1-a6c0-4580-afbb-6898303adf34
Response
Used to facilitate serialization and correct swagger documentation.
Custom Attribute Definition Entity
Metadata of the entity.
Status Code
The custom attribute definition has been retrieved successfully.
Unauthorized
The custom attribute definition with given {artifact_id} does not exist.
Internal Server Error
No Sample Response
Updates custom attribute definition with given artifact_id
This method is used to update custom attribute definition with given artifact_id.
PATCH /v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id}Request
Path Parameters
The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact_id of the custom attribute definition to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})
Custom attribute definition to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"business_description" : "business desc updated"}
Set of artifact types
Possible values: 1 ≤ length ≤ 32, contains only unique items, Value must match regular expression
.*Examples:[ "glossary_term" ]Set of restricted category artifact ids
Possible values: length = 36, contains only unique items, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*The default value of the custom attribute
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
xyzDescription
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
description of custom attribute definitionSpecifies whether custom attribute values should be displayed in child assets
Example:
trueList of predefined values. Supported only for the type ENUM.
Maximum length of custom attribute values of the type string
Example:
500Maximum
Minimum length of custom attribute values of the type string
Example:
5Minimum
Name of custom attribute
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
ca def 1Specifies whether custom attribute values should be read only
Example:
trueSet of related artifact types
Possible values: 1 ≤ length ≤ 32, contains only unique items, Value must match regular expression
.*Set of restricted related category artifact ids
Possible values: length = 36, contains only unique items, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*Reversed Custom Attribute relationship name which may be display on the related artifact
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Term related to categorySpecifies whether custom attribute definition should be global search
Example:
true
Response
Used to facilitate serialization and correct swagger documentation.
Custom Attribute Definition Entity
Metadata of the entity.
Status Code
The custom attribute definition has been updated successfully.
Bad Request
Unauthorized
Forbidden
The custom attribute definition with given {artifact_id} does not exist.
The custom attribute definition was modified by another user.
Internal Server Error
No Sample Response
Delete a list of draft or published versions of given artifact_type
If the artifact state is DRAFT, then the draft version is deleted.
If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .
If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.
If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.
Administrator role is required.
POST /v3/governance_artifact_types/{artifact_type}/deleteRequest
Path Parameters
The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
Query Parameters
If async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
If someone has already created a draft for deleting or updating an artifact, then the artifact will be ignored.
If specified asset does does not exist, it is skipped.
Default:
false
The list of artifacts to be deleted. All the artifacts must be either in published state or draft state, but mix of draft and published state is not allowed.
List of resource identifiers.
Response
Status Code
A draft version has been successfully created for deleting the published artifact.
If async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.
The artifacts have been deleted successfully.
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Exports values of a specified type to a csv file
This method can be used to export values of a specified type to a csv file.
GET /v3/governance_artifact_types/{artifact_type}/exportRequest
Path Parameters
The artifact type. Allowed values are category, glossary_term, data_class, policy, rule, classification
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
Query Parameters
The artifactId of the parent category
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4Whether to include the parent category. This applies to category (as asset type) export only, and is ignored for other asset types. The special [uncategorized] category is not included.
Whether to include assets from subcategories
Import values from specified csv file
This method can be used to import values from specified csv file.
POST /v3/governance_artifact_types/{artifact_type}/importRequest
Path Parameters
The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
Query Parameters
Import merge option, valid values:
all - imported values will replace existing values in catalog
specified - imported values that are not empty replace existing values in catalog
empty - imported values replace only empty values in catalog.Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
emptyExample:
allIf async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.
Form Parameters
File
Possible values: 1 ≤ length ≤ 2147483647
Response
Glossary Import Status
Children statuses
Completion time
Creation time
Error message
Heartbeat time
Heartbeater id
List of import messages
Operations count
- operations_count
Operations count
- any property
Operations count
Process Id
Status
Step message
Step number
Tenant Id
Total steps
Workflow Id
Status Code
Import of assets has been completed
Import of assets has been started
Unauthorized
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Search for a list of drafts of given artifact_type
This method can be used for retrieving draft artifacts.
POST /v3/governance_artifact_types/{artifact_type}/searchRequest
Path Parameters
The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_term
The list of draft artifacts to be retrieved. If drafts exist, then they are returned.
List of resources.
Get the latest published version of the specified artifact
This method can be used for getting the latest published version of the specified artifact.
GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}Request
Path Parameters
The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termArtifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Comma-separated list of relationship types.
Relationship TypesArtifact Typescategoryclassificationdata_classglossary_termpolicyreference_dataruleall+ + + + + + + categories- + + + + + + child- - - - - + - classifications+ - + + + + + custom+ + + + + + + data_classes- + - + + + + data_location_rules- - - - + - - data_protection_rules- - - - + - - grouped_assets+ - - - - - - has_terms- - - + - - - has_type_terms- - - + - - - has_types_category+ - - - - - - has_types_classifications- + - - - - - has_types_classifications_hierarchy- + - - - - - has_types_data_class_hierarchy- - + - - - - has_types_data_classes- - + - - - - has_types_term_hierarchy- - - + - - - is_a_parent_category_for+ - - - - - - is_a_type_of_category+ - - - - - - is_a_type_of_classification- + - - - - - is_a_type_of_data_class- - + - - - - is_a_type_of_terms- - - + - - - is_of_terms- - - + - - - multi_value_mappings- - - - - + - owned_by+ - - - - - - parent- - - - - + - parent_category- + + + + + + parent_hierarchy- - - - - + - parent_policy- - - - + - - policies- + + + - - + reference_data- + + + - - + reference_data_values- - - + - - - related_categories- + - - - - - related_terms- - - + - - - replaced_by_terms- - - + - - - replaces_terms- - - + - - - rules- + + + + + + single_value_mappings- - - - - + - sub_policies- - - - + - - synonym_terms- - - + - - - terms- + + - + + + value_mappings- - - - - + - Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'false'.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
This parameter is ignored when artifact type is category.Possible values: 1 ≤ value ≤ 200
Default:
10If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
This parameter is ignored when artifact type is category.
Response
Represents an object that we send back to the end user. It has two parts: entity and metadata.
Base object for entity
Metadata of the entity.
Status Code
The latest published version of the specified artifact has been retrieved successfully.
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Changes the parent category of a published artifact with given id
This method can be used to change given artifact parent. Or make it root-level, in case of category.
Note: change of collaborators access may take longer to complete
POST /v3/governance_artifact_types/{artifact_type}/{artifact_id}/moveRequest
Path Parameters
The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termArtifact ID or global ID of the artifact
Possible values: 1 ≤ length ≤ 73, Value must match regular expression
.*
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Target category (to become a parent of this artifact)
specifies id of category to become parent after move. One can specify either artifact ID or global ID. In case of category, one can specify string
ROOTto move it to the top levelPossible values: 1 ≤ length ≤ 73, Value must match regular expression
.*Example:
e39ada11-8338-3704-90e3-681a71e7c839
Response
Represents an object that we send back to the end user. It has two parts: entity and metadata.
Base object for entity
Metadata of the entity.
Status Code
The artifact has been moved successfully.
Bad Request
Unauthorized
Forbidden
Published artifact not found for given guid
Either the artifact was modified by another user, or the same artifact already exists with the same new parent category
Internal Server Error
No Sample Response
Get development logs & Comments for a draft artifact version
Get development logs & Comments for a draft artifact version
GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/aggregated_logsRequest
Path Parameters
The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Time zone offset based on which the day wise grouping is to be performed. The offset will be of format [+-]hh:mm where hh stands for hour digit and mm for minute digit.
e.g. +05:30 indicates IST. If [+-] is not provided by default + will be appended. e.g 05:30 indicates +05:30.
If hour digit is single like +h:mm provided, then it will be considered as +0h:mm. e.g. +5:30 indicates +05:30.
The range of offsets is restricted to -17:59 to +17:59 inclusive.Possible values: 1 ≤ length ≤ 6, Value must match regular expression
^([+-]?)(0[0-9]|1[0-7]|[0-9]):([0-5][0-9])$
Response
List of paginated asset aggregated comments
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Development logs & Comments retrieved successfully
Bad Request
Unauthorized
Forbidden
Draft artifact version not found for given version_id
Internal Server Error
No Sample Response
Get development logs & Comments for a draft artifact version with development log id
Get development logs & Comments for a draft artifact version with development log id
GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/aggregated_logs/{mod_id}Request
Path Parameters
The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*The development log id.
Possible values: 1 ≤ length ≤ 73, Value must match regular expression
.*
Query Parameters
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Paginated asset comment modification details
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Development logs & Comments retrieved successfully
Bad Request
Unauthorized
Forbidden
Draft artifact version not found for given version_id
Internal Server Error
No Sample Response
Add a comment for a draft artifact version
Add a comment for a draft artifact version
POST /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/commentsRequest
Path Parameters
The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
The user comment.
User comment
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Indicates whether the development log entry originates from import
Response
Comment By User
User comment
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Indicates whether the development log entry originates from import
Status Code
Comment added successfully
Bad Request
Unauthorized
Forbidden
Draft artifact version not found for given version_id
Internal Server Error
No Sample Response
Delete a comment on a draft artifact version
Delete a comment on a draft artifact version
DELETE /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments/{comment_id}Request
Path Parameters
The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4The version id.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4The comment id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4
Update a comment on a draft artifact version
Update a comment on a draft artifact version
PATCH /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments/{comment_id}Request
Path Parameters
The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4The version id.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4The comment id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4
The user comment.
User comment
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Indicates whether the development log entry originates from import
Response
Comment By User
User comment
Possible values: 1 ≤ length ≤ 32672, Value must match regular expression
.*Indicates whether the development log entry originates from import
Status Code
Comment updated successfully
Bad Request
Unauthorized
Draft artifact version not found for given version_id
Internal Server Error
No Sample Response
Get development logs & Comments for a draft artifact version
Get development logs & Comments for a draft artifact version
GET /v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/logsRequest
Path Parameters
The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule
Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Example:
glossary_termThe artifact id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})The version id.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*
Query Parameters
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Paginated Asset Comment List
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Development logs & Comments retrieved successfully
Bad Request
Unauthorized
Forbidden
Draft artifact version not found for given version_id
Internal Server Error
No Sample Response
Request
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
Represents a policy to be created, used for policy POST request.
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1Secondary categories the artifact belongs to.
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
Relationships to data location rules only. Does not include other rule relationships.
Relationships to data protection rules only. Does not include other rule relationships.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The parent category of the artifact.
The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
Relationships to governance rules only. Does not include other rule relationships.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The list of sub-policies in the policy type hierarchy.
The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Relationships to business terms.
The workflow state of an artifact
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The policy has been created successfully.
Bad Request
Unauthorized
UniqueConstraintViolation - policy with given name already exists.
Internal Server Error
No Sample Response
Retrieves versions of a policy for the given artifact_id and status
Retrieval of the versions of ACTIVE state is supported.
GET /v3/policies/{artifact_id}/versionsRequest
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Filter by policy status.
Available statuses: DRAFTartifacts which are being created or modified and not in use PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
PUBLISHEDComma-separated list of relationship types.
Available types: parent_policysub_policiesparent_categorycategoriestermsclassificationsrulesdata_location_rulesdata_protection_rulescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Response
List of paginated artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
No Sample Response
Deletes a draft or published version of an artifact
If the artifact state is DRAFT, then the draft version is deleted.
If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .
If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.
If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.
Administrator role is required.
DELETE /v3/policies/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact ID of the policy.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the policy to delete or to create mark-for-delete draft copy.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The artifact has been deleted successfully.
A draft version has been successfully created for deleting the published artifact.
Bad Request
Unauthorized
Policy with sub-policies cannot be deleted. Try again after re-parenting sub-policies.
Policy with given artifact and version ids does not exist in the glossary.
Internal Server Error
No Sample Response
Retrieves versions of a policy for the given artifact_id and status
Retrieval of the versions of ACTIVE state is supported.
GET /v3/policies/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact ID of the policy to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the policy to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: parent_policysub_policiesparent_categorycategoriestermsclassificationsrulesdata_location_rulesdata_protection_rulescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Response
Policy returned by REST GET method that includes the relationships as paginated list.
Policy entity for GET response.
Metadata of the entity.
Status Code
The policy has been retrieved successfully.
Unauthorized
The policy with given {guid} does not exist in the glossary.
Internal Server Error
No Sample Response
Updates policy with given artifact id and version id
Updates policy with given artifact id and version id. If the policy is in published state then first creates a draft and applies the changes to the newly created draft.
PATCH /v3/policies/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the policy to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the policy to be updated.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
The policy to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Secondary categories the artifact belongs to.
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
Relationships to data location rules only. Does not include other rule relationships.
Relationships to data protection rules only. Does not include other rule relationships.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1The parent category of the artifact.
The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
Relationships to governance rules only. Does not include other rule relationships.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The list of sub-policies in the policy type hierarchy.
The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Relationships to business terms.
Response
Policy returned by REST GET method that includes the relationships as paginated list.
Policy entity for GET response.
Metadata of the entity.
Status Code
The policy has been updated successfully.
Bad Request
Unauthorized
Forbidden
The policy with given {guid} does not exist in the glossary.
The policy was modified by another user.
Internal Server Error
No Sample Response
Updates DPR rule relationships of a published policy using its artifact id and version id
Updates DPR rule relationships of a published policy using its artifact id and version id
Deprecated, functionality will be replaced by new one introduced in the feature releases.
PATCH /v3/policies/{artifact_id}/versions/{version_id}/data_protection_rulesRequest
Path Parameters
The artifact id of the policy to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})The version id of the policy to be updated.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
The parent category of the artifact.
Artifact id of the related artifact.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4
Response
Policy returned by REST GET method that includes the relationships as paginated list.
Policy entity for GET response.
Metadata of the entity.
Status Code
The policy has been updated successfully.
Bad Request
Unauthorized
Forbidden
The policy with given {guid} does not exist in the glossary.
The policy was modified by another user.
Internal Server Error
No Sample Response
List the relationships for the specified policy
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/policies/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The guid of the Policy
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The versionID of the Policy
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: parent_policysub_policiesparent_categorycategoriestermsclassificationsrulesdata_location_rulesdata_protection_rulescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4Is custom relationship reversed?
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Retrieves target parent category name of the relationship entity.
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
No Sample Response
Create relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.
POST /v3/policies/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact ID of the term to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the term to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Relationships to be created.
Category relationships.
Relationships to classifications.
Relationships to data classes.
Relationships to data location rules only. Does not include other rule relationships.
Relationships to data protection rules only. Does not include other rule relationships.
The parent category of the artifact.
The parent category of the artifact.
Relationships to governance rules only. Does not include other rule relationships.
The list of sub-policies in the policy type hierarchy.
Relationships to business terms.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Success
Bad Request
Unauthorized
Not found
Unique constraint violated because of optimistic locking or some other constraint.
Internal Server Error
No Sample Response
Deletes a relationship from a draft policy
Deletes a relationship from a draft policy
DELETE /v3/policies/{artifact_id}/versions/{version_id}/relationships/{relationship_id}Request
Path Parameters
The artifact ID of the policy to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the policy to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Create a reference data set
Create a reference data set
Note: For Reference Data values, precision will be lost if long value has more than 15-16 digits as JSON parser will map to double type regardless of whether it is used for integer, long or floating-point numbers. To Preserve all digits pass the value as a string.
POST /v3/reference_data
Request
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
Represents a Reference Data Set to be created for RDS V3 API version.
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
reference data set nameSecondary categories the artifact belongs to.
The relationships to reference data sets.
Relationships to classifications.
RDS custom columns add request
Custom relationships to asset
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
description of reference data setThe relationships to reference data sets.
The parent category of the artifact.
The value entities for rds.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]Stewards Ids
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
Type
Allowable values: [
TEXT,NUMBER,DATE]Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
TEXT
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The reference data set has been created successfully.
Bad Request
Unauthorized
Reference data set with given name already exists.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Delete a list of Custom Column definitions with specified column_ids
Delete a list of Custom Column definitions with specified column_ids
DELETE /v3/reference_data/custom_columns
Response
RDS custom columns delete response list
resources of custom columns.
Status Code
List of Custom Column definitions has been deleted successfully.
Bad Request
Unauthorized
Forbidden
The Custom Column definition with given {column_id} does not exist.
Internal Server Error
{ "resources": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT" } ] }
Retrieve Custom Column definitions
Fetches Custom Column definitions.
Use filter_by_name to provide search criteria and sort_order=asc/desc to order result.By default order will be asc.
GET /v3/reference_data/custom_columns
Request
Query Parameters
Filter the Custom Column definitions by name.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Sort direction for Custom Column names.
Allowable values: [
ASC,DESC]Default:
ASCThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Paginated Reference Data Set custom columns response list
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
List of Custom Column definitions has been retrieved successfully.
Unauthorized
The Custom Column definition with given {column_id} does not exist.
Internal Server Error
{ "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "id": "8b047b17-8e31-4382-be19-e873d46d32a8", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "created_at": "2017-02-15T02:30:32Z", "created_by": "IBMid-1234567ABC", "revision": "0" }, "entity": { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } } ] }
Create Custom Column definitions
Create Custom Column definitions
- Allowed Custom Column definitions types:
NUMBER, TEXT, DATE. - If a column is a composite key, it must be mandatory.
- For
NUMBERandTEXTtypes the default values formax_characters_count:- for a composite key column: 200,
- for a normal column: 2000.
validator_rds_idmust be an artifact id of a published RDS.
POST /v3/reference_data/custom_columns
Response
Custom column create response
resources of custom columns.
Status Code
The Custom Column(s) have been created successfully.
Bad Request
Unauthorized
UniqueConstraintViolation - Custom Column definition with given name already exists.
Internal Server Error
{ "resources": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ] }
Delete a Custom Column definition by column_id
Delete a Custom Column definition by column_id
DELETE /v3/reference_data/custom_columns/{column_id}Request
Path Parameters
The column id associated with Custom Column definition.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
83a7a25a-4a51-4053-a6e7-4e374d26fe1a
Response
resources of custom columns.
name
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Custom Column NameDeterminate if it is a part of composite key. If a column is a composite key, it must be mandatory.
Determines if column is hidden
Custom Column Definition Id
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4Determinate if it is mandatory
Allowed maximum character count
Possible values: 1 ≤ value ≤ 2000, Value must match regular expression
\d*Example:
2000Artifact id of reference data set owning this custom column
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
9ec35f22-db7f-56c9-8a05-25983e485adcCustom Column definitions type.
Possible values: [
NUMBER,TEXT,DATE]Example:
TEXTArtifact id of reference data set validating this custom column
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
d58b8247-8f94-4c1f-8ea1-48f1cb55122a
Status Code
The Custom Column definition has been deleted successfully with specified column_id.
Bad Request
Unauthorized
Internal Server Error
{ "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT" }
Retrieve a Custom Column definition with given column_id
Retrieve a Custom Column definition with given column_id
GET /v3/reference_data/custom_columns/{column_id}Request
Path Parameters
The guid of the Custom Column definition.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})
Response
RDS Custom Columns Get Response
List of composite key members
metadata of cust columns.
Status Code
Custom Column definition with given column_id has been retrieved successfully.
Unauthorized
The Custom Column definition with given {column_id} does not exist.
Internal Server Error
{ "metadata": { "id": "8b047b17-8e31-4382-be19-e873d46d32a8", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "created_at": "2017-02-15T02:30:32Z", "created_by": "IBMid-1234567ABC", "revision": "0" }, "entity": { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } }
Update Custom Column properties with given column_id
Update Custom Column properties with given column_id
PATCH /v3/reference_data/custom_columns/{column_id}Request
Path Parameters
The column id associated with Custom Column definition.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})
Custom Column name/description to be updated.
name
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Custom Column NameThe revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Example:
0description
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Custom Column DescriptionDeterminate if it is mandatory
Allowed maximum character count
Possible values: 1 ≤ value ≤ 2000, Value must match regular expression
\d*Example:
2000Artifact id of reference data set validating this custom column
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
d58b8247-8f94-4c1f-8ea1-48f1cb55122a
Response
List of composite key members
name
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Custom Column NameDeterminate if it is a part of composite key. If a column is a composite key, it must be mandatory.
description
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Custom Column DescriptionDetermines if column is hidden
Custom Column Definition Id
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4Determinate if it is mandatory
Allowed maximum character count
Possible values: 1 ≤ value ≤ 2000, Value must match regular expression
\d*Example:
2000Artifact id of reference data set owning this custom column
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
9ec35f22-db7f-56c9-8a05-25983e485adcThe revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Example:
0Custom Column definitions type.
Possible values: [
NUMBER,TEXT,DATE]Example:
TEXTArtifact id of reference data set validating this custom column
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
d58b8247-8f94-4c1f-8ea1-48f1cb55122a
Status Code
The Custom Column definition has been updated successfully.
Bad Request
Unauthorized
Forbidden
The Custom Column definition with given {column_id} does not exist.
The Custom Column was modified by another user.
Internal Server Error
{ "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false }
Retrieve a reference data set with given artifact_id and status
This method can be used for retrieving details of an ACTIVE, PUBLISHED or DRAFT reference data set.
GET /v3/reference_data/{artifact_id}/versionsRequest
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Filter by reference data set status.
Available statuses: DRAFTartifacts which are being created or modified and not in use PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
PUBLISHEDComma-separated list of relationship types.
Available types: parent_categorycategoriestermsclassificationsdata_classesruleschildparentcustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueThe maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Response
List of paginated artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
The reference data set has been retrieved successfully.
Bad Request
Unauthorized
The reference data set with given {guid} does not exist.
Internal Server Error
{ "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } } ] }
Delete a reference data set with given artifact_id and version_id
Delete the reference data set with a given artifact_id and version_id. If the artifact is published then a workflow will be started with a draft created with label marked for deletion which on approval will result in a actual delete. If the artifact is a draft copy then the draft copy will be deleted from the system.
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
specify parent/root/code
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
A draft version has been successfully created for deleting the published artifact.
The reference data set has been deleted successfully.
Bad Request
Unauthorized
The reference data set with given {guid} does not exist.
The reference data set is currently used in catalog assets, catalog asset columns, data governance rules or data governance policies.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Retrieve a reference data set with given artifact_id and version_id
This method will retrieve details of the specified reference data set.
GET /v3/reference_data/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Fetch reference data value by code or text value fragment
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*sort direction for code
Allowable values: [
ASC,DESC]Default:
ASCfetch children of specific code
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*fetch reference data value as flat list of values or in hierarchical manner one level at a time. Level is determined by the parameter parent_code which indicate root value of the level.
Allowable values: [
FLAT,HIERARCHICAL]Default:
FLATComma-separated list of relationship types for reference data value.
Available types: termsparent_hierarchychildparentsingle_value_mappingsmulti_value_mappingsvalue_mappingsallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Fetch reference data value with given exact code
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Comma-separated list of relationship types.
Available types: parent_categorycategoriestermsclassificationsdata_classesruleschildparentcustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Fetch Custom Column definition for reference dataset.
Default:
trueFetch custom column values for reference data set values.
If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
The maximum number of relationships to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10The index of the first matching relationship to include in the result.
The maximum number of reference data values to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10The index of the first matching value to include in the result.
Response
Response Reference Data Set
Reference Data Set entity returned by REST GET method that includes the relationships as paginated list.
Metadata of the entity.
Status Code
The reference data set has been retrieved successfully.
Unauthorized
The reference data set with given {guid} does not exist.
Internal Server Error
{ "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "classifications": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent_category": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "parent_id": "303ed1d2-0885-473e-9050-40f9223549d5", "parent_global_id": "TEMPLATE_303ed1d2-0885-473e-9050-40f9223549d5", "parent_name": "name_example", "parent_href": "/v3/categories/303ed1d2-0885-473e-9050-40f9223549d5", "parent_enabled": true, "child_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_global_id": "TEMPLATE_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_category_id": "303ed1d2-0885-473e-9050-40f9223549d5", "child_name": "rds_name1", "child_href": "/v3/reference_data/0d6412d5-fce8-4bb7-90c9-891bc3de5c4b/versions?status=ACTIVE", "relationship_type": "parent_category", "source_type": "reference_data", "target_type": "category", "description": "parent example", "reference_copy": false } } ] }, "categories": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "rds_values": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ] }, "custom_columns": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "rds_values_total_counts": 1, "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } }
Update a reference data set with given artifact id and version id
Update a reference data set with given artifact id and version id
PATCH /v3/reference_data/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
The reference data set to be updated.
Fields omitted will be unchanged. For multi-valued attributes, like values and relationships, use the respective endpoints.
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Example:
0Secondary categories the artifact belongs to.
The relationships to reference data sets.
Custom relationships to asset
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
description of reference data setThe name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
ISO Country CodesThe relationships to reference data sets.
The parent category of the artifact.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
The steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]Stewards Ids
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]
Response
Response Reference Data Set
Reference Data Set entity returned by REST GET method that includes the relationships as paginated list.
Metadata of the entity.
Status Code
The reference data set has been updated successfully.
Bad Request
Unauthorized
Forbidden
The reference data set with given {guid} does not exist.
The reference data set was modified by another user.
Internal Server Error
{ "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "rds_values": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ] }, "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } }
Delete Custom Column definitions with specified column_ids associated with a reference data set
Delete Custom Column definitions with specified column_ids associated with a reference data set
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}/custom_columnsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
The list of column_ids to be removed.
Revision
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*List of custom columns
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationships to asset
Indicates that it is a reference copy of an artifact managed in an external metadata server.
Response
Response Reference Data Set
Reference Data Set entity returned by REST GET method that includes the relationships as paginated list.
Metadata of the entity.
Status Code
The Custom Column definition has been deleted successfully with specified column_id.
Bad Request
Unauthorized
Forbidden
The Custom Column definition with given {column_id} does not exist.
The Custom Column was modified by another user.
Internal Server Error
{ "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "rds_values": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ] }, "custom_columns": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } }
Associate Custom Column definitions to a reference data set
Associate Custom Column definitions to a reference data set
PUT /v3/reference_data/{artifact_id}/versions/{version_id}/custom_columnsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Custom Column name/description to be updated.
Revision
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*List of custom columns
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationships to asset
Indicates that it is a reference copy of an artifact managed in an external metadata server.
Response
Response Reference Data Set
Reference Data Set entity returned by REST GET method that includes the relationships as paginated list.
Metadata of the entity.
Status Code
The Custom Column definition has been updated successfully.
Bad Request
Unauthorized
Forbidden
The Custom Column definition with given {column_id} does not exist.
The Custom Column was modified by another user.
Internal Server Error
{ "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "rds_values": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ] }, "custom_columns": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } }
List the relationships of the given type for the specified reference data set
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/reference_data/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: parent_categorycategoriestermsclassificationsdata_classesruleschildparentcustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Is custom relationship reversed?
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Retrieves target parent category name of the relationship entity.
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "classifications": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent_category": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "parent_id": "303ed1d2-0885-473e-9050-40f9223549d5", "parent_global_id": "TEMPLATE_303ed1d2-0885-473e-9050-40f9223549d5", "parent_name": "name_example", "parent_href": "/v3/categories/303ed1d2-0885-473e-9050-40f9223549d5", "parent_enabled": true, "child_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_global_id": "TEMPLATE_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_category_id": "303ed1d2-0885-473e-9050-40f9223549d5", "child_name": "rds_name1", "child_href": "/v3/reference_data/0d6412d5-fce8-4bb7-90c9-891bc3de5c4b/versions?status=ACTIVE", "relationship_type": "parent_category", "source_type": "reference_data", "target_type": "category", "description": "parent example", "reference_copy": false } } ] }, "categories": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] } }
Associate Reference data set identified by artifact_id and version_id with other governance artifacts
Associate Reference data set identified by artifact_id and version_id with other governance artifacts
POST /v3/reference_data/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
list of relationships that need to created for reference data set
Category relationships.
New relationship with reference data set.
The relationships to classifications.
New relationship with reference data set.
The parent category of the artifact.
The relationships to business terms.
Response
Create relationship response
IDs of the created items.
Status Code
Relationships created for reference data set
Bad Request
Unauthorized
Relationships conflicting for reference data set
Internal Server Error
{ "resources": [ { "terms": [ { "relationship_id": "fdbf64ed-8d72-43b8-8752-8b765db51e01", "target_id": "4ce5b4d5-611e-4607-8e18-e2a7d9abbfe7" } ], "classifications": [], "categories": [ { "relationship_id": "eca11f9e-ff14-4692-ad93-35eb364f9f23", "target_id": "166a5f6b-3f42-4706-b868-92f622d5094a" } ], "child": [ { "relationship_id": "382c8bfa-5c2f-4daf-ac6e-b625119b1c6f", "target_id": "eec1c2a4-8bc1-40a6-a557-49af6ab2675d" } ], "parent": [], "parent_category": { "relationship_id": "18d9732c-f1b9-4325-bbf6-7d318e093263", "target_id": "4cdd7c5f-bc32-4d94-bb75-0344a6f93052" }, "href": "string", "artifact_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "version_id": "cf6243fb-7d5c-4aba-9f50-887919bf08be", "workflow_id": "52f149f8-c15c-40a9-a7ec-7e1d2635a1a1", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "entity_type": "reference_data" } ] }
Delete the relationship associated to reference data set with specified artifact_id and version_id
Delete the relationship associated to reference data set with specified artifact_id and version_id
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}/relationships/{relationship_id}Request
Path Parameters
The guid of the reference data set from which relationship is to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Deleted the relationship
Bad Request
Unauthorized
relationship not found
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Delete the reference data value identified by code in the Reference Data Set with specified artifact_id and version_id
Delete the reference data value identified by code in the Reference Data Set with specified artifact_id and version_id. If the reference data set is published then a workflow will be started with a draft created from which the value will be deleted. If the artifact is a draft copy then the value from the draft copy will be removed.
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}/valuesRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
specify parent/root/code
Allowable values: [
immediate_parent,root,code]specify to_code
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The reference data value has been deleted successfully.
Bad Request
Unauthorized
The reference data value with given {guid} and {code} does not exist.
The reference data value is currently used in catalog assets, catalog asset columns, data governance rules or data governance policies.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Exports values of a specified reference data set with specified artifact_id and version_id to a csv file along with their term associations and value mappings
Exports values of a specified reference data set with specified artifact_id and version_id to a csv file along with their term associations and value mappings.To verify a successful download, user need to cross verify the csv file by comparing number of rows with the response header "total-values-count" which contains number of values present in the Reference DataSet.
GET /v3/reference_data/{artifact_id}/versions/{version_id}/valuesRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Specify if only RDS code needs to be exported.
Include associated terms to a reference data value.
Include column mappings to a reference data value.
Default:
true
Update the reference data values identified by code in the Reference Data Set with specified artifact_id and version_id
Update the reference data values identified by code in the Reference Data Set with specified artifact_id and version_id
PATCH /v3/reference_data/{artifact_id}/versions/{version_id}/valuesRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Reference data values to be updated.
Note: Precision will be lost if long value has more than 15-16 digits as JSON parser will map to double type regardless of whether it is used for integer, long or floating-point numbers. To Preserve all digits pass the value as a string.
Reference data values.
Response
Create RDV response
IDs of the created items.
Status Code
The reference data set has been updated successfully.
Bad Request
Unauthorized
Forbidden
The reference data set with given {guid} does not exist.
The reference data set was modified by another user.
Internal Server Error
{ "resources": [ { "rds_values": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Add reference data values to the specified reference data set
Add reference data values to the specified reference data set
PUT /v3/reference_data/{artifact_id}/versions/{version_id}/valuesRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Reference Data Values List
The Reference data values.
Response
Create RDV response
IDs of the created items.
Status Code
The reference data value(s) have been added successfully.
Bad Request
Unauthorized
Reference data value with given code already exists.
Internal Server Error
{ "resources": [ { "rds_values": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Retrieves all reference data value codes for given set version_id
This method will retrieve all reference data value codes for specific reference data set
GET /v3/reference_data/{artifact_id}/versions/{version_id}/values/codesRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
The maximum number of reference data codes to return - must be at least 1 and cannot exceed 25000. The default value is 1000.
Possible values: 1 ≤ value ≤ 25000
Default:
1000Last fetched CODE.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Response
Status Code
The reference data value codes have been retrieved successfully.
Unauthorized
The reference data set with given {versionId} does not exist.
Internal Server Error
{ "set_uri": false, "limit": 100, "count": 2, "first": { "href": "string", }, "next": { "href": "string", "offset": Argentina }, "resources": [ "Brasil", "Chile" ] }
Import reference data values from csv file to the 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
To check the current status
of the import please use the endpoint GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports/{import_id}.
PUT /v3/reference_data/{artifact_id}/versions/{version_id}/values/importRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Column name(number if is_first_row_header is false) of the code field in CSV file.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Does the csv file have header as first record
Default:
trueColumn name(number if is_first_row_header is false) of the value field in CSV file.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Column name(number if is_first_row_header is false) of the description field in CSV file.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Column name(number if is_first_row_header is false) of the parent field in CSV file.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Associate terms to a reference data value.
Import value mappings only to a reference data value.
Import parent relationship only to a reference data value.
Column name(number if is_first_row_header is false) of the related terms field in CSV file.
If column name not provided, default column name related terms or related_terms either case will pick from the CSV filePossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
IGNORE/OVERWRITE/REJECT if a value already exists. default is OVERWRITE
Allowable values: [
OVERWRITE,IGNORE,REJECT]Default:
OVERWRITESpecify if to trim leading and trailing spaces for code, value & description.
Form Parameters
File name
Possible values: 1 ≤ length ≤ 2147483647
Custom columns mappings as json {"custom_columns_map":[{"csv_column_name":"cc-from-csv","custom_column_name":"cc-name"}]}
Possible values: 1 ≤ length ≤ 2147483647
Response
Create RDS Response
IDs of the created items.
Status Code
The reference data values import has been initiated successfully.
Bad Request
Unauthorized
Internal Server Error
{ "resources": [ { "log": { "href": "string", "import_id": "39719288-2dd7-426e-be8b-f41bde3fbd3c", "import_state": "IN_PROGRESS", "import_message": "Import in progress", "values_count": 100, "values_processed": 0 }, "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Request cancellation of a ongoing reference data values import process with specified import_id
Request cancellation of a ongoing reference data values import process with specified import_id
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}/values/import/{import_id}Request
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The import id for the reference data values import process.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
83a7a25a-4a51-4053-a6e7-4e374d26fe1a
Response
RDV Import Info Response
RDV import info
Status Code
Cancel Request Accepted
Bad Request
Unauthorized
Internal Server Error
{ "import_info": { "href": "Url value", "import_id": "d3516e0e-3775-498c-ba32-ce8fb0863376", "import_state": "SUCCEEDED, CANCELLED, IN_PROGRESS, etc", "import_message": "Import Completed, Import Cancelled, Import in progress, etc", "values_count": 1000, "values_processed": 1000, "values_skipped": 0, "values_inserted": 1000, "rels_values_processed": 1000, "rels_processed": 412, "rels_inserted": 400, "rels_skipped": 2, "rels_deleted": 10, "started_by": "IBMid-1234567ABC", "start_time": "2021-02-18T02:30:32Z", "warnings_count": 2, "warnings": [ { "row": 3, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code IT and artifactId ca72921f-1064-4aa4-b4bd-bc66405cdde4 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by CAN that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] }, { "row": 4, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code AUS and artifactId 6e3fe150-c648-4d8f-8519-2298379ea777 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by PAK that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] } ] } }
Get current state of reference data values import process with specified import_id
Get current state of reference data values import process with specified import_id
GET /v3/reference_data/{artifact_id}/versions/{version_id}/values/import/{import_id}Request
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The import id for the reference data values import process.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
83a7a25a-4a51-4053-a6e7-4e374d26fe1a
Response
RDV Import Info Response
RDV import info
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "import_info": { "href": "Url value", "import_id": "d3516e0e-3775-498c-ba32-ce8fb0863376", "import_state": "SUCCEEDED, CANCELLED, IN_PROGRESS, etc", "import_message": "Import Completed, Import Cancelled, Import in progress, etc", "values_count": 1000, "values_processed": 1000, "values_skipped": 0, "values_inserted": 1000, "rels_values_processed": 1000, "rels_processed": 412, "rels_inserted": 400, "rels_skipped": 2, "rels_deleted": 10, "started_by": "IBMid-1234567ABC", "start_time": "2021-02-18T02:30:32Z", "warnings_count": 2, "warnings": [ { "row": 3, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code IT and artifactId ca72921f-1064-4aa4-b4bd-bc66405cdde4 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by CAN that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] }, { "row": 4, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code AUS and artifactId 6e3fe150-c648-4d8f-8519-2298379ea777 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by PAK that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] } ] } }
Restart reference data values import process which was previously cancelled
Restart reference data values import process which was previously cancelled
POST /v3/reference_data/{artifact_id}/versions/{version_id}/values/import/{import_id}Request
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Import id to for the specific import action
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
990e33f5-3108-4d45-a530-0307458362d4
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Import of values for given import Id is started
Bad Request
Unauthorized
Reference data set with given name already exists.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Delete Custom Column values associated with a reference data value
Delete Custom Column values associated with a reference data value
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}/values/{code}/custom_columnsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Code of reference data value
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
The list of column_ids to be removed.
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Example:
0Custom column values to be deleted.
Response
Create RDV response
IDs of the created items.
Status Code
The Custom Column definition has been deleted successfully with specified column_id.
Bad Request
Unauthorized
Forbidden
The Custom Column definition with given {column_id} does not exist.
The Custom Column was modified by another user.
Internal Server Error
{ "resources": [ { "rds_values": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
List Custom Column values associated with a reference data value
If the result set is larger than the limit parameter, it returns the first limit number of Custom Column values.
To retrieve the next set of Custom Column values, call the method again by using the URI in PaginatedRDSCustomColumnsGetResponseList.next returned by this method.
GET /v3/reference_data/{artifact_id}/versions/{version_id}/values/{code}/custom_columnsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Code of reference data value
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Query Parameters
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Reference Data Value custom column response list
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The revision of the artifact. It is used for optimistic locking.
Example:
0The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "revision": "0", "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "id": "64ca5e02-5887-4e33-81ef-da48fe34afd4", "name": "COLUMN_EXAMPLE_NAME", "type": "TEXT" }, "entity": { "value": "string" } } ] }
Update Custom Column values associated with a reference data value
Update Custom Column values associated with a reference data value
PATCH /v3/reference_data/{artifact_id}/versions/{version_id}/values/{code}/custom_columnsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Code of reference data value
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Custom Column name/description to be updated.
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Example:
0Custom column values to be updated.
Response
Create RDV response
IDs of the created items.
Status Code
The Custom Column definition has been updated successfully.
Bad Request
Unauthorized
Forbidden
The Custom Column definition with given {column_id} does not exist.
The Custom Column was modified by another user.
Internal Server Error
{ "resources": [ { "rds_values": [ { "code": "CODE_EXAMPLE", "value": "string", "description": "This is an RDS Value example", "revision": "0" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
List the relationships of the given type for the specified reference data value
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/reference_data/{artifact_id}/versions/{version_id}/values/{code}/relationshipsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Code of reference data value
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Query Parameters
Comma-separated list of relationship types for reference data value.
Available types: termsparent_hierarchychildparentsingle_value_mappingsmulti_value_mappingsvalue_mappingsallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Reference Data Value Relationship Response
Paginated relationships
The relationships to reference data values.
Paginated relationships
Paginated relationships
The relationships to reference data values.
Paginated relationships
The relationships to reference data values.
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_version_id": "86e9513a-c8ed-40a1-93d5-d6bbd32b1291", "rds_name": "rds_name_example", "codes": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] } ] }, "parent": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "parent_hierarchy": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] } }
Creates relationships for reference data value
Creates relationships for reference data value
POST /v3/reference_data/{artifact_id}/versions/{version_id}/values/{code}/relationshipsRequest
Path Parameters
The artifact id of the reference data set.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Code of reference data value for which terms are to be assigned
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
Reference Data Value Relationships
The relationships to other reference data values as child.
The relationships to other reference data values as multi value mapping.
The parent category of the artifact.
The relationship to other reference data value as single value mapping.
The relationships to business terms.
Response
create value relationship response
IDs of the created items.
Status Code
Relationships created for reference data set
Bad Request
Unauthorized
Relationships conflicting for reference data set
Internal Server Error
{ "resources": [ { "rds_values": [ { "code": "CODE_EXAMPLE", "terms": [ { "relationship_id": "d5e5ba23-ee69-47f1-beb3-b09d29374455", "target_id": "6a8f8630-5cff-4c42-a8f9-1f24371ad80c" } ], "child": [ { "relationship_id": "c2a28f38-6a96-4aca-8daf-c1e09cd402ad", "target_id": "b710c60f-4c29-5f48-bb99-431aad664cc3" } ], "parent": { "relationship_id": "ab8efc36-ddaf-4d81-8fcb-819d63cbdcea", "target_id": "b710c60f-4c29-5f48-bb99-431aad664cc3" } } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Delete the relationship associated to reference data value identified by code in the Reference Data Set with specified artifact_id and version_id
Delete the relationship associated to reference data value identified by code in the Reference Data Set with specified artifact_id and version_id
DELETE /v3/reference_data/{artifact_id}/versions/{version_id}/values/{code}/relationships/{relationship_id}Request
Path Parameters
The artifact_id of the reference data set from which relationship is to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the reference data set or specify CURRENT to fetch from published active version.
CURRENT is to be deprecated in next major release, please use /v3/governance_artifact_types/reference_data/{artifact_id} as a replacement.Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The code of data value from which to delete relationship.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
Deleted the relationship
Bad Request
Unauthorized
relationship not found
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Retrieves relationships for a given artifact type, artifact_id and artifact version_id
For a given artifact type, a set of predefined relationship attributes with associated artifacts are included for every relationship.
GET /v3/relationships
Request
Query Parameters
The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule
Example:
glossary_termThe id of artifact that is a part of the requested relationship.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of artifact that is a part of the requested relationship.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0Comma-separated list of relationship types.
Relationship TypesArtifact Typescategoryclassificationdata_classglossary_termpolicyreference_dataruleall+ + + + + + + categories- + + + + + + child- - - - - + - classifications+ - + + + + + custom+ + + + + + + data_classes- + - + + + + data_location_rules- - - - + - - data_protection_rules- - - - + - - grouped_assets+ - - - - - - has_terms- - - + - - - has_type_terms- - - + - - - has_types_category+ - - - - - - has_types_classifications- + - - - - - has_types_classifications_hierarchy- + - - - - - has_types_data_class_hierarchy- - + - - - - has_types_data_classes- - + - - - - has_types_term_hierarchy- - - + - - - is_a_parent_category_for+ - - - - - - is_a_type_of_category+ - - - - - - is_a_type_of_classification- + - - - - - is_a_type_of_data_class- - + - - - - is_a_type_of_terms- - - + - - - is_of_terms- - - + - - - multi_value_mappings- - - - - + - owned_by+ - - - - - - parent- - - - - + - parent_category- + + + + + + parent_hierarchy- - - - - + - parent_policy- - - - + - - policies- + + + - - + reference_data- + + + - - + reference_data_values- - - + - - - related_categories- + - - - - - related_terms- - - + - - - replaced_by_terms- - - + - - - replaces_terms- - - + - - - rules- + + + + + + single_value_mappings- - - - - + - sub_policies- - - - + - - synonym_terms- - - + - - - terms- + + - + + + value_mappings- - - - - + - Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*A filter to artifacts that have been created / updated / deleted since the given timestamp in this format: [yyyy-MM-ddTHH:mm:ss.SSSZ]
Possible values: length = 24, Value must match regular expression
^\d{4}(-\d\d(-\d\d(T\d\d:\d\d(:\d\d)?(\.\d+)?(([+-]\d\d:\d\d)|Z)?)?)?)?$The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Paginated lightweight search artifact list
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
No Sample Response
Request
Query Parameters
If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.
Rule to be created.
The name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Rule 1Currently supported: Governance.
Allowable values: [
Quality,Automation,DataProtection,Governance,Data]Example:
GovernanceSecondary categories the artifact belongs to.
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
long descriptionThe parent category of the artifact.
The relationships to governance policies.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
The relationships to reference data sets.
Relationships to governance rules only. Does not include other rule relationships.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
short descriptionThe steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The rule has been created successfully.
Bad Request
Unauthorized
UniqueConstraintViolation - rule with given name already exists.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Retrieves rule with given artifact_id and status
This method can be used for retrieving details of an ACTIVE, PUBLISHED or DRAFT rule.
GET /v3/rules/{artifact_id}/versionsRequest
Path Parameters
Artifact ID or global ID of the artifact
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
Filter by rule status.
Available statuses: DRAFTartifacts which are being created or modified and not in use PUBLISHEDartifacts which are in published state (does not takes effective dates into account) ACTIVEartifacts which are published, and which effective date period includes current datetime Possible values: 1 ≤ length ≤ 32, Value must match regular expression
.*Default:
PUBLISHEDComma-separated list of relationship types.
Available types: parent_categorycategoriestermsrulesreference_datapoliciesclassificationsdata_classescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
List of paginated artifacts
The limit parameter passed to the list / search method.
Possible values: 1 ≤ value ≤ 1000
Example:
30Offset used in the list / search method.
Example:
80The total number of items that matches the given criteria.
Example:
300Represents an html link.
Represents an html link.
Represents an html link.
Represents an html link.
Results of the list / search.
Status Code
The rule has been retrieved successfully.
Bad Request
Unauthorized
The rule with given {guid} does not exist in the glossary.
Internal Server Error
{ "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } } ] }
Deletes a draft or published version of an artifact
If the artifact state is DRAFT, then the draft version is deleted.
If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .
If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.
If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.
Administrator role is required.
DELETE /v3/rules/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the rule to delete.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the rule to delete.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
A draft version has been successfully created for deleting the published artifact.
The artifact has been deleted successfully.
Bad Request
Unauthorized
Draft version for the given version ID does not exist in the glossary.
Internal Server Error
{ "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }
Retrieves rule with given guid
This method can be used for retrieving details of an PUBLISHED or DRAFT rule.
GET /v3/rules/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact ID of the rule to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the rule to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: parent_categorycategoriestermsrulesreference_datapoliciesclassificationsdata_classescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
^(parent_category|categories|terms|classifications|data_classes|reference_data|policies|rules|custom|all)(,(parent_category|categories|terms|classifications|data_classes|reference_data|policies|rules|custom|all))*$If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Default:
trueIf this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10
Response
Rule returned by REST GET method that includes the relationships as paginated list.
Represents a rule entity returned by REST GET methods that include the relationships as paginated lists
Metadata of the entity.
Status Code
The rule has been retrieved successfully.
Unauthorized
The rule with given {guid} does not exist in the glossary.
Internal Server Error
No Sample Response
Updates rule with given id
This method is used to update rule with given id.
PATCH /v3/rules/{artifact_id}/versions/{version_id}Request
Path Parameters
The artifact id of the rule to be updated.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version id of the rule to be updated.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
The rule to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
The revision of the artifact. It is used for optimistic locking.
Possible values: 1 ≤ length ≤ 20, Value must match regular expression
\d*Secondary categories the artifact belongs to.
Relationships to classifications.
List of custom attributes with their values.
Custom relationships to asset
Relationships to data classes.
The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.
Possible values: 10 ≤ length ≤ 32
The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.
Possible values: 10 ≤ length ≤ 32
The long description of an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Example:
long descriptionThe name of the artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
Name 1The parent category of the artifact.
The relationships to governance policies.
Indicates that it is a reference copy of an artifact managed in an external metadata server.
The relationships to reference data sets.
Relationships to governance rules only. Does not include other rule relationships.
The short description of an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Example:
short descriptionThe steward groups assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward_group1", "steward_group2" ]The stewards assigned to an artifact.
Possible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Examples:[ "steward1", "steward2" ]The tags assigned to an artifact.
Possible values: 1 ≤ length ≤ 15000, Value must match regular expression
.*Examples:[ "tag1", "tag2" ]Relationships to business terms.
Response
Rule returned by REST GET method that includes the relationships as paginated list.
Represents a rule entity returned by REST GET methods that include the relationships as paginated lists
Metadata of the entity.
Status Code
The rule has been updated successfully.
Bad Request
Unauthorized
Forbidden
The rule with given {guid} does not exist in the glossary.
The rule was modified by another user.
Internal Server Error
No Sample Response
List the relationships of the given type for the specified rule
If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.
GET /v3/rules/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact ID of the rule to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the rule to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
Comma-separated list of relationship types.
Available types: parent_categorycategoriestermsrulesreference_datapoliciesclassificationsdata_classescustomallPossible values: 1 ≤ length ≤ 255, Value must match regular expression
.*Custom relationship definition Id.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4Is custom relationship reversed?
If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
Retrieves target parent category name of the relationship entity.
The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
Possible values: 1 ≤ value ≤ 200
Default:
10Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.
Response
Response that includes relationships to a managed object, like business term, data class, classification
List of custom relationships
Mapping of the relationship type to the paginated list of relationships
- relationships
Base V3 class for paginated results
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
No Sample Response
Create relationships for an artifact in the glossary
If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.
POST /v3/rules/{artifact_id}/versions/{version_id}/relationshipsRequest
Path Parameters
The artifact ID of the rule to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the rule to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0
Query Parameters
If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.
Relationships to be created.
Category relationships.
The list of related classifications
The list of related data classes
The parent category of the artifact.
The list of parent policies
The list of related reference data sets
The list of related rules
The list of related business terms
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The relationship(s) have been created successfully.
Bad Request
Unauthorized
UniqueConstraintViolation - This Relationships is already exist
Internal Server Error
No Sample Response
Deletes a relationship of a rule artifact
This method can be used for deleting a relationship of a rule artifact.
DELETE /v3/rules/{artifact_id}/versions/{version_id}/relationships/{relationship_id}Request
Path Parameters
The artifact ID of the rule to fetch.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4The version ID of the rule to fetch.
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
.*Example:
990e33f5-3108-4d45-a530-0307458362d4_0The artifact ID of the relationship to be deleted.
Possible values: length = 36, Value must match regular expression
([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})Example:
aa0e33f5-3108-4d45-a530-0307458362d4
Query Parameters
If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.
Response
Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.
IDs of the created items.
Status Code
The relationship of the rule artifact was successfully deleted.
Bad Request
Unauthorized
The relationship for the given GUID does not exist in the glossary.
Internal Server Error
No Sample Response
Get Registration with synchronization status for reporting service
Get Registration with synchronization status for reporting service.
GET /v3/reporting/{tenant_id}/registerRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Get Registration with synchronization status for reporting service
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Register for reporting service
Register the tenant for reporting service. Register tenant has two key properties: 1) platform catlog_id and connection_id which should have database details to store tenant data for reporting purpose, and 2) schema zoning information which specifies tenant reporting data zoning information.
POST /v3/reporting/{tenant_id}/registerRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
connection details platform_catalog_id, platform_connection_id, global schema and zoned schema
database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Data protection rules report settings
Workflow report settings
User profile report settings
schema zone mapping
Possible values: 0 ≤ number of items ≤ 20
confog
options
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Registered tenant for reporting service
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Delete Registration for reporting service (if synchronization not started)
Delete Registration for reporting service (if synchronization not started) This action will delete registration only for IKC artifacts which were registered recently (via POST or PATCH) and have not been started yet.
DELETE /v3/reporting/{tenant_id}/registerRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Delete/Reset draft registration of the IKC tenant for synchronization
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Update Registration for reporting service
update the catalog_ids, categories, project_ids. Update the registered tenant for reporting service with new catalog_ids, categories, project_ids.
PATCH /v3/reporting/{tenant_id}/registerRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Patch registration inputs
Data protection rules report settings
Workflow report settings
User profile report settings
schema zone mapping
Possible values: 0 ≤ number of items ≤ 20
confog
options
database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$list of zones to remove
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Updated registered tenant details for reporting service
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Start synchronization of IKC data into reporting database
Start synchronization of IKC data from IKC to reporting database for given tenant_id. This action will start initial crawl only for IKC artifacts which were registered recently (via POST or PATCH) and have not been started yet.
POST /v3/reporting/{tenant_id}/startRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Query Parameters
Soft Restart
Allowable values: [
true,false]Example:
falseSoft Restart - Only failed zones
Allowable values: [
true,false]Example:
trueSoft Restart - All failed zones Plus a list of successfull Zone Ids (,separated) - catalog_id,project_id,category_id,data_protection_rules,user_profiles,workflows
Possible values: 1 ≤ length ≤ 1024, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_\-,]*$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Sync Initiated for given tenant_id.
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Pause synchronization of IKC data into reporting database
Pause synchronization of IKC data into reporting database for given tenant_id.
POST /v3/reporting/{tenant_id}/pauseRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Pause Sync request accepted for given tenant_id.
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Resume synchronization of IKC data into reporting database
Resume synchronization of IKC data into reporting database for given tenant_id after it was paused.
POST /v3/reporting/{tenant_id}/resumeRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Resume Sync request accepted for given tenant_id.
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Stop synchronization of IKC data into reporting database
Stop synchronization of IKC data into reporting database and reset the status of all the process to AWAITING START for given tenant_id.
POST /v3/reporting/{tenant_id}/stopRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Stop Sync request accepted for given tenant_id.
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Reset Registration for reporting service (Stop Sync and Delete Registration)
Reset IKC tenant registeration for synchronization of IKC data into reporting database for given tenant_id.
POST /v3/reporting/{tenant_id}/resetRequest
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Response
Registration details
platform catalog id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$platform connection id
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$database schema name
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
^[a-zA-Z_][a-zA-Z0-9_#]*$Overall Status-AWAITING START/IN QUEUE/INITIAL SYNC IN PROGRESS/CONCLUDING INITIAL SYNC FOR (DPR/GLOSSARY/CATALOGS/PROJECTS)/ACTIVE/PAUSED/RESUMING/FAILED/AWAITING STOP/AWAITING RESET
Possible values: 5 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9\s\(\)]+$Example:
ACTIVElast crawl start timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$last updated timestamp
Possible values: length = 24, Value must match regular expression
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$initial syn status
sync status
Bidata Sync response for an object i.e. asset, artifact etc.
confog
options
global
Status of zoned Services (catalog/project/glossary)
Status Code
Reset Sync request accepted for given tenant_id.
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "platform_asset_catalog_id": "5dd5161a-5345-4486-a374-2f614d9f5839", "platform_asset_connection_id": "ac88d75a-478e-44b7-bd90-58862138cdb1", "global_schema_name": "BITNT1DBypqa1", "status": "ACTIVE", "last_crawl_started_at": "2024-09-19T02:24:19.557Z", "last_updated_at": "2024-09-19T02:24:36.498Z", "init_sync_state": { "status": "SYNCHRONIZING", "percent": 40, "current_action": "PROCESSING", "action_target": "catalogs", "action_target_count": 1, "action_target_total_count": 1, "action_target_id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "action_target_name": "Bi-Data-Catalog-ITQ-Test1726712242715", "current_retry": 0, "max_retry": 4 }, "sync_state": { "status": "ACTIVE", "message": "ACTIVE", "current_cached_items": 0 }, "options": { "catalog_auto_register": false, "project_auto_register": false }, "global": { "data_protection_rules": { "active": { "enabled": true, "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" }, "awating_commit": {} }, "workflows": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} }, "user_profiles": { "active": { "enabled": false, "status": "DISABLED", "processed": 0, "skipped": 0, "wkc_count": 0 }, "awating_commit": {} } }, "schema_zone_mapping": { "active": [ { "schema_name": "BITNT1DBypqa1", "catalogs": [ { "id": "a10ef7ed-98e4-4d3d-9d17-83a2370bd066", "status": "INITIAL SYNC IN PROGRESS", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "projects": [], "categories": [] }, { "schema_name": "BITNT1DBypqa3", "catalogs": [], "projects": [], "categories": [ { "id": "4390ec59-f349-43ad-a63b-a3f7401beab8", "status": "ACTIVE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ] }, { "schema_name": "BITNT1DBypqa2", "catalogs": [], "projects": [ { "id": "0b50bb90-ee53-4abe-8c4b-5f0654331313", "status": "IN QUEUE", "processed": 0, "skipped": 0, "wkc_count": 0, "count_updated_at": "NA" } ], "categories": [] } ], "awating_commit": [] } }
Request
Path Parameters
Tenant Id
Possible values: 3 ≤ length ≤ 32, Value must match regular expression
^(999|[a-zA-Z0-9]{32})$
Query Parameters
Sample Type
Allowable values: [
documented,all]
Response
Samples / Example Queries
Sample Queries
Possible values: 0 ≤ number of items ≤ 1000
Status Code
Get list of sample queries
Bad Request
Unauthorized
IKC BiData Reporting Service is not available now please try after some time
{ "examples": [ { "text": "Number of catalog assets grouped by type", "sql": "SELECT ASSET_TYPE, COUNT(*) AS TOTAL FROM zoneschema.CONTAINER_ASSETS GROUP BY ASSET_TYPE" }, { "text": "Get the number of connections created since specific time", "sql": "SELECT CONTAINER_TYPE, COUNT(*) FROM zoneschema.CONTAINER_ASSETS WHERE ASSET_TYPE = 'connection' AND CREATED_ON >= TO_TIMESTAMP('2022-01-01', 'YYYY-MM-DD') GROUP BY CONTAINER_TYPE" } ] }
Copy Knowledge Accelerator items into project
Copy the specified Knowledge Accelerator items into specified IKC project.
POST /v1/knowledge_accelerators/{ka_id}/copy_itemsRequest
Path Parameters
The Knowledge Accelerator id
Possible values: 4 ≤ length ≤ 7
Query Parameters
A comma separated list of the item ids of the Knowledge Accelerator to copy.
Possible values: 2 ≤ length ≤ 200
The id of the project where the items are copied to
Possible values: 10 ≤ length ≤ 100
curl -k -X POST 'https://{cpd_cluster_host}/v1/knowledge_accelerators/{ka_id}/copy_items?ids={ids}&project_id={project_id}' -H 'accept: application/json' -H 'Authorization: Bearer {token}' -d ''
Response
Response information related to copying Knowledge Accelerator items into a project.
A summary message of the copy status
The Knowledge Accelerator URI of the items to be copied
A copy status for a specific Knowledge Accelerator.
Possible values: 0 ≤ number of items ≤ 20
Status Code
Success
Bad Request
Unauthorized
Not found
{"message":"The copy has been executed, please check details below for status","knowledge_accelerator":"https://api.dataplatform.cloud.ibm.com/v1/knowledge_accelerators/kaeu20","items":[{"item_id":"base","data_assets":[{"name":"kaeu20-base-2.0.20230726.zip","url":"https://api.dataplatform.cloud.ibm.com/v2/data_assets/b43ddf6d-bb52-4df2-9d55-c7713a2bbadd?project_id=e304ce63-8e2a-4597-8251-0876d20c2a24","status":"copied"}]}]}
Get a specific Knowledge Accelerator
Supply a Knowledge Accelerator id, in order to get detailed information, including contained items that can be imported, statistics and dependencies
GET /v1/knowledge_accelerators/{id}Request
Path Parameters
The Knowledge Accelerator id
Possible values: 4 ≤ length ≤ 7
curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators/{ka_id}' -H 'accept: application/json' -H 'Authorization: Bearer {token}'
Response
A KAArtifact can represent a Knowledge Accelerator or a Knowledge Accelerator item. A knowledge accelerator can contain many knowledge accelerator items, which can be for example, many sub parts of a large IKC glossary. A knowledge accelerator item can depend on other items.
The identifier of the knowledge accelerator, or the knowledge accelerator item
The name of this knowledge accelerator item
The definition that helps describe the content within the knowledge accelerator item
The type of the knowledge accelerator item. If the item is of type glossary, then the type of the glossary will further be indicated, for example "glossary_iav" (Glossary that is of type, Industry Alignment Vocabulary)
The format of the content that is stored in this knowledge accelerator item
The version of the tool or service that the format is compatible with
The version of this knowledge accelerator item. Typically this will only change if the underlying content has changed. If the knowledge accelerator is at a certain version, it would be expected that there would be at least one knowledge accelerator item at that same version
The definition that might optionally accompany this new version of the content, which would summarise the main changes from prior version.
Holds statistics for the knowledge accelerator or item. If in existence for an item, then it will contain at least 1 statistic, for example count of categories.
If a knowledge accelerator item is depended on by another item, then this property indicates if it should be considered mandatory. Default value is false.
A knowledge accelerator can contain 1 or more items. Also in theory a knowledge accelerator item itself, can contain other items and so on
Possible values: 0 ≤ number of items ≤ 30
If an item depends on one or more items within the same knowledge accelerator, this holds those item ids
Possible values: 0 ≤ number of items ≤ 10
If an item is derived from one or more items within the same knowledge accelerator, this holds those item ids
Possible values: 0 ≤ number of items ≤ 10
Status Code
Success
Unauthorized
Not found
{"id":"kaeu20","name":"Knowledge Accelerators","definition":"A category that ..etc.","type":"knowledge_accelerator","format":"wkc_glossary","version":"2.0.20231004","stats":{"terms":11425,"categories":502,"policy":57,"rule":30,"reference_data":297,"reference_data_value":2292,"data_class":284}}
Import specified Knowledge Accelerator items into the glossary
Import the specified Knowledge Accelerator items into glossary. By default this will import all dependent items
POST /v1/knowledge_accelerators/{ka_id}/import_itemsRequest
Path Parameters
The Knowledge Accelerator id
Possible values: 4 ≤ length ≤ 7
Query Parameters
The ids of the Knowledge Accelerator items to import, for example 'base'. Use the comma delimiter when listing multiple item ids, for example 'ccpa,gdpr'. Only one item allowed if item is of type glossary_scope
Possible values: 2 ≤ length ≤ 200
The merge option to be used when importing into the glossary, valid values:
all - imported values will replace existing values in catalog
specified - imported values that are not empty replace existing values in catalog
empty - imported values replace only empty values in catalogPossible values: 3 ≤ length ≤ 12
Indicates which dependencies of the item ids specified should also be imported, valid values:
all - imports the specified items that the user selects, imports all the items that the selected item depends on, irrespective of whether they already exist in glossary (Note, this may overwrite user made changes in the glossary).
necessary - imports specified items that the user selects, imports items that are considered mandatory for the specified item, and imports other related items the specified items depend on that are not already imported.
mandatory - imports the specified items that the user selects, and items that are considered mandatory for the specified item.Possible values: 3 ≤ length ≤ 12
Default:
necessaryIndicates whether the import should be done, valid values:
false - will do all the logic checking and indicate what is going to be imported, useful for checking in advance of actually doing the import
true - at the end of logic checking will trigger the import and return a process id to the userDefault:
false
curl -k -X POST 'https://{cpd_cluster_host}/v1/knowledge_accelerators/{ka_id}/import_items?ids={ids}&merge_option={merge_option}&dependencies={dependencies}&do_import={do_import}' -H 'accept: application/json' -H 'Authorization: Bearer {token}' -d ''
Response
An import response holds information related to an attempted or dry run of import of Knowledge Accelerator content. In a dry run scenario there will be no process id, as the import was not actually triggered.
A summary message of the import status
A URI for checking the status of the import process
An import evaluation for a specific Knowledge Accelerator.
Status Code
Accepted
Bad Request
Unauthorized
Not found
{"message":"The import has been submitted. To check the status ...","process_id":"b3ae3db2-6da1-447d-aaf7-4dde46dcbd1d","import_evaluation":{"knowledge_accelerator":"kain20","items":[{"id":"base","evaluation":"import","reason":"user_selected"}]}}
Get what Knowledge Accelerator items are currently imported into glossary
Information on what Knowledge Accelerator items are imported into glossary if any; this will include information as to whether imported version is current
GET /v1/knowledge_accelerators/import_items
Request
No Request Parameters
curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators/import_items' -H 'accept: application/json' -H 'Authorization: Bearer {token}'
Response
Represents information as to what Knowledge Accelerators and associated items are installed in the IKC glossary.
A summary message of the import status
An import evaluation for a specific Knowledge Accelerator.
Possible values: 0 ≤ number of items ≤ 20
Status Code
Success
Unauthorized
{"message":"KA008I: The following knowledge accelerator items are imported","import_evaluation":[{"knowledge_accelerator":"kain20","items":[{"id":"base","evaluation":"imported"}]}]}
Get all Knowledge Accelerators
Detailed information on each Knowledge Accelerator, including contained items that can be imported, statistics and dependencies
GET /v1/knowledge_accelerators
Request
No Request Parameters
curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators' -H 'accept: application/json' -H 'Authorization: Bearer {token}'
Response
A listing of the Knowledge Accelerators
A count of the Knowledge Accelerators that are available
A listing of the Knowledge Accelerators and their contained items that are available for importing into the IKC glossary
Possible values: 0 ≤ number of items ≤ 40
Status Code
Success
Unauthorized
{"count":1,"knowledge_accelerators":[{"id":"kahc20","name":"Knowledge Accelerator for Healthcare","definition":"IBM Knowledge Accelerator for ...etc..","type":"knowledge_accelerator","format":"wkc_glossary","version":"2.0.20230726","stats":{"terms":22385,"categories":1071,"policy":32,"rule":10,"reference_data":1169,"reference_data_value":22624,"data_class":208}}]}
Get asset lineage
Returns lineage of the asset identified by asset_id. The lineage includes a list of events associated with the asset. A different list of events are returned based on the value of lineage_type query parameter.
- lineage_type = default | partial - The event generating the asset, the events happening on the asset and the events using the asset to generate other assets.
- lineage_type = forward - The event generating the asset and the events using the asset directly or indirectly to generate other assets.
- lineage_type = forward_hop - The event generating the asset and the events using the asset directly or indirectly to generate other assets. The number of events returned is controlled by hop_count and event_count parameters.
- lineage_type = backward - All the direct and indirect events responsible for generating the asset.
GET /v2/asset_lineages/{asset_id}Request
Path Parameters
Asset ID
Query Parameters
The type of the asset. The value can be one of dataset, model. If the seed asset ID is supplied, then the value supplied should be the type of the seed asset.
The maximum number of events returned. The default value is 50.
The index of the first matching event to be included in the result. The default value is 0.
The type of lineage to be returned. The default value is partial
Allowable values: [
forward,forward_hop,backward,partial]The type of event classification. By default, the events are not classfied.
Allowable values: [
timelines]If the asset is a catalog-asset, specify the ID of the catalog. If the seed asset ID is supplied, then the value supplied should be the catalog ID of the seed asset.
If the asset is a project-asset, specify the ID of the project. If the seed asset ID is supplied, then the value supplied should be the project ID of the seed asset.
If the asset is a space-asset, specify the ID of the space. If the seed asset ID is supplied, then the value supplied should be the project ID of the seed asset.
If the asset is a model, specify the ID of the associated WML service instance. If the seed asset ID is supplied, then the value supplied should be the WML service instance ID of the seed asset.
The time after which the events have to be fetched. The format should be yyyy-MM-dd'T'HH:mm:ss.SSSX. The default value is 1970-01-01T00:00:00.000Z.
Used to control the number of events returned when lineage_type is forward_hop. The events returned will belong to a maximum of N other assets directly or indirectly generated using the asset where N is equal to hop_count. The default value is 4.
Used to control the number of events returned when lineage_type is forward_hop. The maxiumum number of events of each other asset generated directly or indirectly using the asset. The default value is 10.
The seed asset ID. The request will not be authorized if the lineage of the asset is not part of the lineage of the seed asset.
Get asset lineage summary
Returns lineage summary of the asset identified by asset_id.
GET /v2/asset_lineages/{asset_id}/summaryRequest
Path Parameters
Asset ID
Query Parameters
The type of the asset. The value can be one of dataset, model.
If the asset is a catalog-asset, specify the ID of the catalog.
If the asset is a project-asset, specify the ID of the project.
If the asset is a space-asset, specify the ID of the space.
If the asset is a model, specify the ID of the associated WML service instance.
Get summary statistics of activities on a project/catalog/space asset
Returns summary statistics of the asset identified by asset_id and request type.
GET /v2/asset_statistics/{asset_id}/statisticsRequest
Path Parameters
Asset ID
Query Parameters
The type of the request. The value can be one of edits, downloads, publish_to_catalog or clone_to_project.
Allowable values: [
EDITS,DOWNLOADS,PUBLISH_TO_CATALOG,CLONE_TO_PROJECT,PROMOTE_TO_SPACE]If the asset is a catalog-asset, specify the ID of the catalog.
If the asset is a project-asset, specify the ID of the project.
If the asset is a space-asset, specify the ID of the space
Response
Response for the /v2/asset_statistics/{asset_id}/statistics API
Gives the statistics i.e number of requests (edits, downloads, etc
Identifies type of Request - edits, downloads, publish_to_catalog, clone_to_project, promote_to_space
Status Code
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error