Retrieve record types of all the matching algorithms

GET /mdm/v1/algorithms

This service retrieves the record types of all the matching algorithms present.
A matching algorithm contains the matching metadata for a given record type and is comprised of standardization, bucket generation and comparison sections.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The algorithms' record types has been successfully retrieved.

algorithm_names

array

Collection of algorithm names

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve the matching algorithm

GET /mdm/v1/algorithms/{record_type}

This service retrieves the matching algorithm for a given record type.
A matching algorithm contains the matching metadata for a given record type and is comprised of standardization, bucket generation and comparison sections.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

Query Parameters

crn

Required *

string

The cloud resource name of the service.

template

boolean

response will return the default template algorithm when set to true

Response

200 - The algorithm has been successfully retrieved.

standardizers

object

Collection of standardizer definitions

encryption

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Overwrite the matching algorithm

PUT /mdm/v1/algorithms/{record_type}

This service completely overwrites the matching algorithm for a given record type.
A matching algorithm defines how two records of a given type are compared.
A matching algorithm contains the matching metadata for a given record type and is comprised of standardization, bucket generation and comparison sections.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

The data type identifier of source records, ie. person, organization, contract

Query Parameters

crn

Required *

string

array

A list of errors.

generate matching algorithm

POST /mdm/v1/algorithms/{record_type}

This service customizes the matching algorithm for a given record type.
A matching algorithm defines how two records of a given type are compared.
A matching algorithm contains the matching metadata for a given record type and is comprised of standardization, bucket generation and comparison sections.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

AlgorithmGeneration

Path Parameters

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

Query Parameters

crn

Required *

string

array

A list of errors.

Delete the model algorithm

DELETE /mdm/v1/algorithms/{record_type}

This service deletes the algorithm for a given record type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Path Parameters

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Partially modify matching algorithm

PATCH /mdm/v1/algorithms/{record_type}

This service partially modifies the matching algorithm for a given record type.
A matching algorithm defines how two records of a given type are compared.
A matching algorithm contains the matching metadata for a given record type and is comprised of standardization, bucket generation and comparison sections.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

The data type identifier of source records, ie. person, organization, contract

Query Parameters

crn

Required *

string

array

A list of errors.

Compare pairs of records

POST /mdm/v1/batch_compare

This service compares the input pairs of records and returns comparison details.
This service supports comparing multiple pairs of records by supplying pairs of record numbers in the payload.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

BatchComparePairsRequest

pairs

Required *

array

Collection of pairs of record numbers

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

details

string

The level of information detail in response, ie. low, high, debug

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

Response

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve bucket hash details

POST /mdm/v1/bucket_details

This service retrives details about all the bucket hashes supplied as an input

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

PostHashDetailsRequest

bucket_hashes

Required *

array

Collection of bucket hashes

Path Parameters

include_standardized_data

boolean

To check if invalid manual linkage rules exist, default is false

Response

A list of errors.

Start an operation to sync FDB backend with ES

POST /mdm/v1/bulk_backend_sync

The operation will fill in missing fields from ES Docs, if any, with corresponding values from FDB.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

executor_count

integer

The number of spark executors

executor_memory

string

Amount of memory to use per executor process

executor_core_count

integer

The number of cores to use on each executor

spark_parallelism

integer

The number of partitions to be used by spark

Response

202 - The backend synchronization job was successfully started.

job_id

string

The id for the job.

job_type

string

The type of job.

status

A list of errors.

Start an operation to bulk delete data from the graph

POST /mdm/v1/bulk_delete

A delete can target either records or relationships in the graph. If not specified, records are targeted by default. There are four options for a delete: * Delete by search, which removes all elements matching a search criteria. This delete type is only supported for records. * Delete by source, which removes all elements of a specified source. * Delete by asset, which removes all elements loaded from a particular asset or list of assets. * Full delete, which removes all elements from the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Request Body

BulkDeleteRequest

Valid object defining the bulk delete job information.

delete_type

Required *

string

search_criteria

DataSearchCriteria

A set of criteria for a search operation.

search_type

string

The type of data to search against.

query

object

A search query to run.

filters

array

The search filters to apply to the search to narrow down results.

Path Parameters

Query Parameters

crn

Required *

boolean

When set to true, deletes all historical data for the records being deleted, including relationship and linkage history.

Response

A list of errors.

Initiate data derivation job

POST /mdm/v1/bulk_derive

This service initiates asynchronous processing of the derive job.
Data derivation is the process to standardize and generate buckets for the input records.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

IBM User Id who initiates the job

Response

202 - The request has been successfully created.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Initiate export manual rules job

POST /mdm/v1/bulk_export_linkage_rules

This service initiates asynchronous processing of the export rules job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Request Body

PostExportRulesRequest

filter

Required *

partition_type

string

The type of partitioning used when exporting the results. ie. null, executor_count

Path Parameters

Query Parameters

crn

Required *

200 - The request has been successfully finished.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Initiate token frequency calculation job

POST /mdm/v1/bulk_freq_calculation

This service initiates asynchronous processing of the token frequency calculation job.
Token frequency calculation analyzes derived record data to identify high and low frequency tokens for matching optimization.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

202 - The request has been successfully created.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Initiate generate pairs job

POST /mdm/v1/bulk_generate_pairs

This service initiates asynchronous processing of the generate pairs job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

record_type

Required *

boolean

Exclude reviewd pairs. Default is false

Response

200 - The request has been successfully finished.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Initiate import manual rules job

POST /mdm/v1/bulk_import_linkage_rules

This service initiates asynchronous processing of the import rules job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Request Body

PostImportRulesRequest

storage_bucket

string

The storage bucket for the output file, ie. bucket-27200-lwx4cfvcue

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

storage_endpoint

string

The storage endpoint for the output file, ie. https://s3.us-east.cloud-object-storage.appdomain.cloud

storage_access_key

string

The access key for your storage, ie. cf4965cebe074720a4929759f57e1214

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

is_derived_data_available

boolean

Is derived data present in system, default is true

executor_count

integer

The number of spark executors

executor_memory

string

Amount of memory to use per executor process

executor_core_count

integer

The number of cores to use on each executor

spark_parallelism

integer

The number of partitions to be used by spark

Response

200 - The request has been successfully finished.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Initiate link job

POST /mdm/v1/bulk_link

This service initiates processing of the link job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Response

202 - The request has been successfully created.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Start a bulk load of data into the graph

POST /mdm/v1/bulk_load

Once the data load job is queued, track the status of the job to completion using the Job APIs.

To run a sample bulk load, provide the type as 'sample' and the directory_ref identifying which sample data set to load. directory_path is not required when type is set to 'sample', if provided it will be ignored. The available sample data sets are sample_contract_small, sample_consent_small, sample_contract, and sample_consent, and these are the only acceptable values for 'directory_ref'.
To run a bulk load of custom data, provide the type as 'dfs' and the directory_path pointing to the relative location of the data within the storage system. 'directory_ref' is not required when type is set to 'dfs', if provided it will be ignored. Data source directories are expected to adhere to the following format, if not otherwise specified under 'data_structure' in the request body: ``` record.properties relationship.properties group.properties group_association.properties record --[record data files] relationship --[relationship data files] group --[group data files] group_association --[group_association data files] ```
To run a bulk load of data from the Watson Knowledge Catalog, provide the type as 'wkc' and either the 'project_id' or 'catalog_id' of the resource that contains the data. If both are provided, 'catalog_id' will be used by default. 'directory_ref' and 'directory_path' are not required when type is set to 'wkc', if provided they will be ignored. The data asset id and properties must be specified under 'data_structure' in the request body.
For bulk loads of type 'dfs' or 'wkc', required data properties must be supplied either in a properties file or by specifying the properties contents in the request. If both a file and properties contents are provided, the properties contents will take precedence. Properties contents must include 'file_type' to be valid.
To enable efficient deletion of a data asset in the future after bulk loading completes, please ensure that the optional 'collection_id' attribute is specified in the set of properties defined in the request. Alternatively, the value can be configured using the 'json.collection.id' or 'csv.collection.id' property in the data load properties file, depending on your data structure.
For CSV import option if includes_header_row is set as true then header must be present in all partitions.

To specify a COS directory, directory_path should be in the format <bucket_name>/<directory_path>. If the COS bucket is not the provided tenant bucket, the origin field must be set to external and an IAM API key with access to the bucket must be provided in the api_key field. If the data directories do not follow the above format, the data structure field must be provided.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

BulkLoadRequest

Valid object defining the data source and parameters for the bulk load job.

data_source

Required *

DataLoadSource

Information about the source of the data to be loaded.

type

group_associations_properties_contents

object

The properties of the data to be loaded.

update_strategy

string

The strategy for updating existing data during the bulk load job.

user_id

string

UserID of the Job Initiator.

Path Parameters

Query Parameters

crn

Required *

A list of errors.

Initiate match job

POST /mdm/v1/bulk_match

This service initiates asynchronous processing of the match job.
Matching is the process to compare two or more records and create linkages between the matched records.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

initiator

string

IBM User Id who initiates the job

Response

202 - The request has been successfully created.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Initiate matching export job

POST /mdm/v1/bulk_matching_export

This service initiates asynchronous processing of a matching export job.
Match export job exports the existing matching data, pairs data, data quality data and workflow data to a given path under /service-exports.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Query Parameters

crn

Required *

202 - The request has been successfully created.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Start a bulk migration prep job

POST /mdm/v1/bulk_migration_prep

Once the migration preparation job is queued, track the status of the job to completion using the Job APIs.

To run a bulk migration prep from data please adhere the file format in gz compression format and files must be exported.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

BulkMigrationPrepRequest

Valid object defining the data source and parameters for the bulk migration prep job.

source_folder_path

Required *

string

migration_data_type

Required *

string

save_folder_path

Required *

string

Path Parameters

Query Parameters

crn

Required *

202 - The bulk migration prep job was successfully started.

job_id

string

The id for the job.

job_type

string

The type of job.

status

A list of errors.

Bulk Rellinker

POST /mdm/v1/bulk_rellinker/{relationship_type}

Creates automated Relationships between records/entites based on preset rules

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Request Body

BulkRellinkerRequest

Valid object defining the entity synchronization job information.

rule_ids

array

Rule Ids against which bulk rellinker must be run

Path Parameters

relationship_type

Required *

Amount of memory to use per executor process

executor_core_count

integer

The number of cores to use on each executor

spark_parallelism

integer

The number of partitions to be used by spark

batch_size

integer

batch size of the query parameter

ignore_history_capture

boolean

Set true to ignore history capture for bulk load

Response

202 - The bulk reset job was successfully started.

job_id

string

The id for the job.

job_type

string

The type of job.

status

A list of errors.

Initiate report job

POST /mdm/v1/bulk_report

This service initiates asynchronous processing of a report job.
Report job creates a report of the existing derived data that includes information like matching summary, largest entities, etc..

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Response

202 - The request has been successfully created.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Bulk Reset the graph

POST /mdm/v1/bulk_reset_data

Clear all Data and Matching content in the graphDB, including schema, vertexes, edges, and indexes. This operation is submitted as a Spark job for better scalability.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Path Parameters

Query Parameters

crn

Required *

202 - The bulk reset job was successfully started.

job_id

string

The id for the job.

job_type

string

The type of job.

status

A list of errors.

Initiate score entities job

POST /mdm/v1/bulk_score_entities

This service initiates asynchronous processing of the score entities job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Request Body

PairComparatorEntityRequest

entities

Required *

array

List of entity ids

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

output_path

Required *

string

Output directory

do_wait

boolean

Wait for job finish, default is false

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

entity_type

Required *

cos_bucket

Required *

string

IBM COS bucket

cos_access_key

Required *

string

IBM COS access key

cos_secret_key

Required *

string

IBM COS secret key

Response

200 - The request has been successfully finished.

job_name

string

System defined name of a given job e.g. match-bulkderiver

last_updated_at

A list of errors.

Start an operation to persist entities on the graph

POST /mdm/v1/bulk_synchronize_entities

Based on the latest bulk match job result, the process will create new entities on the graph if they are not existing, update the information of existing entities, and delete outdated entities if they are not associated with records anymore. The entity types that bulk entity synchronization job runs against can be provided in the payload. If not provided, all entity types are targeted.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

BulkEntitySyncRequest

Valid object defining the entity synchronization job information.

entity_types

array

Entity types that entity synchronization job will be run against. If no entity types are specified, all valid entity types will be considered.

delete_dangling_entities

boolean

Whether or not the entity synchronization job should delete entities of which all records were deleted.

user_id

string

Get the initiator ID of the job

Path Parameters

Query Parameters

crn

Required *

A list of errors.

Retrieve a cluster

GET /mdm/v1/clusters/{cluster_id}

This service retrieves the information and explanation of a cluster. Clusters can be created for the records of an entity. A cluster represents a closely matched collection of records of an entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

anomaly

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get member records of a cluster

GET /mdm/v1/clusters/{cluster_id}/records

This service retrieves member records of a cluster. Clusters can be created for the records of an entity. A cluster represents a closely matched collection of records of an entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

cluster_id

Required *

string

The cluster identifier of a cluster as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of entries to skip before returning a page of results. The default offset is 0.

limit

integer

The maximum expected number of entries in each page of results. The default limit is 10.

Response

200 - The request has been successfully finished.

object

href link of the next page

last

object

href link of the last page

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get comparison details between two clusters

POST /mdm/v1/clusters/compare

This service retrieves comparison details between two clusters in the system. A cluster represents a closely matched collection of records of an entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

The cluster identifier of a cluster as assigned by the system

Response

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve code table data

GET /mdm/v1/code_table/{code_table_name}

Retrieve data for a specific code table in key-value format.
Each entry may include an optional 'expired_for_action' field (ADD or ADD_UPDATE).
Supports multi-language code tables - defaults to 'en' if language parameter is not provided.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

code_table_name

Required *

array

A list of errors.

Store or replace code table data

PUT /mdm/v1/code_table/{code_table_name}

Store or completely replace data for a specific code table.
Validates data against the code table's schema definition.
Each entry may include an optional 'expired_for_action' field (ADD or ADD_UPDATE).
Supports multi-language code tables - defaults to 'en' if language parameter is not provided.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

CodeTableEntryRequest

Code table data as key-value pairs. Keys are code identifiers, values are objects conforming to the code table schema.

Path Parameters

code_table_name

Required *

PATCH /mdm/v1/code_table/{code_table_name}

Partially update code table data by adding or modifying entries.
Unlike PUT which replaces all data, PATCH allows selective updates or additions.
Existing entries with matching keys will be updated, new entries will be added.
Supports multi-language code tables - defaults to 'en' if language parameter is not provided.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

CodeTableEntryRequest

Code table data as key-value pairs. Keys are code identifiers, values are objects conforming to the code table schema.

Path Parameters

code_table_name

Required *

array

A list of errors.

Retrieve the code table schema definitions

GET /mdm/v1/code_table/schema

Retrieve the code table schema definitions that define the structure and metadata for code tables.
Code table schemas specify field classifications, language support, and labels for code table entries.
Supports filtering by specific code table names using the code_table_names query parameter.
When code_table_names is not provided, returns all code table schemas.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

code_table_names

string

Comma-separated list of code table names to filter. If not provided, returns all schemas.

Response

200 - The code table schema has been successfully retrieved.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Replace code table schema definitions

PUT /mdm/v1/code_table/schema

Replace code table schema definitions with full schema replacement.
Mode 1 (Create): If no schema exists, the entire request body is stored as the new schema.
Mode 2 (Replace): If schema exists, request must include ALL existing code tables (only label changes allowed) plus any new code tables.
Missing existing code tables in the request will result in validation error.
Database indexes are automatically created for newly defined code tables.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

CodeTableResource

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Partially update code table schema definitions

PATCH /mdm/v1/code_table/schema

Partially update code table schema definitions by adding or modifying specific code tables.
Can edit existing code tables (only label changes allowed) or add new code tables.
Does not require all existing code tables to be present in the request.
Existing code tables not in the request remain unchanged.
Database indexes are automatically created for newly defined code tables.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

CodeTableResource

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Compare records

POST /mdm/v1/compare

This service compares the input records and returns comparison details.
This service supports comparing two records by supplying payload or record_id.
This service also supports self comparison of a single input record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

CompareRecordsRequest

records

array

Collection of records

Path Parameters

record_number1

integer

The unique identifier of the first source record as assigned by the system

record_number2

integer

The unique identifier of the second source record as assigned by the system

record_type

string

The data type identifier of source records, ie. person, organization, contract

Response

A list of errors.

Retrieve a summary of all comparison parameters

GET /mdm/v1/compare_spec_resources

This service retrieves the list of specification names for the existing comparison parameters.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve details of comparison parameters

GET /mdm/v1/compare_spec_resources/{resource_name}

This service retrieves the comparison parameters for a given specification name.
Comparison parameters are maintained in a json document and is used for comparing attributes within an algorithm.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

resource_name

Required *

string

The unique identifier for the comparison parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The resources have been successfully retrieved.

feature_categories

object

Collection of user defined comparison feature categories. The feature category key must be lower snake case

typo_distance

number

The distance factor for each occurence of typographical error. The value must be between 0 to 1

similar_characters_enabled

boolean

The indicator of using similarity edit distance. The default value is false.

similar_characters_map_resource

string

An existing map resource name for lookalike characters

raw_edit_distance_enabled

A list of errors.

Overwrite the comparison parameters

PUT /mdm/v1/compare_spec_resources/{resource_name}

This service completely overwrites the comparison parameters for a given specification name.
Comparison parameters are maintained in a json document and is used for comparing attributes within an algorithm.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

CompareSpecResource

feature_categories

Required *

object

Collection of user defined comparison feature categories. The feature category key must be lower snake case

typo_distance

number

The distance factor for each occurence of typographical error. The value must be between 0 to 1

similar_characters_enabled

boolean

The indicator of using similarity edit distance. The default value is false.

similar_characters_map_resource

string

An existing map resource name for lookalike characters

raw_edit_distance_enabled

boolean

The indicator of using the raw edit distance value instead of the weighted one. The default value is false.

max_geo_distance

number

The max distance for geo compare should consider.

feature_coefficients

Required *

object

Collection of feature coefficients used for distance measurement. The feature coefficient key must be lower snake case (i.e. name_similar90, name_exact)

similar_characters_distance

number

The distance factor for each occurence of lookalike characters (i.e. 8 vs B, 0 vs O). The value must be between 0 to 1

Path Parameters

resource_name

Required *

string

The unique identifier for the comparison parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Retrieve the survivorship composite rules

GET /mdm/v1/composite_rules

Retrieve the survivorship composite rules applicable to entity types, as defined by matching algorithms
The ability to construct survived "picture" of the linked records relies on Composite Rule definition.
Composite Rule is a json document that contains survivorship criteria at global level or within a specific scope.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The composite rules have been successfully modified.

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Overwrite the survivorship composite rules

PUT /mdm/v1/composite_rules

Overwrite the survivorship composite rules applicable to entity types, as defined by matching algorithm
The ability to construct survived "picture" of the linked records relies on Composite Rule definition.
Composite Rule is a json document that contains survivorship criteria at global level or within a specific scope.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Path Parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Execute composite transactions

PUT /mdm/v1/composite_service

Execute composite transactions.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

choose

object

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

errors

array

A list of errors.

Get config data model

GET /mdm/v1/config_data_model

Gets the data model present in configuration space.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Replace Config Data Model

PUT /mdm/v1/config_data_model

Replaces the config data model present in configuration space.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

ConfigDataModel

hierarchy_types

object

Collection of hierarchy types. The hierarchy type key must be lower snake case (i.e. legal_hierarchy)

node_types

object

Collection of node types. The node type key must be lower snake case (i.e. hierarchy_node)

system_properties

Required *

DataModelSystemProperties

Collection of common fields applicable to various types in data model

hierarchy_types

object

Defines metadata of system properties of hierarchy types

node_types

object

Defines metadata of system properties of node types

attribute_types

Required *

object

Defines metadata of system properties of all attribute types

string

Internal version of system properties

record_types

Required *

Required *

object

Collection of user defined record types. The record type key must be lower snake case (i.e. person, organization)

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Get Config Data Model Type Attributes

GET /mdm/v1/config_data_model/attributes

Gets all the attributes of a specific type for the data model present in configuration space.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read
mdm-oc.configurator.read

Request

Path Parameters

The type name of the type category to identify data model attributes

Response

The HTTP status code of the response.

errors

array

A list of errors.

Replace Config Data Model

PUT /mdm/v1/config_data_model/attributes

Replaces the config data model present in configuration space.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

ConfigDataModel

hierarchy_types

object

Collection of hierarchy types. The hierarchy type key must be lower snake case (i.e. legal_hierarchy)

node_types

object

Collection of node types. The node type key must be lower snake case (i.e. hierarchy_node)

system_properties

Required *

DataModelSystemProperties

Collection of common fields applicable to various types in data model

hierarchy_types

object

Defines metadata of system properties of hierarchy types

node_types

object

Defines metadata of system properties of node types

attribute_types

Required *

object

Defines metadata of system properties of all attribute types

string

Internal version of system properties

record_types

Required *

Required *

object

Collection of user defined record types. The record type key must be lower snake case (i.e. person, organization)

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Get the startup status of the system

GET /mdm/v1/config_startup_status

Request

Response

200 - The startup check was successfully performed.

is_startup_success

boolean

Whether the system started successfully or not.

500 - Unable to determine startup status due to internal error.

503 - Startup of the service FAILED. The metadata store is not available.

Get version properties from config map.

GET /mdm/v1/configuration/version

Get version properties from config map. It will contain the running version of the service

Request

Response

200 - The version properties has been retrieved successfully

500 - An internal error occurred while retrieving the version properties.

503 - Service is not available and can not perform the operation now

Export configuration data to shared volume

POST /mdm/v1/configuration_export

Export all configuration metadata to the folder path in shared volume

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get configuration ms health status

GET /mdm/v1/configuration_health

Gets the configuration health status.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

errors

array

A list of errors.

Get configuration metadata

GET /mdm/v1/configuration_metadata

Gets the configuration metadata with all assets, their mappings, loading status, matching status, etc.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

pair_analysis

object

Pair analysis in configuration Metadata

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Update configuration metadata

PATCH /mdm/v1/configuration_metadata

Updates the configuration metadata with the information provided in the request.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

pair_analysis

object

Pair analysis in configuration Metadata

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Apply mapping patterns

POST /mdm/v1/configuration_metadata/apply_mapping_patterns

Apply mapping pattern to the existing assets based on user selection during import of snapshots.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

SuggestAssetsForImportRequest

mapping_patterns

array

The list of mapping patterns.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Add configuration metadata asset

POST /mdm/v1/configuration_metadata/assets

Adds a new asset in configuration metadata. This can be called when new asset is getting added into configuration space.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

The date of the Data Asset creation.

asset_mappings

array

The collection of Data Asset column mappings with the data model.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Replace configuration metadata asset

PUT /mdm/v1/configuration_metadata/assets/{asset_id}

Replaces asset information in the configuration with the information provided in the request.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

The access_token of the Data Asset.

asset_created_date

string

The date of data asset creation.

asset_mappings

array

Details of Data Asset column mappings with the data model.

Path Parameters

asset_id

Required *

string

Unique identifier of project asset

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Patch configuration metadata asset

PATCH /mdm/v1/configuration_metadata/assets/{asset_id}

Update the asset fields in the configuration metadata with the information provided in the request. Only the fields given in the request will be updated.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

AssetMetadataPatchRequest

asset_status

string

The status of the Data Asset.

asset_mappings

array

Details of Data Asset column mappings with the data model.

Path Parameters

asset_id

Required *

string

Unique identifier of project asset

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

List the process details

GET /mdm/v1/configuration_metadata/processes

Lists the Configurator process details for all processes, optionally filtered by process status. You can use either 'status' for a single status or 'status_list' for multiple comma-separated statuses.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

status

string

Single status to filter processes. Use this for backward compatibility. i.e. Not-Initiated, In-progress, Complete and Error

status_list

string

Comma-separated list of statuses to filter processes. Takes precedence over 'status' parameter if both are provided. i.e. Not-Initiated, In-progress, Complete and Error

Response

The HTTP status code of the response.

errors

array

A list of errors.

Create process

POST /mdm/v1/configuration_metadata/processes

Create the Configurator process to publish data, publish model, match, sync entity and delete assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

ProcessRequest

process_name

report_job_list

string

The list of jobs that should be considered during reporting

Path Parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Get configurator process

GET /mdm/v1/configuration_metadata/processes/{process_name}

Gets the process details for the specified process name.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Path Parameters

process_name

Required *

The data type identifier of source records under processing.

process_count

A list of errors.

Regenerate the mapping pattern ID in project metadata using the current logic

POST /mdm/v1/configuration_metadata/regenerate_mapping_pattern_id

The previous algorithm for generating the mapping pattern has been replaced with new algorithm.The existing mapping pattern id in the project metadata should be regenerated by using the current mapping pattern id generation logic.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Configure workflow in WKC Workflow service

POST /mdm/v1/configure_workflow

This service performs the workflow configuration for Potential Matches in WKC Workflow services.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

ConfigureWorkflow

workflow_configuration_name

string

Name of workflow configuration to be created for this instance

workflows

array

Path Parameters

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get version properties from config map.

GET /mdm/v1/data/version

Get version properties from config map. It will contain the running version of the service

Request

Response

200 - The version properties has been retrieved successfully

is_alive

boolean

Whether the system is alive and healthy.

500 - An internal error occurred while retrieving the version properties.

503 - Service is not available and can not perform the operation now

Get all data entitlements

GET /mdm/v1/data_entitlements

This service gets all data entitlements.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

integer

The number of tokens to be returned. The maximum limit is 1000.

Response

200 - The data entitlements have been successfully retrieved.

Create data entitlements

POST /mdm/v1/data_entitlements

This service creates data entitlements.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

DataEntitlement

created_user

string

User who created the entitlement

role_name

string

a role name associated with this entitlement

role_id

Required *

string

a role id associated with this entitlement

permissions

Required *

array

List of permissions associated with the role id

last_updated_user

string

User who last updated the entitlement

name

Required *

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get data entitlement

GET /mdm/v1/data_entitlements/{id}

This service gets data entitlement.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

A list of errors.

Replace data entitlements

PUT /mdm/v1/data_entitlements/{id}

This service replaces data entitlements.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

PutDataEntitlement

created_user

string

User who created the entitlement

role_id

Required *

string

a role id associated with this entitlement

permissions

Required *

array

List of permissions associated with the role id

last_updated_user

string

User who last updated the entitlement

name

Required *

string

Display name of the data entitlement

description

string

Detailed description of the data entitlement

created_date

integer

Timestamp when the entitlement was created

last_updated_date

integer

Timestamp when the entitlement was last updated

string

a role id associated with this entitlement

permissions

array

List of permissions associated with the role id

last_updated_user

string

User who last updated the entitlement

name

string

Display name of the data entitlement

description

A list of errors.

Delete data entitlements

DELETE /mdm/v1/data_entitlements/{id}

This service deletes data entitlements.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

id

Required *

string

id of data entitlement

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get all data entitlement access tokens

GET /mdm/v1/data_entitlements/access_tokens

This service gets all data entitlement access tokens.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

integer

The number of tokens to be returned. The maximum limit is 1000.

Response

200 - The access tokens have been successfully retrieved.

Create data entitlement access tokens

POST /mdm/v1/data_entitlements/access_tokens

This service creates data entitlement access tokens.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

DataEntitlementAccessToken

created_user

string

User who created the feature

last_updated_user

string

User who last updated the feature

name

Required *

string

Human-readable name

description

string

Optional description

id

string

Unique identifier for the feature

created_date

integer

Timestamp when the feature was created

type

Required *

string

type of the token. Users with global token can access all objects. Users with object token can only access objects with matched token

last_updated_date

integer

Timestamp when the feature was last updated

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get data entitlement access token

GET /mdm/v1/data_entitlements/access_tokens/{id}

This service gets data entitlement access token.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

last_updated_user

string

User who last updated the feature

name

string

Human-readable name

description

string

Optional description

id

A list of errors.

Delete data entitlement access token

DELETE /mdm/v1/data_entitlements/access_tokens/{id}

This service deletes a data entitlement access token.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

id

Required *

string

id of access token

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Update data entitlement access token

PATCH /mdm/v1/data_entitlements/access_tokens/{id}

This service updates data entitlement access token.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

User who last updated the feature

name

string

Human-readable name

description

string

Optional description

id

A list of errors.

Get current user permissions based on data entitlements

GET /mdm/v1/data_entitlements/access_tokens/permissions/current_user

This service retrieves the current user's permissions based on their data entitlement roles.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get all data entitlement access tokens for current user

GET /mdm/v1/data_entitlements/access_tokens/scope/current_user

This service gets all data entitlement access tokens for current user.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The access tokens have been successfully retrieved.

Export data entitlements

GET /mdm/v1/data_entitlements/export

This service exports multiple complete data entitlements grouped by role, including all entitlements, permissions, access tokens, users, and groups for each role. Maximum 50 roles per request.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

errors

array

A list of errors.

Create data entitlement constraints and indexes

POST /mdm/v1/data_entitlements/feature/index

This service creates data entitlement indexes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Drop and recreate constraints and indexes

POST /mdm/v1/data_entitlements/feature/index/reset

This service resets data entitlement feature indexes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Import data entitlements

POST /mdm/v1/data_entitlements/import

This service creates multiple complete data entitlements including role, permissions, access tokens, users, and groups in a single request. Maximum 25 requests per batch.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

BatchDataEntitlementList

data

Required *

array

Array of data entitlement

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Get all data entitlement roles

GET /mdm/v1/data_entitlements/roles

This service gets all data entitlement roles.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Response

200 - The roles have been successfully retrieved.

Create data entitlement roles

POST /mdm/v1/data_entitlements/roles

This service creats data entitlement roles.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

DataEntitlementRole

created_user

string

User who created the role

last_updated_user

string

User who last updated the role

name

Required *

string

Human-readable name

description

string

Optional description

id

string

Unique identifier for the role

created_date

integer

Timestamp when the role was created

last_updated_date

integer

Timestamp when the role was last updated

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

201 - The role has been successfully created.

created_user

string

User who created the role

last_updated_user

string

User who last updated the role

name

string

Human-readable name

description

A list of errors.

Get data entitlement role

GET /mdm/v1/data_entitlements/roles/{id}

This service gets data entitlement role.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

last_updated_user

string

User who last updated the role

name

string

Human-readable name

description

A list of errors.

Delete data entitlement role

DELETE /mdm/v1/data_entitlements/roles/{id}

This service deletes a data entitlement role.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

id

Required *

string

id of the role

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Update data entitlement role

PATCH /mdm/v1/data_entitlements/roles/{id}

This service updates data entitlement role.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

User who last updated the role

name

string

Human-readable name

description

A list of errors.

Get all access tokens by a role

GET /mdm/v1/data_entitlements/roles/{id}/access_tokens

This service gets all access tokens for a given role.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

id

Required *

string

id of the role

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of roles to skip over.

limit

integer

The number of roles to be returned. The maximum limit is 1000.

Response

200 - The access tokens associated with the role has been successfully retrieved.

last

POST /mdm/v1/data_entitlements/roles/{id}/access_tokens/batch

This service associate or unassoicate access token to the given role in batch mode.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

DataEntitlementRoleBatchAssociateTokens

add

array

Array of token IDs to add

remove

array

Array of token IDs to remove

Path Parameters

id

Required *

string

id of the role

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Batch assign data entitlement roles

POST /mdm/v1/data_entitlements/roles/batch_assign

This service assigns data entitlement roles to users and usergroups in batch mode.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

DataEntitlementBatchAssignRoles

assign

array

Array of role assignments to users and/or groups

unassign

array

Array of role unassignments from users and/or groups

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The roles have been successfully assigned.

assigned

array

array

A list of errors.

Search data entitlements, access tokens and roles

POST /mdm/v1/data_entitlements/search

This service searches data entitlements, access tokens and roles.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

DataEntitlementSearch

include

object

query

Required *

string

search_type

Required *

string

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

user_ids

string

The list of comma separated user ids.

group_ids

string

The list of comma separated group ids.

offset

integer

The number of tokens to skip over.

limit

integer

array

A list of errors.

List the export jobs

GET /mdm/v1/data_exports

View a summary list of export jobs that have been requested.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of exports to skip before returning a page of results.

limit

integer

The maximum number of exports to return in each page of results. The maximum limit is 50.

include_expired

boolean

Whether to include exports with expired files.

Response

200 - The list of exports was retrieved successfully.

The HTTP status code of the response.

errors

array

A list of errors.

Start an export of search results

POST /mdm/v1/data_exports

Run a data export job to export the results of a search. Export format, search criteria, and file name are configurable in the message body. The file name must only contain alphanumeric characters, and be 64 characters or less.

The operation runs as follows:

On public cloud, instance metadata must be configured and include valid bucket credentials before an export job is started.
A compression type must be provided when a partition type of 'executor_count' is specified.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

ExportRequest

Valid object defining the export format and search criteria for the export job.

export_type

Required *

string

The type of data to export.

format

Required *

string

The format of the export file.

search_criteria

Required *

Query Parameters

crn

Required *

string

Optional Access Token

Response

A list of errors.

Get information for an export

GET /mdm/v1/data_exports/{export_id}

View detailed information about the specified export job. The process ids can be used to track the job status through the Job APIs.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

A list of errors.

Download an export file

GET /mdm/v1/data_exports/{export_id}/download

Download the resulting file from a completed export job if the file exists. The export files may expire after some time.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

export_id

Required *

string

The ID of the export. This ID is equivalent to the job ID of the export job.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get data health status

GET /mdm/v1/data_health

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

errors

array

A list of errors.

List the jobs

GET /mdm/v1/data_jobs

View a list of jobs that have been run. Filter on job type or job status to get a more precise list of jobs.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of jobs to skip before returning a page of results.

limit

integer

The maximum number of jobs to return in each page of results. The maximum limit is 50.

status

string

Filter by job status.

type

string

Filter by job type.

Response

200 - The list of jobs was retrieved successfully.

The HTTP status code of the response.

errors

array

A list of errors.

Get information for a job

GET /mdm/v1/data_jobs/{job_id}

View information about the specified job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

job_type

string

The type of job.

status

A list of errors.

Clean up job data

POST /mdm/v1/data_jobs/{job_id}/clean_up

Delete any uploaded artifacts from the system after the job completes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

job_id

Required *

string

The ID of the job.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Stop a given job

POST /mdm/v1/data_jobs/{job_id}/stop

Attempt to stop a running job. This operation does not rollback changes made by the job process prior to stopping the job. Full deletion of job resources may take up to a few minutes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

job_type

string

The type of job.

status

A list of errors.

Retrieve the data model

GET /mdm/v1/data_model

This service retrieves the data model for record types and relationship types.
Data model defines the fields and attributes associated to one or more record types (e.g. person, organization) and one or more relationship types (e.g. sibling, employment).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

version

string

The identifier for a given state of the data model, ie. current, draft

Response

200 - The data model has been successfully retrieved.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Overwrite the data model

PUT /mdm/v1/data_model

This service completely overwrites the data model for record types and relationship types.
Data model defines the fields and attributes associated to one or more record types (e.g. person, organization) and one or more relationship types (e.g. sibling, employment).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

DataModel

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The data model has been successfully modified.

Partially modify data model

PATCH /mdm/v1/data_model

This service partially modifies the data model for record types and relationship types.
Data model defines the fields and attributes associated to one or more record types (e.g. person, organization) and one or more relationship types (e.g. sibling, employment).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

DataModel

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The data model has been successfully modified.

Retrieve the default matching fields for known attribute types

GET /mdm/v1/data_model/default_matching_fields

This service retrieves the default matching fields only for the known attribute types

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The default matching fields for known attribute types has been successfully retrieved.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Report entity confidence metrics

GET /mdm/v1/data_quality/entity_confidence_metrics

This service reports the entity confidence metrics.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

update_dq_dashboard

boolean

The API will report the entity confidence metrics to DQ dashboard when the parameter is true. Default is false

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve list of issues for given entities or record

GET /mdm/v1/data_quality/issues

This service retrieves list issues for given entities or record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_number

integer

The unique identifier of a source record as assigned by the system

entities

array

The entity identifiers of an entity as assigned by the system

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

limit

integer

The number of issues to be retrieved for the given entities

offset

integer

The number of issues to skip before returning the result

fetch_total_count

boolean

If true, the total number of issues for the given entity ids and types will be returned. Otherwise, the number of results will be returned. Default value is true

include_tags

boolean

If true, tag details (id, name, color) will be included in the response for each potential match issue. Default value is false

include_record_attributes

string

Comma-separated list of record attribute names to include in the response for each entity

Response

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Batch update tags on potential matches

POST /mdm/v1/data_quality/potential_matches/batch

This service updates tags on multiple potential match relationships.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

list matching remediation workflows

GET /mdm/v1/data_quality/remediation_workflows

This service lists the matching remediation workflows for a given entities.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

entities

array

The entity identifiers of an entity as assigned by the system

limit

integer

The number of issues to be retrieved for the given entities

offset

integer

The number of issues to skip before returning the result

Response

200 - The request has been successfully finished.

object

last

object

offset

integer

total_count

integer

limit

integer

workflows

array

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Start matching remediation workflow

POST /mdm/v1/data_quality/remediation_workflows

This service starts the matching workflow.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

StartWorkflowRequest

entities

Required *

array

Collection of entities

type

Required *

string

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The request has been successfully finished.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

get matching remediation workflows

GET /mdm/v1/data_quality/remediation_workflows/{workflow_id}

This service get the matching workflow with given workflow id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

workflow_id

Required *

string

The unique identifier of a workflow as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

delete matching remediation workflows

DELETE /mdm/v1/data_quality/remediation_workflows/{workflow_id}

This service deletes the matching workflow with given workflow id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Path Parameters

workflow_id

Required *

string

The workflow identifier of an workflow as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

remove_workflow_instance

boolean

The API will not delete workflow instance if the value is set to false. Default is true

Response

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

patch matching remediation workflows

PATCH /mdm/v1/data_quality/remediation_workflows/{workflow_id}

This service updates the matching workflow with given workflow id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

PatchRemediationWorkflow

issue_actions

array

Collection of issue remediation actions

bulk_action

object

The decision of user on all the issues

Path Parameters

workflow_id

Required *

string

The workflow identifier of an workflow as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

resolve matching remediation workflows

POST /mdm/v1/data_quality/remediation_workflows/{workflow_id}/resolve

This service resolves the matching workflow with given workflow id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Path Parameters

workflow_id

Required *

string

The workflow identifier of an workflow as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Starts matching bulk remediation workflows

POST /mdm/v1/data_quality/remediation_workflows/bulk_start_workflows

This service starts bulk workflows.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

StartBulkWorkflowRequest

limit

Required *

integer

search_criteria

StartBulkWorkflowRequestSearchCriteria

The wrapper object for search criteria used for stating bulk remediation workflow request

query

Required *

object

The wrapper object for query used for stating bulk remediation workflow request

filters

Required *

array

search_type

Required *

string

entity_pairs

array

Path Parameters

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Remove manual link/unlink

POST /mdm/v1/delete_linkage_rules

This service removes one or more manual link/unlink rules supplied by user.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

RulesRequest

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

rules

Required *

array

Collection of linkage rules

create_rule_for_non_existent_derived_data

boolean

creates a rule when derived data is not present

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Delete sample pair selections

DELETE /mdm/v1/delete_sample_pair_batches

This service deletes batches of previously selected sample pairs.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Path Parameters

A list of pair selections to delete

Response

The HTTP status code of the response.

errors

array

A list of errors.

Preview derived data

POST /mdm/v1/derive

This service computes and returns a preview of the derived data for the input records.
Data derivation is the process to standardize and generate buckets for the input records.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

DeriveRecordsRequest

records

Required *

array

Collection of records

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

details

string

The level of information detail in response, ie. low, high, debug

Response

The HTTP status code of the response.

errors

array

A list of errors.

Preview the composite view of an entity given set of records

POST /mdm/v1/entities

View attributes for an entity in a consolidated view based on defined composite view rules from the request.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

RecordIdList

List of recordIds for which composite view is to be found

record_ids

Required *

array

Get IDs of records

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

entity_type

Required *

string

Entity Type

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Return clusters, if they exist, for a given entity.

GET /mdm/v1/entities/{entity_id}/clusters

This service retrieve all the clusters for records belonging to an entity. Returns existing clusters if present, otherwise, they are generated, stored and then returned.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

entity_id

Required *

string

The entity identifier of an entity as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of entries to skip before returning a page of results. The default offset is 0.

limit

integer

The maximum expected number of entries in each page of results. The default limit is 10.

anomalous_only

boolean

The response would contain only anomalous clusters when it is set to true. Default is false

fetch_total_count

boolean

The response would return total_count as the number of persisted clusters when set to true, otherwise the size of the response. Default is true

Response

200 - The request has been successfully finished.

object

href link of the next page

last

object

href link of the last page

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve an entity's manual links/unlinks

GET /mdm/v1/entities/{entity_id}/linkage_rules

This service retrieves all manual link/unlink rules for specified entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

entity_id

Required *

string

The entity identifier of an entity as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The request has been successfully finished.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get the composite view of an entity

GET /mdm/v1/entities/{id}

View attributes for an entity in a consolidated view based on defined composite view rules from the Model APIs.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

string

The unique identifier of the entity.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

include

array

Record attributes from the data model to include in the results.

exclude

array

Record attributes from the data model to exclude from the results.

as_of

string

Point in time to retrieve the record history. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-10', '2025-09-10T13:59:59', '2025-09-10T13:59:59Z').

force_compute

boolean

When set to true, forces computation of the entity view instead of using the persisted view. Defaults to false. Useful for performance testing and comparing computed vs persisted entity views.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Replace entity-level attributes of a persisted entity

PUT /mdm/v1/entities/{id}

Replace the existing persisted entity with the new set of attributes. Any existing editable entity-level attributes not specified in the request will be removed from the entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataEntity

Valid object defining the attributes of an entity to replace the existing entity-level attributes. All non-entity attributes will be ignored.

id

string

The id of the element.

type

Required *

string

attributes

Required *

object

The list of the attributes of the element.

system_attributes

object

The list of the system attributes of the element.

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Patch entity-level attributes of a persisted entity

PATCH /mdm/v1/entities/{id}

Patch the existing persisted entity with the new set of attributes. Any existing editable entity-level attributes not specified in the request will be retained in the entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataEntity

Valid object defining the attributes of an entity to patch the existing entity-level attributes. All non-entity attributes will be ignored.

id

string

The id of the element.

type

Required *

string

attributes

Required *

object

The list of the attributes of the element.

system_attributes

object

The list of the system attributes of the element.

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

List the entity history

GET /mdm/v1/entities/{id}/history

Retrieves the history of changes made to an entity within the specified time range. The response provides a chronological view of additions, updates or deletions that occurred during the requested period.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

The end of the time range (inclusive) for retrieving entity history changes. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-15', '2025-09-15T10:11:05', '2025-09-15T10:11:05Z').If provided, history changes till the given time will be fetched. If not provided, history changes till the latest available will be fetched

offset

integer

The number of entity history changes to skip over.

limit

integer

The number of entity history changes to be returned. The maximum limit is 50.

action_types

string

To filter history events based on action performed on it. If provided, history events with given action will be retrieved. If not provided, history events irrespective of action will be fetched. Accepts comma separated values as String. Valid values are create, update, delete

history_types

string

To filter history events based on type of history data. If provided, history events with given history type will be retrieved. If not provided, history events irrespective of history type will be fetched. Accepts comma separated values as String. Valid values are entity, relationship, linkage

Response

200 - The entity history have been successfully retrieved.

The HTTP status code of the response.

errors

array

A list of errors.

List the records linked into an entity

GET /mdm/v1/entities/{id}/records

View a list of member records that form the entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

string

The unique identifier of the entity.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

limit

integer

The maximum number of records to return in each page of results. The maximum limit is 50.

offset

integer

The number of records to skip before returning a page of results.

include

array

Record attributes from the data model to include in the results.

exclude

array

Record attributes from the data model to exclude from the results.

include_total_count

boolean

Flag to include the total record count on pages other than the first.

as_of

string

Point in time to retrieve the record history. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-10', '2025-09-10T13:59:59', '2025-09-10T13:59:59Z').

Response

200 - The entity records have been successfully retrieved.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

List the records associated with entity records

GET /mdm/v1/entities/{id}/related_records

View a list of records that have a relationship to the member records of the specified entity based on the specified relationship type. All records related to the specified entity will be returned regardless of relationship direction. The relationship type is expected to be defined in the data model.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

string

The unique identifier of the entity.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

The type of records to return in results.

relationship_type

Required *

string

The type of relationship between related records and entity member records.

limit

integer

The maximum number of records to return in each page of results. The maximum limit is 50.

offset

integer

The number of records to skip before returning a page of results.

include

array

Record attributes from the data model to include in the results.

exclude

array

Record attributes from the data model to exclude from the results.

include_total_count

boolean

Flag to include the total record count on pages other than the first.

Response

A link to the next page of results.

related_records

array

The paged list of related records.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

401 - Problem processing request. The user is not authenticated.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

array

A list of errors.

List the relationships for an entity

GET /mdm/v1/entities/{id}/relationships

View a list of relationships that exist between the given entity and other nodes on the graph. This endpoint does not include internal relationships in the resulting list of relationships.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

Whether to include entity record relationships to other nodes.

offset

integer

The number of relationships to skip over.

limit

integer

The number of relationships to be returned. The maximum limit is 50.

source_include

array

Attributes from the data model to include in the results for the source vertex.

target_include

array

Attributes from the data model to include in the results for the target vertex.

as_of

string

Point in time to retrieve the relationship history. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-10', '2025-09-10T13:59:59', '2025-09-10T13:59:59Z').

Response

200 - The relationships have been successfully retrieved.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get entity detail

POST /mdm/v1/entity_detail

This service provides entity members, matched pairs, and manual rules.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

EntityRequest

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

entity_number

array

Collection of entity numbers

record_type

Required *

string

The data type identifier of record, ie. person, organization

min_score

number

The minimal score for matched pairs

record_numbers

array

Collection of record numbers

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve all entity ids

GET /mdm/v1/entity_ids

This service retrieves all assigned entity_ids for a given record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_number

integer

The unique identifier of a source record as assigned by the system

record_source

string

The source system name of the record

record_id

string

The record identifier of the record

record_type

string

The data type identifier of source records, ie. person, organization

Response

200 - The request has been successfully finished.

entities

array

Collection of entity ids and entity types

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve record ids

GET /mdm/v1/entity_ids/{entity_id}

This service retrieves all record_ids that are assigned with the same entity_id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

entity_id

Required *

string

The entity identifier of an entity as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The request has been successfully finished.

records

array

Collection of record number, record id and record source

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve list of event subscription based on filters

GET /mdm/v1/event_subscription

This service retrieves a list of event subscriptions based on filters.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

limit

integer

The maximum number of elements to return in each page of results. The maximum limit is 50.

offset

integer

The number of elements to skip before returning a page of results.

event_type

string

Type of the event, i.e. entity_change or record_change

Response

200 - List of event subscriptions have been successfully retrieved.

event_subscriptions

array

Collection of event subscriptions

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Create or Update Event Subscription

PUT /mdm/v1/event_subscription

This service performs the event subscription creation/update.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

EventSubscription

subscription_id

string

Event Subscription id

filter

array

Event Subscription filters, need to filter subscription based on the passed filter.

event_type

Required *

string

Event Subscription type

string

Event Subscription description

subscription_name

Required *

string

Event Subscription name

active

boolean

Event Subscription active status

created_date

string

Event Subscription creation date

last_update_date

string

Event Subscription last update date

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Remove an existing Event subscription

DELETE /mdm/v1/event_subscription/{subscription_id}

This service removes an existing Event subscription specified by the supplied subscription_id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

subscription_id

Required *

string

The unique identifier of a subscription_id as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The event subscription has been successfully removed.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve the active workflow information

GET /mdm/v1/flows

This service retrieves the active workflow information, if present, of a previously requested change to data model.
An update to data model is only finalized when its corresponding workflow is approved by the authorized approvers.
This capability is primarily built for internal approval processes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The flow status of an active workflow has been successfully retrieved

flows

array

Collection of active flows

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve the latest workflow information

GET /mdm/v1/flows/{flow_id}

This service retrieves the latest workflow information of a previously requested change to data model.
An update to data model is only finalized when its corresponding workflow is approved by the authorized approvers.
This capability is primarily built for internal approval processes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Remove an existing workflow

DELETE /mdm/v1/flows/{flow_id}

This service removes an existing workflow specified by the supplied flow_id.
An update to data model is only finalized when its corresponding workflow is approved by the authorized approvers.
This capability is primarily built for internal approval processes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

flow_id

Required *

string

The unique identifier of a workflow as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Approve or Reject an active workflow

PATCH /mdm/v1/flows/{flow_id}

This service is used to approve or reject an active workflow specified by the supplied flow_id.
An update to data model is only finalized when its corresponding workflow is approved by the authorized approvers.
This capability is primarily built for internal approval processes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Current state of flow according to its state machine

flow_type

string

Type of flow. One of: data_model, algorithm, compare_spec_resources, composite_rules, map_resources or set_resources

rejections

A list of errors.

Retrieve the governance metadata containing the connected data asset details.

GET /mdm/v1/governance_metadata

This service retrieves the connected data asset details for record types and entity types

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The connected data asset details has been successfully retrieved.

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Update the governance metadata containing the connected data asset details.

PUT /mdm/v1/governance_metadata

This service updates the connected data asset details for record types and entity types

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

GovernanceMetadata

entity_types

object

Collection of applicable entity types

record_types

object

Collection of user defined record types

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The connected data asset details has been successfully updated.

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get all groups

GET /mdm/v1/groups

This function retrieves all groups if no specific group_type is passed. Otherwise, retrieves groups under the specific group_type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

group_type

string

group type

offset

integer

The number of groups to skip over.

limit

integer

The number of groups to be returned. The maximum limit is 50.

include_member_count

boolean

Flag to include the total member count for each group.

Response

200 - The groups has been retrieved successfully.

The HTTP status code of the response.

errors

array

A list of errors.

Create a new group

POST /mdm/v1/groups

Create a new group and its associated objects.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataGroup

Valid object defining the group to be added to the graph.

integer

group number

member_count

integer

Total Number of members for the group.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get group for a given id

GET /mdm/v1/groups/{id}

Retrieves the group, for a given id and typeName

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

Id of the group

Query Parameters

crn

Required *

string

The cloud resource name of the service.

group_type

Required *

string

type of the group

included_associations

string

The associated objects.

offset

integer

The number of group nodes to skip over.

limit

integer

The number of group nodes to be returned. The maximum limit is 50.

compute_member_count

boolean

Flag to include the member group count.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Replace attributes for a group

PUT /mdm/v1/groups/{id}

Replace the existing group with the new set of attributes. Any existing editable record attributes not specified in the request will be removed from the group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataGroup

Valid object defining the group information to replace the existing group.

integer

group number

member_count

integer

Total Number of members for the group.

Path Parameters

id

Required *

integer

The ID of the group.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Delete a group Instance

DELETE /mdm/v1/groups/{id}

Deletes Group node and all of its relationships for the given group_type and group_number

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

403 - Problem processing request. The user is not authorized to perform the request.

404 - Group instance does not exist.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

500 - Problem performing group delete. An internal error occurred while attempting to update the graph.

Add, update and remove associations from a group

PATCH /mdm/v1/groups/{id}/associations

Add, update and remove associations from a group. The operation runs as follows:

Any element found in both upserts and deletions is considered as a deletion and removed from upsert list.
Any duplicate element in upsert list will cause API to fail.
Any duplicate element in delete list is ignored.
Perform all deletions first and then upserts.
Any element in upsert list with id is considered as an update, otherwise an insert.
For an update scenario, API will replace group association attributes with the new set of values coming in input. ie, any existing editable attributes for group association not specified in the request will be removed from the group association.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

PatchGroupAssociations

Valid object defining the group associations to be added/updated/removed to the graph.

upserts

array

Collection of group associations to create or update.

deletions

array

Collection of group associations to delete.

Path Parameters

id

Required *

integer

The id for the group

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get all the groups for a given id

GET /mdm/v1/groups/by_associated_object/{id}

This function retrieves all the groups to which the given object is part of.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

string

id of respective entity

Query Parameters

crn

Required *

string

The cloud resource name of the service.

type

Required *

string

type of the given id

type_name

Required *

string

type name of the given id

offset

integer

The number of groups to skip over.

limit

integer

The number of groups to be returned. The maximum limit is 50.

include_total_count

boolean

Flag to include the total group count.

Response

200 - The groups has been retrieved successfully.

The HTTP status code of the response.

errors

array

A list of errors.

Add, update and remove groups from given object

PATCH /mdm/v1/groups/by_associated_object/{id}

Add, update and remove groups from a given object. The operation runs as follows:

Any element found in both upserts and deletions is considered as a deletion and removed from upsert list.
Any duplicate element in upsert list will cause API to fail.
Any duplicate element in delete list is ignored.
Perform all deletions first and then upserts.
Any element in upsert list with id is considered as an update, otherwise an insert.
For an update scenario, API will replace group association attributes with the new set of values coming in input. ie, any existing editable attributes for group association not specified in the request will be removed from the group association.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

PatchGroupAssociations

Valid object defining the group associations to be added/updated/removed to the graph.

upserts

array

Collection of group associations to create or update.

deletions

array

Collection of group associations to delete.

Path Parameters

id

Required *

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get group for a given group_id, group_source and group_type

GET /mdm/v1/groups/bysourceid

Retrieves the group for a given group_id, group_type and group_source

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

offset

integer

The number of groups to skip over

limit

integer

The number of groups to be returned. The maximum limit is 50

compute_member_count

boolean

Flag to include the member group count.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Search the data on the group

POST /mdm/v1/groups/search

Search Options:

Simple or Full text search: Use * as the property key, contains as the condition key and group_type must be empty
Advance or Attribute field search: Apply dot notation for keys (e.g. group_name.value) and group_type must be non-empty.
Filters: For simple search, include filters to filter by group types.
Member associated groups: Include associated_member details to filter by a member's groups.
Pagination: supported.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

DataGroupSearchCriteriaRequest

Valid input defining the search criteria.

expressions

Required *

string

The id of the member.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

limit

integer

The maximum number of elements to return in each page of results. The maximum limit is 50.

offset

integer

The number of elements to skip before returning a page of results.

include_total_count

boolean

The field is used to include total count of search data.

Response

200 - The groups has been retrieved successfully.

The HTTP status code of the response.

errors

array

A list of errors.

Get group statistics

GET /mdm/v1/groups/statistics

This function returns groups statistics data

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

group_types

array

Group types to include in the results

Response

The HTTP status code of the response.

errors

array

A list of errors.

Get all the hierarchies

GET /mdm/v1/hierarchies

This function retrieves all hierarchies.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

hierarchy_type

string

The type of the hierarchy

offset

integer

The number of hierarchies to skip over.

limit

integer

The number of hierarchies to be returned. The maximum limit is 200.

include_total_count

boolean

Flag to include the hierarchy total count.

Response

200 - The hierarchy has been retrieved successfully.

hierarchy

DataHierarchy

Information about a hierarchy.

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Create a new hierarchy

POST /mdm/v1/hierarchies

Add a new hierarchy to the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataHierarchy

Valid object defining the hierarchy to be added to the graph.

array

The hierarchy nodes.

relationships

array

The hierarchy relationships.

associated_objects

array

The hierarchy associated objects.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

201 - The hierarchy has been successfully created.

hierarchy

DataHierarchy

Information about a hierarchy.

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Get hierarchy for a given id

GET /mdm/v1/hierarchies/{id}

Retrieves the hierarchy, for a given id and typeName

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

Id of the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

hierarchy_type

Required *

integer

The number of hierarchy nodes to be returned. The maximum limit is 200.

Response

200 - The hierarchy has been retrieved successfully.

hierarchy

DataHierarchy

Information about a hierarchy.

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Delete a Hierarchy Instance

DELETE /mdm/v1/hierarchies/{id}

Deletes the hierarchy anchor node, the hierarchy nodes and all of its relationships for the given hierarchy_type and context_id.The context_id in the hierarchy nodes and the hierarchy_number in the hierarchy anchor node will be the same.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

403 - Problem processing request. The user is not authorized to perform the request.

404 - Hierarchy instance does not exist.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

500 - Problem performing hierarchy delete. An internal error occurred while attempting to update the graph.

Replace attributes for a hierarchy

PATCH /mdm/v1/hierarchies/{id}

Run an update of hierarchy and relationships in the graph by creating, modifying and deleting data in a single transaction. The operation runs as follows:

Performs all node deletions first, then relationship deletions.
After the deletions are completed, all hierarchy upserts (i.e. insertions and updates) are performed next.
Any element found in both deletions and upserts is treated as a deletion, and removed from the upserts list before processing. Attributes and fields can be removed by setting the attribute or field value to empty string "".
A failed update will cause all changes performed by the transaction to be reverted back to the original graph state.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

PatchHierarchy

Valid object defining the record information to replace the existing record.

upserts

object

A Hierarchy and collection of hierarchy nodes to create or update.

id

Required *

integer

The id for the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

hierarchy_type

Required *

string

The type of the hierarchy

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Delete a Hierarchy Branch

DELETE /mdm/v1/hierarchies/{id}/branches/{branch_node_id}

Deletes the hierarchy branch within the given hierarchy, including the specified branch node id and all its descendants.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

integer

The id for the hierarchy

branch_node_id

403 - Problem processing request. The user is not authorized to perform the request.

404 - Hierarchy branch does not exist.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

500 - Problem performing hierarchy branch delete. An internal error occurred while attempting to update the graph.

Get the broken branches of a hierarchy

GET /mdm/v1/hierarchies/{id}/broken_branches

This function retrieve the broken branches of a hierarchy

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

The id for the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

hierarchy_type

Required *

string

The type of the hierarchy

levels

integer

The levels of broken branches nodes to be included

included_associations

string

The associated objects.

offset

integer

The number of hierarchy nodes to skip over.

limit

integer

The number of hierarchy nodes to be returned. The maximum limit is 200.

Response

200 - The broken branches has been retrived successfully.

hierarchy_broken_branches

array

List of broken branches

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Get the centric view of a given hierarchy node

GET /mdm/v1/hierarchies/{id}/centric_view

This function retrieve the centric view of the specific hierarchy node

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

boolean

Flag to include the total direct parents/children nodes count.

Response

200 - The hierarchy node centric view has been retrived successfully.

hierarchy

DataHierarchy

Information about a hierarchy.

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Retrieve the hierarchy configuration for a given id

GET /mdm/v1/hierarchies/{id}/configuration

Retrieve the data in the configuration node associated with the hierarchy instance

Request

Path Parameters

id

Required *

integer

The id for the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The hierarchies statistics data is returned successfully.

hierarchy_statistics

object

Hierarchy statistics.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Create or replace configurations for a hierarchy of the given id

PUT /mdm/v1/hierarchies/{id}/configuration

id

Required *

integer

The id for the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Delete the hierarchy configuration for a given id

DELETE /mdm/v1/hierarchies/{id}/configuration

Delete the configuration node associated with the hierarchy instance

Request

Path Parameters

id

Required *

integer

The id for the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Hierarchy Member Search

GET /mdm/v1/hierarchies/{id}/member_search

This function retrieve the hierarchy member search results

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

The id for the hierarchy

Query Parameters

crn

Required *

string

The cloud resource name of the service.

hierarchy_type

Required *

string

The type of the hierarchy

search_query

Required *

string

The search query for hierarchy member search

offset

integer

The number of hierarchy nodes to skip over.

limit

integer

The number of hierarchy nodes to be returned. The maximum limit is 200.

include

array

Associated Object from the data model to include in the results.

exclude

array

Associated Object from the data model to exclude from the results.

Response

200 - This function retrieve the hierarchy member search results

hierarchy

DataHierarchy

Information about a hierarchy.

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Get all the hierarchy for a given id

GET /mdm/v1/hierarchies/by_associated_object/{id}

This function retrieves all the hierarchies to which the given object is part of.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

string

id of respective entity

Query Parameters

crn

Required *

string

The cloud resource name of the service.

type

Required *

string

type of the given id

type_name

Required *

string

type name of the given id

offset

integer

The number of hierarchies to skip over.

limit

integer

The number of hierarchies to be returned. The maximum limit is 200.

include_total_count

boolean

Flag to include the total hierarchy count.

node_centric_view

boolean

Flag to include the node centric view.

Response

200 - The hierarchy has been retrieved successfully.

hierarchy

DataHierarchy

Information about a hierarchy.

metadata

Metadata

Supplemental information about a resource.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Get hierarchy statistics

GET /mdm/v1/hierarchies/statistics

This function returns hierarchies statistics data

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

hierarchy_statistics

object

Hierarchy statistics.

first

object

A link to the first page.

last

object

A link to the last page.

object

array

A list of errors.

Get history retention policy status

GET /mdm/v1/history/policy_status

This service fetch status of current applied history retention policy.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The history retention policy status has been successfully retrieved.

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Import a snapshot of model assets

POST /mdm/v1/import_model_snapshot

This service imports a snapshot of current model assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

SnapshotImportRequest

algorithms

object

Collection of matching algorithms for different record types e.g. person, organization

compare_spec_resources

object

Collection of various comparison resources used to customize comparison logic of a matching algorithm

relationship_discovery_rules

object

Collection of various relationship discovery rules definitions. Relationship discovery resource key must be lower snake case (i.e. employment_rules)

Query Parameters

crn

Required *

string

array

A list of errors.

Retrieve derived data for a record

GET /mdm/v1/index

This service retrieves the derived data for a given input record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_number

integer

The unique identifier of a source record as assigned by the system

record_source

string

The source system name of the record

record_id

string

The record identifier of the record

record_type

string

The data type identifier of source records, ie. person, organization

Response

200 - The request has been successfully finished.

self_scores

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Derive and link a record

PUT /mdm/v1/index

This service performs data derivation for a given input record and assigns entity_ids.
Data derivation is the process to standardize and generate buckets for the input records.
Entity assignment is the process of finding similar records and linking them with single entity_id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

SingleRecordRequest

attributes

Required *

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Remove derived data for a record

DELETE /mdm/v1/index

This service removes the derived data for a given input record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_number

integer

The unique identifier of a source record as assigned by the system

record_source

string

The source system name of the record

record_id

string

The identifier of the record

record_type

string

The data type identifier of source records, ie. person, organization

Response

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve the configured metadata

GET /mdm/v1/instance_metadata

This service retrieves the configured metadata for a provisioned instance of system.
The onboarding process of a new subscriber to Master Data Management On Cloud depends on capturing and maintaining certain configured metadata for their provisioned instance.
Instance Metadata is a json document that primarily contains the catalog and project information in Watson Knowledge Catalog and the details of Cloud Object Storage if provided by the user.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

History enabled indicator, true or false

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Overwrite the configured metadata

PUT /mdm/v1/instance_metadata

This service overwrites the configured metadata for a provisioned instance of system.
The onboarding process of a new subscriber to Master Data Management On Cloud depends on capturing and maintaining certain configured metadata for their provisioned instance.
Instance Metadata is a json document that primarily contains the catalog and project information in Watson Knowledge Catalog and the details of Cloud Object Storage if provided by the user.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

string

The unique identifier of a connection to a IBM Master Data Management instance

governance_enabled

boolean

Governance enabled indicator, true or false

create_api_key

boolean

Generate API key from service id, true or false

stream_connection

array

Stream connection details

catalogs

array

Collection of catalog objects as available in Watson Knowledge Catalog (WKC)

job_project_id

string

The unique identifier of a project for the jobs

workflow_type_id

string

The workflow type id created in WKC workflow services

history_enabled

boolean

History enabled indicator, true or false

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get version properties from config map.

GET /mdm/v1/job/version

Get version properties from config map. It will contain the running version of the service

Request

Response

200 - The version properties has been retrieved successfully

500 - An internal error occurred while retrieving the version properties.

503 - Service is not available and can not perform the operation now

Get the health monitor status of the system

GET /mdm/v1/job_health

Request

Path Parameters

severity

string

message

string

400 - Wrong health monitor target option

500 - Problem getting health monitor status. An internal error occurred while attempting to determine the health monitor status.

Retrieve job runs.

GET /mdm/v1/job_runs

Requires the application role of 'JobReader'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

job_name

string

The name of the job.

status

string

The status of the job run.

offset

integer

The offset from the start of the list.

limit

integer

The chunk size (default '50') of the requested sublist.

Response

200 - The job runs were retrieved successfully.

job_runs

array

Requires the application role of 'Service'.

Request

string

The cloud resource name of the service.

Response

201 - The job run was started successfully.

400 - Problem processing request. Invalid or missing input.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - An internal server error occurred.

Delete all job runs from database.

DELETE /mdm/v1/job_runs

This is a internal REST call.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

default - default response

Fetch job run information.

GET /mdm/v1/job_runs/{job_run_id}

Requires the application role of 'JobReader'.

Request

Path Parameters

job_run_id

Required *

string

The id of the job run.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The job run information was retrieved successfully.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

404 - Job run not found.

500 - An internal server error occurred.

Update a job run information.

PATCH /mdm/v1/job_runs/{job_run_id}

Requires the application role of 'Service'. Only the `status` can be updated using this endpoint.

Request

Request Body

JobRunUpdateRequest

200 - The job run was updated successfully.

400 - Problem processing request. Status used is invalid.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

404 - Job run not found.

500 - An internal server error occurred.

Cancel a running job run or remove job run from queue.

POST /mdm/v1/job_runs/{job_run_id}/cancel

Requires the application role of 'JobWriter'.

Request

Path Parameters

job_run_id

Required *

string

The id of the job run.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

204 - The job run was cancelled successfully.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

404 - Problem getting job run information. Job run not found.

500 - An internal server error occurred.

Retrieve active jobs.

GET /mdm/v1/job_runs/active_job_list

Retrieve active jobs from the active job tracker.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The job run stats were retrieved successfully.

job_runs

array

Requires the application role of 'JobWriter'.

Request

Request Body

JobDeleteRequest

Object containing the list of job IDs to delete

job_id_list

array

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

204 - The job run was deleted successfully.

401 - Problem processing request. The user is not authenticated.

The cloud resource name of the service.

Response

200 - The job run was started successfully.

204 - The job queue is empty.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - An internal server error occurred.

Retrieve job statistics.

GET /mdm/v1/job_runs/statistics

Requires the application role of 'JobReader'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The job run stats were retrieved successfully.

total_job_runs

integer

statistics

JobStatistics

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

404 - Problem processing request. Status used for filter is invalid.

500 - An internal server error occurred.

Fetch the current value of job status polling metadata

GET /mdm/v1/job_status_polling_metadata/{process_name}

Fetch the current value of job status polling metadata. This is useful to debug the issues with auto resumption of matching/loading job after pod restart

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

process_name

Required *

string

The process name to proceed matching or loading

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Fetched job status polling metadata successfully.

id

string

array

A list of errors.

Replace job status polling metadata

PUT /mdm/v1/job_status_polling_metadata/{process_name}

Replace job status polling metadata

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

The data type identifier of the comparison pair records.

record_type

string

The data type identifier of the comparison pair records.

The identified category of the comparison record pair.

record_number_1

string

The record number of the first record of the comparison record pair.

record_number_2

A list of errors.

List job

GET /mdm/v1/jobs

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The request has been successfully finished.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Destroy job

DELETE /mdm/v1/jobs

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

job_id

Required *

string

Job identifier after job been submitted

Response

200 - The request has been successfully finished.

201 - Created

401 - Authentication error

403 - Authorization error

404 - Http error not found

500 - Unchecked internal server error

Perform the compare job

POST /mdm/v1/jobs/compare

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

do_force

boolean

Force to re-match all records, default is false

record_type

Required *

boolean

Do checkpoint

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform asynchronous processing of the derive job of a data file

POST /mdm/v1/jobs/derive

This job is performed in IBM Cloud Storage. Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

do_force

boolean

Force to re-derive all records, default is false

record_type

Required *

string

IBM COS secret key

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform asynchronous processing of the export job

POST /mdm/v1/jobs/export

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

output_path

Required *

string

Output directory

do_wait

boolean

Wait for job finish, default is false

record_type

Required *

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform asynchronous processing of the export linkage rules job

POST /mdm/v1/jobs/export_linkage_rules

Requires the application role of 'MatchingManager'.

Request

Request Body

PostExportRulesRequest

filter

Required *

partition_type

string

The type of partitioning used when exporting the results. ie. null, executor_count

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform asynchronous processing of the token frequency calculation job

POST /mdm/v1/jobs/freq_calculation

This job calculates token frequencies from derived record data and stores outliers in Neo4j. Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

record_type

Required *

string

Record type of input data

maximum_tokens_count

integer

Maximum allowed total count of outlier tokens (high frequency + low frequency). Job fails if exceeded.

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Initiate generate pairs job

POST /mdm/v1/jobs/generate_pairs

This service initiates asynchronous processing of the generate pairs job. Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

max_pairs

string

The maximum number of pairs to return

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform asynchronous processing of the import linkage rules job

POST /mdm/v1/jobs/import_linkage_rules

Requires the application role of 'MatchingManager'.

Request

Request Body

PostImportRulesRequest

storage_bucket

string

The storage bucket for the output file, ie. bucket-27200-lwx4cfvcue

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

storage_endpoint

string

The storage endpoint for the output file, ie. https://s3.us-east.cloud-object-storage.appdomain.cloud

storage_access_key

string

The access key for your storage, ie. cf4965cebe074720a4929759f57e1214

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

is_derived_data_available

boolean

Is derived data present in system, default is true

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform the link job

POST /mdm/v1/jobs/link

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

entity_type

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

do_analytics

boolean

collect analytics report, default is false

do_replicate

boolean

Replicate entity id, default is false

do_checkpoint

boolean

Do checkpoint

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Get Job Log

GET /mdm/v1/jobs/log

Requires the application role of 'MatchingReader'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

job_id

Required *

string

Job identifier after job been submitted

Response

A list of errors.

Perform asynchronous processing of the match job

POST /mdm/v1/jobs/match

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

do_force

boolean

Force to re-match all records, default is false

do_deduplicate

boolean

Deduplicate pairs, default is false

record_type

Required *

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Perform asynchronous processing of the matching export job

POST /mdm/v1/jobs/matching_export

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

output_path

string

The output path under /home/default for the exported data

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

This service exports the model data to shared volume at the destination folder

POST /mdm/v1/jobs/model_export

Requires the application role of 'ModelManager'.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

output_path

string

The output path under for the exported data

Response

A list of errors.

Index Report

POST /mdm/v1/jobs/report

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

entity_type

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

job_list

string

Comma separated analytics report identifier to be collected, ie. entity_summary, bucket_summary

do_analytics

boolean

collect analytics report, default is false

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Get Job Results

GET /mdm/v1/jobs/result

Requires the application role of 'MatchingReader'.

Request

Path Parameters

Response

200 - The request has been successfully finished.

401 - The request cannot be processed due to authentication error.

403 - The request cannot be processed due to insufficient permission error.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

Perform pair wise comparisons of the records for each entity in entities list

POST /mdm/v1/jobs/score_entities

Requires the application role of 'MatchingManager'.

Request

Request Body

PairComparatorEntityRequest

entities

Required *

array

List of entity ids

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

output_path

Required *

string

Output directory

Required *

string

IBM COS secret key

Response

200 - The request has been successfully finished.

start_time

string

The timestamp when a job was started

process_id

integer

The identifier of a process as assigned by the spark

job_id

A list of errors.

Get Job Summary

GET /mdm/v1/jobs/summary

Requires the application role of 'MatchingReader'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

job_id

Required *

string

Job identifier after job been submitted

Response

A list of errors.

generate weights

POST /mdm/v1/jobs/weights

Requires the application role of 'MatchingManager'.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

do_wait

boolean

Wait for job finish, default is false

record_type

Required *

string

Record type to be matched

entity_type

string

Entity type to be matched, matchs all if missing

Response

A list of errors.

Add or update manual link/unlink

PUT /mdm/v1/linkage_rules

This service adds or updates a collection of manual link/unlink rules.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Request Body

RulesRequest

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

rules

Required *

array

Collection of linkage rules

create_rule_for_non_existent_derived_data

boolean

creates a rule when derived data is not present

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Check the existence of linkage rules

GET /mdm/v1/linkage_rules/exist

This service checks for the existence of valid and invalid linkage rules for specified entity type when record filter is enabled.*

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

invalid

boolean

To check if invalid manual linkage rules exist, default is false

Response

200 - The request has been successfully finished.

linkage_rules_exist

string

True when there are any manual linkage rules for the given entity type

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Preview entity composition

POST /mdm/v1/linkage_rules_preview

This service provides a preview of the impacted entities by hypothesizing one or more manual link/unlink rules.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

RulesRequest

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

rules

Required *

array

Collection of linkage rules

create_rule_for_non_existent_derived_data

boolean

creates a rule when derived data is not present

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

List previous sample pair selections

GET /mdm/v1/list_sample_pair_batches

This service selects the batches of previously selected sample pairs.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

Response

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve a summary of all equivalency criteria

GET /mdm/v1/map_resources

This service retrieves the list of resource names of all existing equivalency criteria.
A Map Resource is a json document containing a collection of equivalency criteria (e.g. BOB, ROB) for given tokens (e.g. ROBERT).
A Map Resource may be used in standardization, bucket generation and comparison recipes within one more more algorithms.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The resources have been successfully retrieved.

map_resource_names

array

Collection of map resource names

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve details of equivalency criteria

GET /mdm/v1/map_resources/{resource_name}

This service retrieves all existing equivalency criteria for a given resource name.
A Map Resource is a json document containing a collection of equivalency criteria (e.g. BOB, ROB) for given tokens (e.g. ROBERT).
A Map Resource may be used in standardization, bucket generation and comparison recipes within one more more algorithms.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

resource_name

Required *

string

The unique identifier for the configuration for the equivalent words

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The resources have been successfully retrieved.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The resources requested do not exist.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Overwrite equivalency criteria

PUT /mdm/v1/map_resources/{resource_name}

This service completely overwrites equivalency criteria for a given resource name.
A Map Resource is a json document containing a collection of equivalency criteria (e.g. BOB, ROB) for given tokens (e.g. ROBERT).
A Map Resource may be used in standardization, bucket generation and comparison recipes within one more more algorithms.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

MapResource

Path Parameters

resource_name

Required *

string

The unique identifier for the configuration for the equivalent words

Query Parameters

crn

Required *

string

array

A list of errors.

Fetch existing mapping pattern

GET /mdm/v1/mapping_pattern

Fetch existing mapping pattern.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Store/Replace mapping patterns.

PUT /mdm/v1/mapping_pattern

Store/Replace mapping patterns.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

MappingPattern

id

string

System generated id when a mapping pattern was created/updated.

last_updated_at

string

System generated timestamp when a mapping pattern was last updated

mapping_patterns

array

Collection of Asset Mapping Patterns for Data Asset.

Path Parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Retrieve masked attributes for a user.

GET /mdm/v1/masked_attributes

This service retrieves the masked attributes for a user

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

The data type identifier of source records, ie. person, organization, contract or entity, ie. person_entity, organization_entity, household_entity

Response

200 - The list of masked columns has been successfully retrieved.

masked_columns

array

Collection of fully qualified name of a masked column

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get matching statistics

GET /mdm/v1/match_statistics

Gets the matching statistics (such as number of entities, entity size distributions, etc.) for the specified record type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Entity type of match statistics

Response

200 - Statistics retrieved

status

object

The status of match process execution.

summary

A list of errors.

Get the version of the matching microservice

GET /mdm/v1/matching/version

Request

Response

200 - The version check was successfully performed.

500 - Problem getting version. An internal error occurred while attempting to determine the version.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get matching health status

GET /mdm/v1/matching_health

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

errors

array

A list of errors.

Retrieve information for a job

GET /mdm/v1/matching_jobs/{job_id}

This service retrieves the information about a job which is identified with the supplied job id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

job_id

Required *

string

The unique identifier of the job.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Performs migration of the MDM Advanced Edition

POST /mdm/v1/migration/advanced_edition

Performs migration of MDM Advanced edition with optional matching algorithm and publisher configuration

Request

Request Body

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

preview

Required *

boolean

Return converted metadata only without actually deployment

Response

200 - The metadata migration was migrated successfully.

data_model

object

Migrated data model

mapping_model

object

Migrated publisher mapping

warnings

array

List of warnings raised during the migration process

400 - Problem processing request. Received an invalid request.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - An internal error occurred when attempting the migration.

Performs migration of InfoSphere Big Match metadata (model and algorithm)

POST /mdm/v1/migration/bigmatch

Performs migration of the provided BigMatch config and HBase table config <br><ol><li><a href="https://www.ibm.com/docs/en/imdm/11.6.0?topic=rowfbmc-running-export-records-workflow-from-big-match-console">Export records</a> from BigMatch table. Choose format as "tsv".</li><li>Transfer the file to storage accessible by Match 360. <ol> <li><a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/FileSystemShell.html#get">Copy the exported folder from HDFS to local storage</a>.</li> <li>Copy the folder in local folder to Match 360 storage (FTP, SCP, IBM COS, etc.).</li> </ol></li><li>Start a <a href="https://cloud.ibm.com/apidocs/mdm#run-data-bulk-load">bulk load of data</a> into Match 360 with the "request_bulk_load" from response as payload.</li></ol>

Request

Request Body

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The metadata migration was migrated successfully.

data_model

object

Migrated data model

mapping_model

object

Migrated publisher mapping

warnings

array

List of warnings raised during the migration process

400 - Problem processing request. Received an invalid request.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - An internal error occurred when attempting the migration.

Performs migration of MDM Standard Edition

POST /mdm/v1/migration/standard_edition

Performs migration of MDM Standard edition with provided Workbench project and publisher config

Request

Request Body

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

preview

Required *

boolean

Return converted metadata only without actually deployment

Response

200 - The metadata migration was migrated successfully.

data_model

object

Migrated data model

mapping_model

object

Migrated publisher mapping

warnings

array

List of warnings raised during the migration process

400 - Problem processing request. Received an invalid request.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - An internal error occurred when attempting the migration.

Get the version of the migration microservice

GET /mdm/v1/migration/version

Request

Response

200 - The version check was successfully performed.

500 - Problem getting version. An internal error occurred while attempting to determine the version.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Start a migration export

POST /mdm/v1/migration_data_exports

Run a migration data export job to export the results. Export type, Record type, Relationship type and Entity type are optional and are configurable in the message body. The operation runs as follows:

On public cloud, instance metadata must be configured and include valid bucket credentials before an export job is started.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

MigrationExportRequest

Valid object defining the export format for the export job.

export_types

Required *

array

The types of migration data to export.

compression_type

string

record_types

array

The record types of the migration data to export

relationship_types

array

The relationship types of the migration data to export

entity_types

array

integer

The number of spark executors

executor_memory

string

Amount of memory to use per executor process

executor_core_count

integer

The number of cores to use on each executor

spark_parallelism

integer

The number of partitions to be used by spark

is_resume_job

Required *

boolean

Is this job to be resumed from a previous job or a fresh new export

previous_export_id

string

The ID of the failed export to resume

Response

record_types

array

The record types of the migration data to export

relationship_types

A list of errors.

Get migration health status

GET /mdm/v1/migration_health

Checks the health status of the migration service. The service is stateless and does not depend on external services.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.migration.read

Request

Path Parameters

message

string

Additional details about the health status.

Get the version of the model microservice

GET /mdm/v1/model/version

Request

Response

200 - The version check was successfully performed.

500 - Problem getting version. An internal error occurred while attempting to determine the version.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve all code table names with language support

GET /mdm/v1/code_table/code_table_names

Retrieve all available code table names with their supported languages.
Code tables that support multiple languages will list all available languages.
Code tables without language support will have an empty language array.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The code table names have been successfully retrieved.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get model health status

GET /mdm/v1/model_health

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

errors

array

A list of errors.

Retrieve a list of snapshots

GET /mdm/v1/model_snapshots

This service retrieves a list of snapshots.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

limit

integer

The maximum number of elements to return in each page of results. The maximum limit is 50.

offset

integer

The number of elements to skip before returning a page of results.

Response

200 - List of snapshots has been successfully retrieved.

snapshots

array

list of snapshots

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Create a snapshot of model assets

POST /mdm/v1/model_snapshots

This service creates a snapshot of current model assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

SnapshotCreate

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The snapshot of model assets has been successfully created.

created_time

string

Timestamp when the snapshot was created

name

A list of errors.

Get a snapshot of model assets

GET /mdm/v1/model_snapshots/{id}

This service returns a snapshot of model assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

id

Required *

string

The unique identifier of a snapshot

Query Parameters

crn

Required *

string

The cloud resource name of the service.

current_assets

boolean

Response will return the current model assets disregard the snapshot id when set to true

Response

200 - The snapshot of model assets has been successfully retrieved.

algorithms

object

Collection of matching algorithms for different record types e.g. person, organization

compare_spec_resources

object

Collection of various comparison resources used to customize comparison logic of a matching algorithm

relationship_discovery_rules

object

Collection of various relationship discovery rules definitions. Relationship discovery resource key must be lower snake case (i.e. employment_rules)

mapping_patterns

array

Mapping Patterns

data_model

DataModel

map_resources

object

Collection of various map resources used in matching algorithm, like for handling equivalent values. Map resource key must be lower snake case (i.e. person_map_name_nickname)

set_resources

A list of errors.

Update a snapshot of model assets

PUT /mdm/v1/model_snapshots/{id}

This service updates the name and description of a snapshot of model assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

SnapshotUpdate

name

Required *

string

Name of the snapshot

A list of errors.

Delete a snapshot

DELETE /mdm/v1/model_snapshots/{id}

This service deletes a snapshot.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Path Parameters

id

Required *

string

The unique identifier of a snapshot

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The snapshots has been successfully deleted.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Validate snapshot of model assets

POST /mdm/v1/model_validate

This service validates the snapshot of current model assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

DataModel

map_resources

Required *

object

Collection of various map resources used in matching algorithm, like for handling equivalent values. Map resource key must be lower snake case (i.e. person_map_name_nickname)

set_resources

Required *

object

Collection of various set resources used in matching algorithm, like for handling anonymous values. Set resource key must be lower snake case (i.e. person_set_name_aname)

composite_rules

Required *

CompositeRules

The wrapper object of composite rules

rules

object

Collection of composite rule definitions

locale

string

The request language and location (i.e. enUS)

Path Parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Perform a bulk update of data on the graph

POST /mdm/v1/ongoing_sync

Run an update of records and relationships in the graph by creating, modifying and deleting data in a single transaction. This operation is intended for incremental updates of data. Please use the bulk load feature when loading large volumes of data.

The operation runs as follows:

Performs all relationship deletions first, then record deletions.
After the deletions are completed, all record upserts (i.e. insertions and updates) are performed next, followed by relationship upserts.
Any element found in both deletions and upserts is treated as a deletion, and is removed from the upserts list before processing.
Any other case of a duplicated element will cause the update to fail.
If the 'ignore_redundant_updates' parameter is set to 'true', any update with a timestamp that is not newer than the existing timestamp for that element will not be applied, but it will not cause the entire transaction to fail. If the flag is set to 'false', invalid timestamps will cause a transaction failure.
If 'operation_strategy' is set to 'patch', any attributes not specified will be unchanged on the existing record or relationship. Attributes and fields can be removed by setting the attribute or field value to null. If 'operation_strategy' is not set to 'patch', existing attributes on the record or relationship will be overwritten.
A failed update will cause all changes performed by the transaction to be reverted back to the original graph state.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

A collection of group associations.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

ignore_redundant_updates

boolean

Whether to ignore updates that fail due to missing or invalid 'record_last_updated' timestamps.

delete_history_data

boolean

When set to true, deletes all historical data for the record being deleted, including relationship and linkage history.

Response

A list of errors.

List pair analysis

GET /mdm/v1/pair_analysis

Lists the pair analysis for given tenant.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Add pair analysis results

POST /mdm/v1/pair_analysis

Adds a new pair analysis in configuration space. This allows to store result of tuning job with thresholds

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

entity_type

string

The entity type of the pair analysis.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Delete all pair analysis for a tenent from database.

DELETE /mdm/v1/pair_analysis

This is a internal REST call.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

default - default response

Patch pair analysis

PATCH /mdm/v1/pair_analysis

Updates the pair analysis. Unknown attributes will be ignored

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

UpdatePairAnalysis

pair_offset

integer

The pair offset of the pair analysis data.

tuned_config

object

Tuned config of the pair analysis data.

base_config

object

The base config of the pair analysis data.

pair_gen_job_id

string

The id of pair generation job.

tuning_job_id

string

The tuning job id.

status

string

The pair analysis status

Path Parameters

Entity type of comparison pair

Response

200 - Pair analysis was updated successfully.

pair_offset

integer

The pair offset of the pair analysis data.

tuned_config

object

Tuned config of the pair analysis data.

base_config

A list of errors.

Get pair analysis

GET /mdm/v1/pair_analysis/data

Gets the pair analysis for given entity and record type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Entity type of comparison pair

Response

A list of errors.

Delete all pair analysis for a tenent from database.

DELETE /mdm/v1/pair_analysis/delete_all_pair_analysis_v2

This is a internal REST call.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

default - default response

Delete all pair analysis for a tenent from database.

DELETE /mdm/v1/pair_analysis/delete_by_pair_analysis_id_v2

This is a internal REST call.

Request

Path Parameters

Pair analysis ids

Response

default - default response

List pair analysis v2

GET /mdm/v1/pair_analysis/pair_analysis_list_v2

Lists the pair analysis for given tenant.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Pair analysis is fetched successfully.

properties

object

The properties of the pair analysis containing metadata.

record_type

A list of errors.

Get pair analysis v2

GET /mdm/v1/pair_analysis/pair_analysis_v2

Gets the pair analysis for given entity and record type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Entity type of comparison pair

Response

200 - Pair analysis is fetched successfully.

properties

object

The properties of the pair analysis containing metadata.

record_type

A list of errors.

Request new pair analysis

POST /mdm/v1/pair_analysis/store_pair_analysis_v2

Adds a new pair analysis in configuration space. This allows to store result of tuning job with thresholds

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

PairAnalysisResponseV2

properties

object

The properties of the pair analysis containing metadata.

record_type

string

The record type of the pair analysis.

entity_type

string

The entity type of the pair analysis.

current_analysis

object

The current analysis information.

analysis_history

array

The history of analysis runs.

Path Parameters

Query Parameters

crn

Required *

201 - Pair Analysis created successfully.

properties

object

The properties of the pair analysis containing metadata.

record_type

A list of errors.

Update the pair analysis and create pair decision

PATCH /mdm/v1/pair_analysis/update_pair

Update the pair analysis and create pair decision.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

PairUpdateRequest

pair_decision

object

The decision details for the record pair.

id

Required *

string

The identifier for the comparison pair.

record_number_1

Required *

string

The identifier for the record 1 of the comparison pair.

record_number_2

Required *

string

The identifier for the record 1 of the comparison pair.

user_decision

Required *

string

The pair analysis status

Path Parameters

Entity type of comparison pair

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Update pair analysis v2

PATCH /mdm/v1/pair_analysis/update_pair_analysis_v2

Update multiple pair analysis for a given record type and entity type

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

UpdatePairAnalysisListV2

pair_analysis

Required *

array

List of pair analysis items

revision

integer

The expected revision in the database for checking concurrent modification.

Path Parameters

Entity type of pair analysis

Response

A list of errors.

List comparison record pair decision

GET /mdm/v1/pair_decisions

Lists the filtered comparison record pair decision.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

record_number_2

string

Record identier of comparison pair

offset

string

Pair comparison offset

limit

string

no of comparison pairs to be fetched

Response

The HTTP status code of the response.

errors

array

A list of errors.

Add comparison record pair decision

POST /mdm/v1/pair_decisions

Adds a new comparison record pair decision in configuration space. This allows to store user decision taken on comparison of record pairs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

The data type identifier of the comparison pair records.

record_type

string

The data type identifier of the comparison pair records.

entity_type

string

The entity type identifier of the comparison pair records.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

201 - Pair decision created successfully.

id

string

The id of the comparison record pair.

category

string

The identified category of the comparison record pair.

record_number_1

string

The record number of the first record of the comparison record pair.

record_number_2

A list of errors.

Delete comparison record pair decision

DELETE /mdm/v1/pair_decisions

Delete the comparison record pair decision.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

record_number_2

string

Record identifier of comparison pair

pair_gen_job_id

string

Pair gen Id of record pari

Response

A list of errors.

List comparison record pair decision

GET /mdm/v1/pair_decisions/pair_decision_v2

Lists the filtered comparison record pair decision.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

offset

string

Pair comparison offset

limit

string

no of comparison pairs to be fetched

Response

The HTTP status code of the response.

errors

array

A list of errors.

Add comparison record pair decision

POST /mdm/v1/pair_decisions/pair_decision_v2

Adds a new comparison record pair decision in configuration space. This allows to store user decision taken on comparison of record pairs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

The data type identifier of the comparison pair records.

record_type

string

The data type identifier of the comparison pair records.

The identified category of the comparison record pair.

record_number_1

string

The record number of the first record of the comparison record pair.

record_number_2

A list of errors.

Get comparison record pair decision statistics

GET /mdm/v1/pair_decisions/statistics

Gets the comparison record pair decision statistics.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

Record type of comparison pair

entity_type

Required *

string

Entity type of comparison pair

pair_gen_job_ids

string

Pair generation ids for which we need statistics

Response

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve sample pairs of records

GET /mdm/v1/pairs

This service retrieves the sample pairs from the generated pairs of records for analysis.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

entity_type

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

size

integer

The number of pairs to be retrieved from the generated pairs

offset

integer

The number of pairs to skip before returning the result

batch_id

integer

A pair selection to return pairs from

Response

The HTTP status code of the response.

errors

array

A list of errors.

Search records by matching algorithm

POST /mdm/v1/probabilistic_search

This service searches for the supplied payload and returns record_ids of potential matches.
The order of record_ids in the response is determined by matching algorithms.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Request Body

SingleRecordRequest

attributes

Required *

Path Parameters

Query Parameters

crn

Required *

Required *

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

limit

integer

The maximum expected number of entries in each page of results. The default limit is 20.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Proxy InfoSphere MDM request

POST /mdm/v1/proxy

Proxies InfoSphere MDM XML requests to IBM MDM APIs and returns responses in the same XML format. This enables downstream applications to continue using existing InfoSphere MDM integrations during migration.

Request

Request Body

InfoSphere MDM XML request payload.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_source

Required *

string

Source system identifier.

Response

200 - Request successfully processed.

400 - Invalid XML format or missing required fields.

401 - User is not authenticated.

403 - User is not authorized to perform this request.

500 - Internal server error while processing the request.

Boarding tenant

POST /mdm/v1/proxy/boarding_tenant

Boarding tenant with basic metadata configuration

Request

Request Body

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Tenant successfully boarded

500 - Internal error occurred while boarding tenant

Retrieve metadata resources

GET /mdm/v1/proxy/metadata

Retrieves tenant metadata resources. If no resource names are specified, returns all metadata as a ZIP archive. If specific resource names are provided, returns only those resources. This endpoint supports asynchronous processing for efficient handling of large metadata files.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

resourceName

array

Optional list of specific resource names to retrieve. If not provided, all metadata resources will be returned as a ZIP archive. Multiple resource names can be specified by repeating the parameter.

Response

200 - Metadata retrieved successfully. Returns binary content (ZIP archive or individual resource).

400 - Invalid request parameters.

401 - User is not authenticated.

403 - User is not authorized to access metadata resources.

404 - One or more requested resources not found.

500 - Internal server error while retrieving metadata.

Post tenant metadata

POST /mdm/v1/proxy/metadata

Creates all tenant files and updates mapping using transactions. Combines boarding and metadata update operations.

Request

Request Body

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Metadata posted successfully

400 - Bad request. Invalid input parameters.

401 - User is not authenticated.

403 - User is not authorized to perform this request.

500 - Internal error occurred while posting tenant metadata

Get Deleted Elements Cleanup Status based on Job Id

GET /mdm/v1/purge_deleted_info/{job_id}

Get Deleted Elements Cleanup Status based on Job Id

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

job_type

string

The type of job.

status

A list of errors.

Cancel Deleted Elements Cleanup based on Task Id

POST /mdm/v1/purge_deleted_info/{job_id}/cancel

Cancel Deleted Elements Cleanup based on Task Id

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Path Parameters

job_id

Required *

string

Valid object defining the bulk delete job information.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

204 - Successfully fetched the status of bulk delete for deleted elements.

400 - Input validation failed.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - Problem performing bulk delete for deleted elements. An internal error occurred while attempting to perform the operation.

Start an operation to bulk delete deleted data from the es

POST /mdm/v1/purge_deleted_info/start

Delete elements from deleted entites/records index based on time frame. For Deleted Records cleanup: * Search criteria must include only delete by record_last_updated For Deleted Entities cleanup: * Search criteria must include only search by entity_last_updated

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Request Body

BulkDeleteDeletedElementsRequest

Valid object defining the bulk delete job information.

delete_target

string

The data type to target for deletion.

search_criteria

DataSearchCriteria

A set of criteria for a search operation.

search_type

string

The type of data to search against.

query

object

A search query to run.

filters

array

The search filters to apply to the search to narrow down results.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

batch_size

integer

batch size of the query parameter

Response

202 - The bulk delete for deleted elements job was successfully started.

job_id

string

The id for the job.

job_type

string

The type of job.

status

A list of errors.

Get all data quality issues for a given issue type

POST /mdm/v1/quality_issues

This function retrieves all the quality issues that are persisted for the given issue_type in a paginated manner

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

QualityIssueSearchRequest

Valid input defining the search criteria

type

Required *

string

The type of the quality issue to be searched for.

type_name

string

The defined name of the quality issue type as defined in the workflow configuration to be searched for.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

issue_type

Required *

string

issue_type to be searched for

offset

integer

The number of quality issues to skip over.

limit

integer

The number of quality issues to be returned. The maximum limit is 50.

include_total_count

boolean

Flag to include the total issue count on pages other than the first.

include_total_count_without_tasks

boolean

Flag to include the total issue count without tasks.

Response

200 - The quality issues have been successfully retrieved.

offset

integer

The number of elements to skip before returning a page of results.

limit

A list of errors.

Batch add or remove tags on potential overlay issues

POST /mdm/v1/quality_issues/potential_overlays/batch

This function adds or removes tags on potential overlay workflow nodes in batch.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

BatchPotentialOverlayTagRequest

Batch tag request specifying potential overlays and tag operations

potential_overlays

array

List of potential overlay items with tag operations.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

List the records

GET /mdm/v1/records

View a list of records that have been added to the graph for given record type. If record type is not provided, then list all records

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of records to skip over.

limit

integer

The number of records to be returned. The maximum limit is 50.

recordtype

string

Record type

Response

200 - The records have been successfully retrieved.

The HTTP status code of the response.

errors

array

A list of errors.

Create a new record

POST /mdm/v1/records

Add a new record to the graph. An incremental matching operation is automatically triggered after the record is created, to enable the record to join or form an entity.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataRecord

Valid object defining the record to be added to the graph.

integer

The number of entities linked from the record.

is_blocked_for_update

boolean

Is the Record Blocked for Update.

is_quarantined

boolean

Is the Record quarantined.

entity_ids

array

The list of entities that the record belongs to

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get a record

GET /mdm/v1/records/{id}

View information about the specified record on the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

The ID of the record.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

include

array

Record attributes from the data model to include in the results.

exclude

array

Record attributes from the data model to exclude from the results.

as_of

string

Point in time to retrieve the record history. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-10', '2025-09-10T13:59:59', '2025-09-10T13:59:59Z').

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Replace attributes for a record

PUT /mdm/v1/records/{id}

Replace the existing record with the new set of attributes. Any existing editable record attributes not specified in the request will be removed from the record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataRecord

Valid object defining the record information to replace the existing record.

integer

The number of entities linked from the record.

is_blocked_for_update

boolean

Is the Record Blocked for Update.

is_quarantined

boolean

Is the Record quarantined.

entity_ids

array

The list of entities that the record belongs to

Path Parameters

id

Required *

integer

The ID of the record.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Delete a record

DELETE /mdm/v1/records/{id}

Delete an existing record from the graph. Deleting a record automatically triggers a removal of the record from any formed entities.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

integer

The ID of the record.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

delete_history_data

boolean

When set to true, deletes all historical data for the record being deleted, including relationship and linkage history.

Response

A list of errors.

Patches attributes for a record

PATCH /mdm/v1/records/{id}

Patches the existing record with the new set of attributes. Any existing editable record attributes not specified in the request will be retained in the record. Any attributes that are explicitly set as null will be removed.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataRecord

Valid object defining the record information to patch the existing record.

integer

The number of entities linked from the record.

is_blocked_for_update

boolean

Is the Record Blocked for Update.

is_quarantined

boolean

Is the Record quarantined.

entity_ids

array

The list of entities that the record belongs to

Path Parameters

id

Required *

integer

The ID of the record.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

List the Potenital Overlay records for a record

GET /mdm/v1/records/{id}/accumulated_updates

Retrieve a set of potental overlay records which are accumulated to the specified record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

The number of records to skip before returning a page of results.

sort_descend

boolean

Order of sorting of result.

hide_unmodified_attrs

boolean

Hide unmodified Attributes.

full_update

boolean

Show overlays only with updates.

include_tags

boolean

Include tags associated with the potential overlay.

Response

200 - The potential overlay records for the record have been successfully retrieved.

array

A list of errors.

List the entities for a record

GET /mdm/v1/records/{id}/entities

View a list of entities which the record contributes to.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

The number of records to skip before returning a page of results.

include

array

Record attributes from the data model to include in the results.

exclude

array

Record attributes from the data model to exclude from the results.

as_of

string

Point in time to retrieve the record history. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-10', '2025-09-10T13:59:59', '2025-09-10T13:59:59Z').

Response

200 - The list of entities have been successfully retrieved.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

List the record history

GET /mdm/v1/records/{id}/history

Retrieves the history of changes made to a record within the specified time range. The response provides a chronological view of additions, updates or deletions that occurred during the requested period.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

The end of the time range (inclusive) for retrieving record history changes. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-15', '2025-09-15T10:11:05', '2025-09-15T10:11:05Z'). If provided, history changes till the given time will be fetched. If not provided, history changes till the latest available will be fetched

offset

integer

The number of record history changes to skip over.

limit

integer

The number of record history changes to be returned. The maximum limit is 50.

action_types

string

history_types

string

Response

200 - The records history have been successfully retrieved.

The HTTP status code of the response.

errors

array

A list of errors.

GET /mdm/v1/records/{id}/related_records

Retrieve a set of records which are directly connected to the specified record by a relationship. All records related to the specified record will be returned regardless of relationship direction.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

The type of relationship between related records and the specified record.

limit

integer

The maximum number of records to return in each page of results. The maximum limit is 50.

offset

integer

The number of records to skip before returning a page of results.

include_total_count

boolean

Flag to include the total record count on pages other than the first.

Response

A link to the next page of results.

related_records

A list of errors.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

List the relationships for a record

GET /mdm/v1/records/{id}/relationships

View a list of relationships that exist between the given record and other records in the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

The ID of the record.

Query Parameters

crn

Required *

string

Point in time to retrieve the relationship history. Accepts ISO‑8601 date/time in UTC or local formats (e.g., '2025-09-10', '2025-09-10T13:59:59', '2025-09-10T13:59:59Z').

Response

200 - The relationships have been successfully retrieved.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get a relationship for a record

GET /mdm/v1/records/{id}/relationships/{relationship_id}

Retrieve a single relationship from the set of relationships for the record.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

The ID of the record.

relationship_id

Required *

string

The ID of the linked relationship to return.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

source_include

array

Attributes from the data model to include in the results for the source vertex.

target_include

array

Attributes from the data model to include in the results for the target vertex.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Force Unquarantine a quarantined record

POST /mdm/v1/records/{id}/unquarantine

This api removes the potenital overlay node and workflow node created for a given record. It also deletes a workflow if created.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

integer

The ID of the record.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Retrieve a record's manual links/unlinks

GET /mdm/v1/records/{record_number}/linkage_rules

This service retrieves all manual link/unlink rules for given record and entity type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

record_number

Required *

integer

The unique identifier of a source record as assigned by the system

Query Parameters

crn

Required *

string

The cloud resource name of the service.

entity_type

string

The data type identifier of entity, ie. person_entity, organization_entity, household_entity

Response

200 - The request has been successfully finished.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get a record given record_type, record_source and source_record_id

GET /mdm/v1/records/bysource_system_id

View information about record on the graph based on source system id.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

source of record

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get a record given record_type, record_source and record_id

GET /mdm/v1/records/bysourceid

View information about the specified record on the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

The type of the record.

record_source

Required *

string

source of record

record_id

Required *

string

Id of record

collection_id

string

Collection Id of record

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Refresh the graph indexes

POST /mdm/v1/refresh

Trigger a refresh of the existing indexes so they are synchronized with the latest available data model and metadata.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Reindex the graph data

POST /mdm/v1/reindex

Ensure that the indexing backend is up to date with the graph data storage backend. If the indexing backend does not have an index defined for the instance, an index will be created based on the current data model.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Path Parameters

Query Parameters

crn

Required *

202 - The reindex job was submitted successfully.

job_id

string

The id for the job.

job_type

string

The type of job.

status

A list of errors.

Retrieve the relationship linker rules

GET /mdm/v1/relationship_linker_rules/{relationship_type}

This service retrieves the relationship linker rules for a given relationship.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

relationship_type

Required *

string

The data type identifier of source relationships, ie. employment, preference_link

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Rel linker rules for the given relationship is successfully created

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

create or update relationship linker rule

PUT /mdm/v1/relationship_linker_rules/{relationship_type}

Create or update relationship linker rule for a relationship type which will be usedby the relationship linker bulk job for automatically creating the relationships between record to record, record to entity and entity to entity

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

RelLinkerRule

from_type

Required *

string

Type of left side of relationship

is_active

boolean

Is the rule active

description

string

Rule description

string

Unique identifier for the rule

last_updated_date

boolean

System generated timestamp when the rule was last updated

Path Parameters

relationship_type

Required *

A list of errors.

Patch a rel linker rule

PATCH /mdm/v1/relationship_linker_rules/{relationship_type}

Patch a rel linker rule's active status *

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

JSONObject

empty

boolean

Path Parameters

relationship_type

Required *

A list of errors.

Create a new relationship

POST /mdm/v1/relationships

Add a new relationship to the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataRelationship

Valid object defining the relationship to be added to the graph.

id

string

The id of the element.

string

Rule Id for Relationship.

is_auto_created

boolean

Is the relationship Auto Created

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get a relationship

GET /mdm/v1/relationships/{id}

View information about the specified relationship on the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

id

Required *

string

The ID of the relationship.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

source_include

array

Attributes from the data model to include in the results for the source vertex.

target_include

array

Attributes from the data model to include in the results for the target vertex.

relationship_type

string

Relationship type from the data model to include in the results

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Replace attributes for a relationship

PUT /mdm/v1/relationships/{id}

Replace the existing relationship attributes on the graph with the new set of attributes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

DataRelationship

Valid object defining the relationship information to replace the existing relationship.

id

string

The id of the element.

type

string

The ID of the relationship.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Delete a relationship

DELETE /mdm/v1/relationships/{id}

Delete an existing relationship from the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

string

The ID of the relationship.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Resets the system to its default

POST /mdm/v1/reset_configuration

Resets configuration to original state.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

201 - The reset was successfully performed and the metadata store is cleared.

401 - Problem processing request. The user is not authenticated.

403 - Problem processing request. The user is not authorized to perform the request.

500 - Problem resetting metadata. An internal error occurred while attempting to reset.

Reset the graph

POST /mdm/v1/reset_data

Clear all data in the graph, including schema, vertexes, edges, and indexes. Upon clearing the graph, a new graph schema is generated based on the initial data model.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

batch_size

integer

Limit for reset data.

Response

A list of errors.

Remove all derived data

POST /mdm/v1/reset_matching

This service removes all derived data for the specified record types.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

string

The data type identifier of source records, ie. person, organization, contract. If not supplied, all record types will be considered

batch_size

integer

The batch size delete operations. Default is 10000

Response

The HTTP status code of the response.

errors

array

A list of errors.

Resets the system to its default

GET /mdm/v1/reset_model

Requires the application role of 'ModelManager'.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Retrieve the link resiliency rules.

GET /mdm/v1/resiliency_rules

Retrieve the link resiliency rules configuration for persisted entity composite view

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The resiliency rules has been successfully retrieved.

link_resiliency_rules

ResiliencyRulesLinkResiliencyRules

Collection of records and entities with resiliency rules configuration

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Update the link resiliency rules.

PUT /mdm/v1/resiliency_rules

This service updates the link resiliency rules for persisted entity composite view

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

ResiliencyRules

link_resiliency_rules

ResiliencyRulesLinkResiliencyRules

Collection of records and entities with resiliency rules configuration

records

Required *

object

entities

object

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The connected data asset details has been successfully updated.

link_resiliency_rules

ResiliencyRulesLinkResiliencyRules

Collection of records and entities with resiliency rules configuration

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get the graph schema

GET /mdm/v1/schema

View summary information about the defined graph schema to verify the state of the schema.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Update the graph schema

POST /mdm/v1/schema_update

Update the existing graph schema to support the latest draft version of the data model. A draft version of the data model is required to exist in the Model APIs when running a schema update operation.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Search the data on the graph

POST /mdm/v1/search

Run a full text search, or search on attribute fields. Searching on fields is achievable by using dot-notation for the property keys (e.g. legal_name.given_name). Omit the property key for a full text search. Pagination is supported.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

DataSearchCriteria

Valid input defining the search criteria.

search_type

string

The type of data to search against.

query

SearchQuery

A search query to run.

expressions

Required *

array

The list of expressions.

operation

string

The operation to apply to the expressions.

filters

array

The search filters to apply to the search to narrow down results.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

return_type

string

The type of results to return from the search.

limit

integer

The maximum number of elements to return in each page of results.

offset

integer

The number of elements to skip before returning a page of results.

include

array

Record attributes from the data model to include in the results.

exclude

array

Record attributes from the data model to exclude from the results.

include_total_count

boolean

The field is used to include total count of search data.

Response

200 - The search was performed successfully.

A link to the next page of results.

results

A list of errors.

Select sample pairs of records

POST /mdm/v1/select_pairs

This service selects the sample pairs from the generated pairs of records for analysis.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

The data type identifier of source records, ie. person, organization, contract

entity_type

Required *

array

A list of errors.

Retrieve a summary of all anonymous words

GET /mdm/v1/set_resources

This service retrieves a summary of resource names for all anonymous words.
A Set Resource is a json document that generally contains grouped list of values of interest.
A Set Resource may be used in one or more matching algorithms to filter out the anonymous words in the input fields from further processing.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The resources have been successfully retrieved.

set_resource_names

array

Collection of set resource names

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve details of anonymous words

GET /mdm/v1/set_resources/{resource_name}

This service retrieves the details of all anonymous words for a given resource name.
A Set Resource is a json document that generally contains grouped list of values of interest.
A Set Resource may be used in one or more matching algorithms to filter out the anonymous words in the input fields from further processing.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

resource_name

Required *

string

he unique identifier for the configuration for the anonymous set of words

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The resources have been successfully retrieved.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

Overwrite anonymous words

PUT /mdm/v1/set_resources/{resource_name}

This service completely overwrites the anonymous words for a given resource name.
A Set Resource is a json document that generally contains grouped list of values of interest.
A Set Resource may be used in one or more matching algorithms to filter out the anonymous words in the input fields from further processing.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

Current state of flow according to its state machine

flow_id

string

System generated flow identifier

array

A list of errors.

Trigger graceful shutdown

POST /mdm/v1/shutdown

Initiates graceful shutdown of async resources. Should be called from Kubernetes preStop hook.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Shutdown initiated successfully.

status

string

array

A list of errors.

Get snapshots

GET /mdm/v1/snapshots

Get snapshots

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Create a snapshot of config assets

POST /mdm/v1/snapshots

This service creates a snapshot of current config assets.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

201 - The snapshot of model assets has been successfully created.

description

string

Additional detail about snapshot

id

A list of errors.

Get snapshot by Id

GET /mdm/v1/snapshots/{id}

Get snapshot by Id

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

id

Required *

string

Id of the snapshot

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Snapshot with given id is fetched successfully.

algorithms

object

Collection of matching algorithms for different record types e.g. person, organization

compare_spec_resources

Update a snapshot of model assets

PUT /mdm/v1/snapshots/{id}

This service updates the name and description of a snapshot.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.manage

Request

Request Body

UpdateSnapshotSummary

description

string

Additional detail about snapshot

A list of errors.

delete snapshot by Id

DELETE /mdm/v1/snapshots/{id}

delete snapshot by Id

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

id

Required *

string

Id of the snapshot

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Snapshot with given id is deleted successfully.

algorithms

object

Collection of matching algorithms for different record types e.g. person, organization

compare_spec_resources

Compare snapshot with current configuration

PUT /mdm/v1/snapshots/compare

Compare snapshot

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

SnapshotCompareRequest

data_model

object

Data model of snapshot for comparison with current system's data model

match_settings

object

Match Settings of snapshot for comparison with current system's match settings

composite_rules

object

Composite Rules of snapshot for comparison with current system's Composite Rules

algorithms

object

Algorithms from the snapshot for checking the compatibility with Model

mapping_patterns

array

Mapping Patterns

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - Snapshot comparison is generated and fetched successfully.

data_model

object

match_settings

A list of errors.

Get graph statistics

GET /mdm/v1/statistics

View statistics derived from the data on the graph, including total count, counts by source, and counts by type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

include_source_statistics

string

Include source statistics

approximate_statistics

string

Show approximate entity statistics

include_entity_count

string

Include entity count on PE disabled

sources_list_only

string

Return only the list of sources without computing other statistics

Response

200 - The graph statistics have been successfully retrieved.

total_count

A list of errors.

Get history statistics

GET /mdm/v1/statistics/history

View statistics derived from the history indices

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

Query Parameters

crn

Required *

string

array

A list of errors.

Get Relationship Linker statistics

GET /mdm/v1/statistics/relationship_linker/{relationship_type}

View statistics of relationships created by the Relationship Linker process

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

relationship_type

Required *

string

Relationship type from the data model to include in the results

Query Parameters

crn

Required *

string

array

A list of errors.

Get the storage metadata

GET /mdm/v1/storage_metadata

View information about the storage component where data can be uploaded before being loaded to the graph. This operation is used by Publisher.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.manage

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get the surrounding vertices and edges for a set of vertices

POST /mdm/v1/subgraph

Fetch a subgraph view of a subset of data on the graph as specified in the request.

The operation runs with the following features:

Includes initial vertices in the result.
Returns a summary of graph elements. Does not include detailed information such as model attribute keys and values.
Ignores a vertex identifier if the vertex cannot be found. Returns an empty subgraph if no vertices are found.
Returns an edge in the resulting subgraph if its source vertex, target vertex and the edge itself can be reached within the specified number of hops from at least one initial vertex.
Includes edges between record and entity vertices.
No more than 3 hops and 50 input vertices are permitted. The number of edges per vertex is capped at 50. Note that the number of edges per vertex may be less than this limit due to shared edges.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Request Body

SubgraphParameters

Valid object defining scope parameters for the subgraph.

vertex_ids

Required *

array

The list of identifiers of initial vertices from which to build the subgraph.

distance

integer

The maximum number of hops from initial vertices.

include

object

The attributes to be included in the response.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Suggest asset mappings

POST /mdm/v1/suggest_asset_mappings

Suggest asset mappings from MDM configuration meta data and existing asset mappings matching the columns of the requested asset.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

AssetIdForMappingSuggestionRequest

asset_ids

array

The collection of asset_id for fetching their corresponding mapping pattern suggestions.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Suggest assets during import

POST /mdm/v1/suggest_assets

Suggest existing assets in the system that can be mapped with existing asset mappings in the snapshot during import

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

SuggestAssetsForImportRequest

mapping_patterns

array

The list of mapping patterns.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Suggest data mappings

POST /mdm/v1/suggest_data_mappings

Suggest data mappings from MDM data model based on the generic classes of Watson Knowledge Catalog with which the asset is profiled.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Request Body

SuggestedDataMappingRequest

columns

array

The collection of data mapping columns having key and WKC identified class.

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

Record type for data mapping suggestions

Response

The HTTP status code of the response.

errors

array

A list of errors.

Get suggested matching attributes

GET /mdm/v1/suggested_matching_attributes

Gets suggested matching attributes for the record type based on mappings of assets of the specified record type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.configurator.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

record_type

Required *

string

Record type for matching attribute suggestions

Response

The HTTP status code of the response.

errors

array

A list of errors.

Retrieve a summary of all derived data

GET /mdm/v1/summary

This service retrieves a summary of all derived data in system (e.g. entity distribution).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

The number of source systems in the derived matching data

total_records_with_record_filter

integer

Total number of records with record_filter.<entity_type> as true

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get all tags

GET /mdm/v1/tags

This service gets all tags.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

name

string

A name string to be searched.

offset

integer

The number of tags to skip over.

limit

integer

The number of tags to be returned. The maximum limit is 1000.

Response

200 - The tags have been successfully retrieved.

The HTTP status code of the response.

errors

array

A list of errors.

Create tags

POST /mdm/v1/tags

This service creates tags.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Request Body

Tag

color

string

Tag color

created_user

string

User who created the tag

last_updated_user

string

User who last updated the tag

name

Required *

string

Human-readable name

description

string

Optional description

id

string

Unique identifier for the tag

created_date

integer

Timestamp when the tag was created

last_updated_date

integer

Timestamp when the tag was last updated

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Get tag

GET /mdm/v1/tags/{id}

This service gets a tag.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.read

Request

created_user

string

User who created the tag

last_updated_user

string

User who last updated the tag

name

string

Human-readable name

description

A list of errors.

Delete tag

DELETE /mdm/v1/tags/{id}

This service deletes a tag.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Path Parameters

id

Required *

string

id of the tag

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Update tags

PATCH /mdm/v1/tags/{id}

This service updates tags.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

User who created the tag

last_updated_user

string

User who last updated the tag

name

A list of errors.

Create tag constraints and indexes

POST /mdm/v1/tags/feature/index

This service creates tag indexes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Check indexes exist

GET /mdm/v1/tags/feature/indexes/exist

This service checks tag indexes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A list of errors.

Retrieve token frequencies

GET /mdm/v1/token_frequencies

This service retrieves the token frequency data for a given record type and entity type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.read

Request

Path Parameters

The data type identifier of entity, ie. person_entity, organization_entity

Response

200 - The request has been successfully finished.

401 - The request cannot be processed due to authentication error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

403 - The request cannot be processed due to insufficient permission error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

404 - The request cannot be processed due to resource not found.

500 - The request cannot be processed due to an unexpected system error.

trace

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get export jobs for all users

GET /mdm/v1/ui_exports

Get export job details from EM-UI for all users

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of records to skip over.

limit

integer

The number of records to be returned. The maximum limit is 50.

Response

200 - The export jobs details for all users has been successfully retrieved.

offset

integer

The number of elements to skip before returning a page of results.

limit

A list of errors.

Get export jobs

GET /mdm/v1/ui_exports/{id}

Get export job details from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

string

The ID of the export doc.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Add export job to set of jobs

PUT /mdm/v1/ui_exports/{id}

Add export job to set of jobs from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

UIExports

Valid object defining the exportJob to be added.

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Delete export job from a set of jobs

DELETE /mdm/v1/ui_exports/{id}

Delete export job from a set of jobs from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get global and user settings for all users

GET /mdm/v1/ui_settings

Get global and user settings of all users from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

offset

integer

The number of records to skip over.

limit

integer

The number of records to be returned. The maximum limit is 50.

Response

200 - The global and user setings for all users has been successfully retrieved.

offset

integer

The number of elements to skip before returning a page of results.

limit

A list of errors.

Get global/user settings

GET /mdm/v1/ui_settings/{id}

Get global/user settings from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

string

The ID of the settings doc.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Update global/user settings

PUT /mdm/v1/ui_settings/{id}

Update global/user settings from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

UISettings

history

array

analysis

object

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Reset global/user settings

DELETE /mdm/v1/ui_settings/{id}

Reset global/user settings from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

id

Required *

string

The ID of the settings doc.

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Update global/user settings

PATCH /mdm/v1/ui_settings/{id}

Update global/user settings from EM-UI

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

UISettings

history

array

analysis

object

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Initiate weight tuning job

POST /mdm/v1/weight_tuning_job

This service initiates asynchronous processing of the weight tuning job.
Weight tuning is the process to improve the weight for the matching algorithm based on given set of match decisions from data stewards.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.matching.manage

Request

Request Body

Weight tuning job request body containing pair analysis IDs

Path Parameters

Entity type of match statistics

Response

201 - The weight tuning job has been successfully created.

created_at

string

System generated timestamp when a job was created

job_name

A list of errors.

List the workflows

GET /mdm/v1/workflows

View a list of workflow nodes that have been added to the graph for given workflow type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

offset

integer

The number of workflows to skip over.

limit

integer

The number of workflow nodes to be returned. The maximum limit is 50.

Response

200 - The workflow nodes have been successfully retrieved.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get a workflow

GET /mdm/v1/workflows/{workflow_id}

View information about a specific workflow node on the graph.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

workflow_id

Required *

The HTTP status code of the response.

errors

array

A list of errors.

Delete a workflow

DELETE /mdm/v1/workflows/{workflow_id}

Delete an existing workflow

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Path Parameters

workflow_id

Required *

A list of errors.

patch a workflow

PATCH /mdm/v1/workflows/{workflow_id}

Patch the workflow associated to the given id and worklfow_type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

PatchWorkflowRequest

Valid object defining the information to patch a workflow of the given type.

Required *

string

The type of the workflow.

Response

A list of errors.

Resolve a workflow

POST /mdm/v1/workflows/{workflow_id}/resolve

Resolve the workflow associated to the given id and workflow_type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.write

Request

Request Body

ResolveWorkflowRequest

Valid object defining the information to resolve a workflow of the given type.

actions

Required *

array

List of actions to be performed to resolve workflow.

comments

The type of the workflow.

preview_only

boolean

Flag to preview the resolved workflow changes or to apply them. Defualt is false

Response

A list of errors.

Get workflow statistics

GET /mdm/v1/workflows/statistics

View information about workflow statistics for given workflow type and record type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.data.read

Request

Path Parameters

The record type to search for.

Response

The HTTP status code of the response.

errors

array

A list of errors.

Get generic workflows per workflow type

GET /mdm/v1/workflows_configuration/{workflow_type}

This service completely retrieves the workflow configuration for a given workflow type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

workflow_type

Required *

string

The workflow confiuration type

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The workflow has been successfully retrieved.

auto_create_tasks

boolean

A boolean value that specifies whether tasks should be automatically created for this workflow.

description

string

A description of the workflow configuration.

applicable_data_types

object

An object that specifies the data types that the workflow is applicable to.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Put generic workflows per workflow type

PUT /mdm/v1/workflows_configuration/{workflow_type}

This service completely overwrites the workflow configuration for a given workflow type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

WorkflowConfiguration

auto_create_tasks

Required *

boolean

A boolean value that specifies whether tasks should be automatically created for this workflow.

description

string

A description of the workflow configuration.

applicable_data_types

Required *

object

An object that specifies the data types that the workflow is applicable to.

custom_tags

WorkflowConfigurationCustomTags

auto_tagging_rules

array

max_accumulated_updates

integer

An integer value that specifies the maximum number of updates that can be accumulated for this workflow.

trigger_operator

WorkflowConfigurationTriggerOperator

An object to specify the trigger operator for each record_type and entity_type.

hierarchy_types

object

entity_types

object

Entity types keyed by lower snake case names (e.g. person_entity, organization_entity).

record_types

object

Record types keyed by lower snake case names (e.g. person, organization).

Path Parameters

workflow_type

Required *

string

The workflow confiuration type

Query Parameters

crn

Required *

string

The cloud resource name of the service.

Response

200 - The workflow has been successfully modified.

auto_create_tasks

boolean

A boolean value that specifies whether tasks should be automatically created for this workflow.

description

string

A description of the workflow configuration.

applicable_data_types

object

An object that specifies the data types that the workflow is applicable to.

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get generic workflows settings per workflow type and data type

GET /mdm/v1/workflows_configuration/settings/{workflow_type}

This API returns the workflow configuration settings for a given workflow type and data type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Path Parameters

workflow_type

Required *

Workflow configurations defined as settings.

excluded_sources

array

List of excluded sources

included_sources

array

List of included sources

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Put generic workflows settings per workflow type and data type

PUT /mdm/v1/workflows_configuration/settings/{workflow_type}

This API completely overwrites the workflow configuration settings for a given workflow type and data type.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

mdm-oc.model.manage

Request

Request Body

WorkflowsConfigurationSettings

name

string

Name for the potential overlay workflow settings.

workflow_configurations

array

Workflow configurations defined as settings.

excluded_sources

array

List of excluded sources

included_sources

array

List of included sources

custom_tags

WorkflowsConfigurationSettingsCustomTags

auto_tagging_rules

array

triggers

array

Triggers for the potential overlay.

status

string

Workflow configuration status, whether active OR inactive

Path Parameters

workflow_type

Required *

200 - The workflow has been successfully modified.

name

string

Name for the potential overlay workflow settings.

workflow_configurations

array

Workflow configurations defined as settings.

excluded_sources

array

List of excluded sources

included_sources

array

List of included sources

string

A lowercase UUID uniquely identifying the request.

status_code

integer

The HTTP status code of the response.

errors

array

A list of errors.

Get next pending migration

GET /mdm/v1/migration/next_migration

Get next pending migration waiting to be picked up.

Request

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

object

Update migration status

POST /mdm/v1/migration/update_migration

Update the status of pending migration.

Request

Request Body

Publisher bulk_import response

Path Parameters

Query Parameters

crn

Required *

string

The cloud resource name of the service.

migration_id

Required *

string

Migration Identifier.

object