Introduction

IBM Match 360 with Watson (Beta) provides APIs that enable you to connect the IBM Match 360 with Watson service's powerful master data matching capabilities to your systems and processes. IBM Match 360 with Watson (IBM Match 360) is an IBM Cloud service delivered through IBM Cloud Pak for Data as a Service that enables you to establish a single, trusted, 360-degree view of your customers -- a digital twin. IBM Match 360 includes cloud-native, machine learning-assisted, self-service analytics and matching tools that deliver better business insights.

Business users and systems can access IBM Match 360 data to search, view, and analyze master data entities. With IBM Match 360 on Cloud Pak for Data as a Service, you can ensure that your users and systems have a total view of your data. With a seamlessly integrated, cross-solution cloud experience, your users can discover master data directly in the space where they expect to consume it.

The IBM Match 360 with Watson APIs support:

  • Loading and mapping data
  • Customizing the data model
  • Configuring the matching algorithm
  • Running matching
  • Retrieving master data entity and record details
  • MDM job management

For more information about using the IBM Match 360 with Watson service, see the Cloud Pak for Data as a Service documentation.

Tip: To access the API documentation by using the Swagger UI tool, open a web browser and go to: https://api.{endpoint-location}.mdm.watson.cloud.ibm.com/api-{api-name}/explorer/. Replace {endpoint-location} in the URL with the location code of your deployment's multizone region, and replace {api-name} with the name of the IBM Match 360 API service you are accessing. For example, to access the Model API in the Dallas global endpoint (us-south), go to https://api.us-south.mdm.watson.cloud.ibm.com/api-model/explorer/.

The code examples on this tab use the client library that is provided for Node.js.

Installation

npm install --save master-data—management-cloud

The code examples on this tab use the client library that is provided for Java.

Maven

<dependency>
  <groupId>com.ibm.cloud</groupId>
  <artifactId>mdm</artifactId>
  <version>0.0.8</version>
</dependency>

Gradle

implementation 'com.ibm.cloud:mdm:0.0.8'

The code examples on this tab use the client library that is provided for Python.

Installation

pip install master-data-management

Endpoint URLs

The IBM Match 360 with Watson API uses the Dallas global endpoint URL for all regions. When you call the API, add the path for each method to form the complete API endpoint for your requests.

https://api.dataplatform.cloud.ibm.com

Example request to the Dallas endpoint

curl -u "apikey:{apikey}" -X {request_method} "https://api.dataplatform.cloud.ibm.com/{method_endpoint}"

Replace {apikey}, {request_method}, and {method_endpoint} in this example with the values for your particular API call.

Example request to the Dallas endpoint

const MasterDataManagementV1 = require('ibm/master-data-management/v4');
const { IamAuthenticator } = require('ibm/auth');

const masterDataManagement = new MasterDataManagementV1({
  version: '{version}',
  authenticator: new IamAuthenticator({
    apikey: '{apikey}',
  }),
  url: 'https://api.dataplatform.cloud.ibm.com/{method_endpoint}',
});

Replace {apikey}, {version}, and {method_endpoint} in this example with the values for your particular API call.

Example request to the Dallas endpoint

import com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator;
import com.ibm.cloud.mdm.v1.Mdm;
Authenticator authenticator = new BearerTokenAuthenticator("<access-token>");
Mdm mdm = new Mdm(crn, Mdm.DEFAULT_SERVICE_NAME, authenticator);

Replace <access-token> in this example with the values for your particular API call.

Later, when the access token expires, the application must acquire a new access token, then set it on the authenticator. Subsequent request invocations will include the new access token.

authenticator.setBearerToken("<new-access-token>")

Alternatively, use external configuration and provide values for the below properties

MDM_URL=https://api.dataplatform.cloud.ibm.com/
MDM_AUTH_TYPE=bearertoken
MDM_BEARER_TOKEN=<access-token>

and access the service using

Mdm service = Mdm.newInstance(crn);

Example request to the Dallas endpoint

from ibm import MasterDataManagementV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('{apikey}')
master_data_management = MasterDataManagementV1(
    version='{version}',
    authenticator=authenticator
)

master_data_management.set_service_url('https://api.dataplatform.cloud.ibm.com/{method_endpoint}')

Replace {apikey}, {version}, and {method_endpoint} in this example with the values for your particular API call.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP error code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized to access '{namespace}'.
404 Not Found The requested resource could not be found.
408 Request Timeout The connection to the server timed out. Wait a few minutes, then try again.
409 Conflict The entity is already in the requested state.
500 Internal Server Error offering_name is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

ErrorContainer

Field name Type Description
status_code integer The HTTP status code of the response.
errors List<ErrorMessage> A list of errors.
trace string The lower case UUID that uniquely identies the request.

ErrorMessage

Field name Type Description
code string A snake_case string succinctly identifying the problem.
message string An explanation of the solution to the problem.
more_info string A publicly-accessible URL where information about the error can be read in a web browser.
target ErrorTarget An error target model.

ErrorTarget

Field name Type Description
type string The type of the error target. One of: field, parameter, or header.
name string The name of the field, parameter, or header.

When the Node SDK receives an error response from the IBM Match 360 with Watson service, it creates an Error object with information describing the error that occurred. This error object is passed as the first parameter to the callback function for the method. The contents of the error object are as shown in the following table:

Errors

Error field Description
code The HTTP status code returned.
message A message describing the error.

The Java SDK generates an exception for any unsuccessful method invocation. All methods that accept an argument can also throw an IllegalArgumentException.

Exception Description
IllegalArgumentException An invalid argument was passed to the method.

When the Java SDK receives an error response from the IBM Match 360 with Watson service, it generates an exception from the com.ibm.master_data_management.service.exception package. All service exceptions contain the following fields:

Error field Description
statusCode The HTTP status code returned
message A message describing the error

The Python SDK generates an exception for any unsuccessful method invocation. When the Python SDK receives an error response from the IBM Match 360 with Watson service, it generates a MasterDataManagementAPIException containing the following fields:

Error field Description
code The HTTP status code returned
message A message describing the error
info A dictionary of additional information about the error
masterDataManagement.method(params,
    function(err, response) {
        // The error will be the first argument of the callback
        if (err.code == 404) {
            // Handle Not Found (404) error
        } else if (err.code == 413) {
            // Handle Request Too Large (413) error
        } else {
            console.log('Unexpected error: ', err.code);
            console.log('error:', err);
        }
    });

Example error handling

try {
    // Invoke an IBM Match 360 method
} catch (NotFoundException e) {
    // Handle Not Found (404) exception
} catch (RequestTooLargeException e) {
    // Handle Request Too Large (413) exception
} catch (ServiceResponseException e) {
    // Base class for all exceptions caused by error responses from the service
    System.out.println("Service returned status code " + e.getStatusCode() + ": " + e.getMessage());
}

Example error handling

from master_data_management import MasterDataManagementAPIException
try:
    # Invoke an IBM Match 360 method
except MasterDataManagementAPIException as ex:
    print "Method failed with status code " + str(ex.code) + ": " + ex.message

Authentication

To authenticate to the IBM Match 360 with Watson API, you pass a bearer token in an Authorization header. The token is associated with a user name.

The bearer authentication token can be obtained using cURL: curl -X POST https://iam.cloud.ibm.com/identity/token -H "content-type: application/x-www-form-urlencoded" -H "accept: application/json" -d "grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=APIKEY"

The following cURL example shows authentication being passed using a bearer token: curl -X PUT --header "Authorization: Bearer {accessToken}" --header "Accept: application/json" "{url}/mdm/configuration/v1/config_data_model/publish_model?project_id=config_42d00915_1497_4d65_90af_cfd09d015769%3A31925406598685396&crn=CRN”

Replace {accessToken} with your authentication bearer token.

Generating a bearer token. The response includes an accessToken property.

Replace {cpd_cluster_host} and {port} with the details for the service instance. Replace {username} and {password} with your IBM Cloud Pak for Data credentials.

curl -k -u "{username}:{password}" "https://{cpd_cluster_host}{:port}/v1/preauth/validateAuth"

Authenticating to the API. Replace {accessToken} with your authentication bearer token.

curl -H "Authorization: Bearer {accessToken}" "{url}/v1/{method}"

Example header parameter in a request

masterDataManagement.methodName(
    {
        parameters,
        headers: {
            'Custom-Header': '{header_value}'
        }
    }, function(err, response) {
        if (err)
            console.log('error:', err);
        else
            console.log(response);
    }
);

Example header parameter in a request

ReturnType returnValue = masterDataManagement.methodName(parameters)
        .addHeader("Custom-Header", "{header_value}")
        .execute();

Example header parameter in a request

response = masterDataManagement.methodName(
    parameters,
    headers = {
        'Custom-Header': '{header_value}'
    })

Methods

Get config data model

Gets the data model present in configuration space.

Gets the data model present in configuration space.

Gets the data model present in configuration space.

Gets the data model present in configuration space.

Gets the data model present in configuration space.

GET /mdm/v1/config_data_model
(mdm *MdmV1) GetConfiguratorConfigDataModel(getConfiguratorConfigDataModelOptions *GetConfiguratorConfigDataModelOptions) (result *ConfigDataModel, response *core.DetailedResponse, err error)
(mdm *MdmV1) GetConfiguratorConfigDataModelWithContext(ctx context.Context, getConfiguratorConfigDataModelOptions *GetConfiguratorConfigDataModelOptions) (result *ConfigDataModel, response *core.DetailedResponse, err error)
ServiceCall<ConfigDataModel> getConfiguratorConfigDataModel(GetConfiguratorConfigDataModelOptions getConfiguratorConfigDataModelOptions)
getConfiguratorConfigDataModel(params)
get_configurator_config_data_model(self,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.read

Request

Instantiate the GetConfiguratorConfigDataModelOptions struct and set the fields to provide parameter values for the GetConfiguratorConfigDataModel method.

Use the GetConfiguratorConfigDataModelOptions.Builder to create a GetConfiguratorConfigDataModelOptions object that contains the parameter values for the getConfiguratorConfigDataModel method.

Query Parameters

  • The cloud resource name of the service.

WithContext method only

parameters

  • The cloud resource name of the service.

parameters

  • The cloud resource name of the service.

Response

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Status Code

  • Config data model is returned

  • Problem processing request. The user is not authenticated.

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

  • Problem getting config data model. An internal error occurred while attempting to get config data model.

Example responses
  • {
      "record_types": [
        {
          "name": "person",
          "default_display_name": "person",
          "properties": [
            {
              "name": "record_source",
              "data_type": "String",
              "default_display_name": "Record Source",
              "designation": "source"
            },
            {
              "name": "social_security_number",
              "data_type": "identification",
              "cardinality": "*",
              "default_display_name": "Social Security Number"
            }
          ],
          "source_systems": [
            {
              "name": "MDMSP",
              "default_display_name": "MDMS Person",
              "quality_factors": {
                "completeness": 100,
                "accuracy": 100,
                "correctness": 100,
                "age_relevancy": 100,
                "data_relevancy": 100,
                "consistency": 100
              }
            }
          ]
        }
      ],
      "data_types": [
        {
          "name": "identification",
          "default_display_name": "identification",
          "properties": [
            {
              "name": "identification",
              "data_type": "String",
              "default_display_name": "Identification Value"
            },
            {
              "name": "identification_number",
              "data_type": "String",
              "default_display_name": "Identification Number"
            }
          ]
        }
      ]
    }
  • {
      "record_types": [
        {
          "name": "person",
          "default_display_name": "person",
          "properties": [
            {
              "name": "record_source",
              "data_type": "String",
              "default_display_name": "Record Source",
              "designation": "source"
            },
            {
              "name": "social_security_number",
              "data_type": "identification",
              "cardinality": "*",
              "default_display_name": "Social Security Number"
            }
          ],
          "source_systems": [
            {
              "name": "MDMSP",
              "default_display_name": "MDMS Person",
              "quality_factors": {
                "completeness": 100,
                "accuracy": 100,
                "correctness": 100,
                "age_relevancy": 100,
                "data_relevancy": 100,
                "consistency": 100
              }
            }
          ]
        }
      ],
      "data_types": [
        {
          "name": "identification",
          "default_display_name": "identification",
          "properties": [
            {
              "name": "identification",
              "data_type": "String",
              "default_display_name": "Identification Value"
            },
            {
              "name": "identification_number",
              "data_type": "String",
              "default_display_name": "Identification Number"
            }
          ]
        }
      ]
    }

Replace Config Data Model

Replaces the config data model present in configuration space.

Replaces the config data model present in configuration space.

Replaces the config data model present in configuration space.

Replaces the config data model present in configuration space.

Replaces the config data model present in configuration space.

PUT /mdm/v1/config_data_model
(mdm *MdmV1) ReplaceConfiguratorConfigDataModel(replaceConfiguratorConfigDataModelOptions *ReplaceConfiguratorConfigDataModelOptions) (result *ConfigDataModel, response *core.DetailedResponse, err error)
(mdm *MdmV1) ReplaceConfiguratorConfigDataModelWithContext(ctx context.Context, replaceConfiguratorConfigDataModelOptions *ReplaceConfiguratorConfigDataModelOptions) (result *ConfigDataModel, response *core.DetailedResponse, err error)
ServiceCall<ConfigDataModel> replaceConfiguratorConfigDataModel(ReplaceConfiguratorConfigDataModelOptions replaceConfiguratorConfigDataModelOptions)
replaceConfiguratorConfigDataModel(params)
replace_configurator_config_data_model(self,
        *,
        record_types: dict = None,
        relationship_types: dict = None,
        attribute_types: dict = None,
        system_properties: dict = None,
        locale: str = None,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.manage

Request

Instantiate the ReplaceConfiguratorConfigDataModelOptions struct and set the fields to provide parameter values for the ReplaceConfiguratorConfigDataModel method.

Use the ReplaceConfiguratorConfigDataModelOptions.Builder to create a ReplaceConfiguratorConfigDataModelOptions object that contains the parameter values for the replaceConfiguratorConfigDataModel method.

Query Parameters

  • The cloud resource name of the service.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Examples:
ConfigDataModelExample

WithContext method only

The ReplaceConfiguratorConfigDataModel options.

The replaceConfiguratorConfigDataModel options.

parameters

  • The cloud resource name of the service.

  • Collection of record data types.

    Examples:
    value
    _source
    _lines
    _html
  • The collection of data relationship types.

  • Collection of data attribute types.

  • Collection of system properties.

  • The locale of the data model.

parameters

  • The cloud resource name of the service.

  • Collection of record data types.

    Examples:
    value
    _source
    _lines
    _html
  • The collection of data relationship types.

  • Collection of data attribute types.

  • Collection of system properties.

  • The locale of the data model.

Response

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Collection of locale, record types, relationship types, system properties definition in configuration space.

Status Code

  • Config data model is replaced.

  • Problem processing request. The user is not authenticated.

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

  • Problem replacing config data model. An internal error occurred while attempting to replace the config data model.

Example responses
  • {
      "record_types": [
        {
          "name": "person",
          "default_display_name": "person",
          "properties": [
            {
              "name": "record_source",
              "data_type": "String",
              "default_display_name": "Record Source",
              "designation": "source"
            },
            {
              "name": "social_security_number",
              "data_type": "identification",
              "cardinality": "*",
              "default_display_name": "Social Security Number"
            }
          ],
          "source_systems": [
            {
              "name": "MDMSP",
              "default_display_name": "MDMS Person",
              "quality_factors": {
                "completeness": 100,
                "accuracy": 100,
                "correctness": 100,
                "age_relevancy": 100,
                "data_relevancy": 100,
                "consistency": 100
              }
            }
          ]
        }
      ],
      "data_types": [
        {
          "name": "identification",
          "default_display_name": "identification",
          "properties": [
            {
              "name": "identification",
              "data_type": "String",
              "default_display_name": "Identification Value"
            },
            {
              "name": "identification_number",
              "data_type": "String",
              "default_display_name": "Identification Number"
            }
          ]
        }
      ]
    }
  • {
      "record_types": [
        {
          "name": "person",
          "default_display_name": "person",
          "properties": [
            {
              "name": "record_source",
              "data_type": "String",
              "default_display_name": "Record Source",
              "designation": "source"
            },
            {
              "name": "social_security_number",
              "data_type": "identification",
              "cardinality": "*",
              "default_display_name": "Social Security Number"
            }
          ],
          "source_systems": [
            {
              "name": "MDMSP",
              "default_display_name": "MDMS Person",
              "quality_factors": {
                "completeness": 100,
                "accuracy": 100,
                "correctness": 100,
                "age_relevancy": 100,
                "data_relevancy": 100,
                "consistency": 100
              }
            }
          ]
        }
      ],
      "data_types": [
        {
          "name": "identification",
          "default_display_name": "identification",
          "properties": [
            {
              "name": "identification",
              "data_type": "String",
              "default_display_name": "Identification Value"
            },
            {
              "name": "identification_number",
              "data_type": "String",
              "default_display_name": "Identification Number"
            }
          ]
        }
      ]
    }

Get Config Data Model Record Type Attributes

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

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

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

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

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

GET /mdm/v1/config_data_model/attributes
(mdm *MdmV1) GetConfiguratorConfigDataModelAttributes(getConfiguratorConfigDataModelAttributesOptions *GetConfiguratorConfigDataModelAttributesOptions) (result *ConfigDataModelAttributes, response *core.DetailedResponse, err error)
(mdm *MdmV1) GetConfiguratorConfigDataModelAttributesWithContext(ctx context.Context, getConfiguratorConfigDataModelAttributesOptions *GetConfiguratorConfigDataModelAttributesOptions) (result *ConfigDataModelAttributes, response *core.DetailedResponse, err error)
ServiceCall<ConfigDataModelAttributes> getConfiguratorConfigDataModelAttributes(GetConfiguratorConfigDataModelAttributesOptions getConfiguratorConfigDataModelAttributesOptions)
getConfiguratorConfigDataModelAttributes(params)
get_configurator_config_data_model_attributes(self,
        record_type: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.read

Request

Instantiate the GetConfiguratorConfigDataModelAttributesOptions struct and set the fields to provide parameter values for the GetConfiguratorConfigDataModelAttributes method.

Use the GetConfiguratorConfigDataModelAttributesOptions.Builder to create a GetConfiguratorConfigDataModelAttributesOptions object that contains the parameter values for the getConfiguratorConfigDataModelAttributes method.

Query Parameters

  • The cloud resource name of the service.

  • Unique record type to identify data model attributes

WithContext method only

The GetConfiguratorConfigDataModelAttributes options.

The getConfiguratorConfigDataModelAttributes options.

parameters

  • The cloud resource name of the service.

  • Unique record type to identify data model attributes.

parameters

  • The cloud resource name of the service.

  • Unique record type to identify data model attributes.

Response

The Config Data Model attributes for a record type.

The Config Data Model attributes for a record type.

The Config Data Model attributes for a record type.

The Config Data Model attributes for a record type.

The Config Data Model attributes for a record type.

Status Code

  • Config Data Model Record Type attributes retrieved.

  • Problem processing request. The user is not authenticated.

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

  • Error in fetching Config Data Model Record Type attributes.

Example responses
  • {
      "attributes": [
        {
          "name": "record_id",
          "default_display_name": "Record identifier"
        },
        {
          "name": "record_source",
          "default_display_name": "Record source"
        }
      ]
    }
  • {
      "attributes": [
        {
          "name": "record_id",
          "default_display_name": "Record identifier"
        },
        {
          "name": "record_source",
          "default_display_name": "Record source"
        }
      ]
    }

Get matching statistics

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

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

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

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

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

GET /mdm/v1/match_statistics
(mdm *MdmV1) GetConfiguratorMatchingStatistics(getConfiguratorMatchingStatisticsOptions *GetConfiguratorMatchingStatisticsOptions) (result *MatchStatistics, response *core.DetailedResponse, err error)
(mdm *MdmV1) GetConfiguratorMatchingStatisticsWithContext(ctx context.Context, getConfiguratorMatchingStatisticsOptions *GetConfiguratorMatchingStatisticsOptions) (result *MatchStatistics, response *core.DetailedResponse, err error)
ServiceCall<MatchStatistics> getConfiguratorMatchingStatistics(GetConfiguratorMatchingStatisticsOptions getConfiguratorMatchingStatisticsOptions)
getConfiguratorMatchingStatistics(params)
get_configurator_matching_statistics(self,
        record_type: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.read

Request

Instantiate the GetConfiguratorMatchingStatisticsOptions struct and set the fields to provide parameter values for the GetConfiguratorMatchingStatistics method.

Use the GetConfiguratorMatchingStatisticsOptions.Builder to create a GetConfiguratorMatchingStatisticsOptions object that contains the parameter values for the getConfiguratorMatchingStatistics method.

Query Parameters

  • The cloud resource name of the service.

  • Record type of match statistics

WithContext method only

The GetConfiguratorMatchingStatistics options.

The getConfiguratorMatchingStatistics options.

parameters

  • The cloud resource name of the service.

  • Record type of match statistics.

parameters

  • The cloud resource name of the service.

  • Record type of match statistics.

Response

The Statistics of the match process results.

The Statistics of the match process results.

The Statistics of the match process results.

The Statistics of the match process results.

The Statistics of the match process results.

Status Code

  • Statistics retrieved

  • Problem processing request. The user is not authenticated.

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

  • Error occurred in get resource process. Resource does not exist

  • Error in fetching statistics

Example responses
  • {
      "entity_breakdown": {
        "average": 2,
        "standard_deviation": 0,
        "variance": 0,
        "max": 4,
        "count": 500,
        "min": 1
      },
      "largest_entities": [
        {
          "entity_id": 40976536,
          "entity_size": 4
        }
      ],
      "entity_size_distribution": [
        {
          "entity_count": 5,
          "entity_size": 120
        }
      ],
      "summary": {
        "total_records": 2500,
        "singleton_count": 300,
        "distinct_sources": 4,
        "data_assets": 9,
        "entities_count": 950
      },
      "status": {
        "date_completed": {},
        "comparison_count": 120,
        "bucket_count": 9,
        "run_time": 159000
      }
    }
  • {
      "entity_breakdown": {
        "average": 2,
        "standard_deviation": 0,
        "variance": 0,
        "max": 4,
        "count": 500,
        "min": 1
      },
      "largest_entities": [
        {
          "entity_id": 40976536,
          "entity_size": 4
        }
      ],
      "entity_size_distribution": [
        {
          "entity_count": 5,
          "entity_size": 120
        }
      ],
      "summary": {
        "total_records": 2500,
        "singleton_count": 300,
        "distinct_sources": 4,
        "data_assets": 9,
        "entities_count": 950
      },
      "status": {
        "date_completed": {},
        "comparison_count": 120,
        "bucket_count": 9,
        "run_time": 159000
      }
    }

Get configuration metadata

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

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

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

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

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

GET /mdm/v1/configuration_metadata
(mdm *MdmV1) GetConfiguratorConfigurationMetadata(getConfiguratorConfigurationMetadataOptions *GetConfiguratorConfigurationMetadataOptions) (result *ConfigurationMetadata, response *core.DetailedResponse, err error)
(mdm *MdmV1) GetConfiguratorConfigurationMetadataWithContext(ctx context.Context, getConfiguratorConfigurationMetadataOptions *GetConfiguratorConfigurationMetadataOptions) (result *ConfigurationMetadata, response *core.DetailedResponse, err error)
ServiceCall<ConfigurationMetadata> getConfiguratorConfigurationMetadata(GetConfiguratorConfigurationMetadataOptions getConfiguratorConfigurationMetadataOptions)
getConfiguratorConfigurationMetadata(params)
get_configurator_configuration_metadata(self,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.read

Request

Instantiate the GetConfiguratorConfigurationMetadataOptions struct and set the fields to provide parameter values for the GetConfiguratorConfigurationMetadata method.

Use the GetConfiguratorConfigurationMetadataOptions.Builder to create a GetConfiguratorConfigurationMetadataOptions object that contains the parameter values for the getConfiguratorConfigurationMetadata method.

Query Parameters

  • The cloud resource name of the service.

WithContext method only

parameters

  • The cloud resource name of the service.

parameters

  • The cloud resource name of the service.

Response

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Status Code

  • configuration metadata for given id is fetched successfullly.

  • Problem processing request. The user is not authenticated.

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

  • Error in getting configuration metadata.

Example responses
  • {
      "name": "configuration_metadata",
      "description": "sample configuration metadata",
      "storage_type": "Cloud storage",
      "project_id": "52a72453-597c-4fb3-a518-c815225e3ea9",
      "catalog_id": "8a3cc967-81c4-49a3-86a2-208059819b24",
      "role": "admin",
      "collaborators": "AP",
      "assets": [
        {
          "asset_name": "person-100.csv",
          "asset_status": "Mapped",
          "asset_record_type": "Person",
          "asset_source": "project",
          "asset_mappings": [
            {
              "key": "COLUMN1",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_source",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            },
            {
              "key": "COLUMN2",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_id",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            }
          ],
          "asset_id": "0777c0a7-9a3f-40a8-a094-c85091fa2ec7"
        }
      ]
    }
  • {
      "name": "configuration_metadata",
      "description": "sample configuration metadata",
      "storage_type": "Cloud storage",
      "project_id": "52a72453-597c-4fb3-a518-c815225e3ea9",
      "catalog_id": "8a3cc967-81c4-49a3-86a2-208059819b24",
      "role": "admin",
      "collaborators": "AP",
      "assets": [
        {
          "asset_name": "person-100.csv",
          "asset_status": "Mapped",
          "asset_record_type": "Person",
          "asset_source": "project",
          "asset_mappings": [
            {
              "key": "COLUMN1",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_source",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            },
            {
              "key": "COLUMN2",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_id",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            }
          ],
          "asset_id": "0777c0a7-9a3f-40a8-a094-c85091fa2ec7"
        }
      ]
    }

Replace configuration metadata

Replaces the configuration metadata. It would replace the configuration data including asset information, matching attributes, etc.

Replaces the configuration metadata. It would replace the configuration data including asset information, matching attributes, etc.

Replaces the configuration metadata. It would replace the configuration data including asset information, matching attributes, etc.

Replaces the configuration metadata. It would replace the configuration data including asset information, matching attributes, etc.

Replaces the configuration metadata. It would replace the configuration data including asset information, matching attributes, etc.

PUT /mdm/v1/configuration_metadata
(mdm *MdmV1) ReplaceConfiguratorConfigurationMetadata(replaceConfiguratorConfigurationMetadataOptions *ReplaceConfiguratorConfigurationMetadataOptions) (result *ConfigurationMetadata, response *core.DetailedResponse, err error)
(mdm *MdmV1) ReplaceConfiguratorConfigurationMetadataWithContext(ctx context.Context, replaceConfiguratorConfigurationMetadataOptions *ReplaceConfiguratorConfigurationMetadataOptions) (result *ConfigurationMetadata, response *core.DetailedResponse, err error)
ServiceCall<ConfigurationMetadata> replaceConfiguratorConfigurationMetadata(ReplaceConfiguratorConfigurationMetadataOptions replaceConfiguratorConfigurationMetadataOptions)
replaceConfiguratorConfigurationMetadata(params)
replace_configurator_configuration_metadata(self,
        *,
        project_id: str = None,
        catalog_id: str = None,
        description: str = None,
        name: str = None,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.manage

Request

Instantiate the ReplaceConfiguratorConfigurationMetadataOptions struct and set the fields to provide parameter values for the ReplaceConfiguratorConfigurationMetadata method.

Use the ReplaceConfiguratorConfigurationMetadataOptions.Builder to create a ReplaceConfiguratorConfigurationMetadataOptions object that contains the parameter values for the replaceConfiguratorConfigurationMetadata method.

Query Parameters

  • The cloud resource name of the service.

Configuration metadata details.

Examples:
ConfigurationMetadataExample

WithContext method only

The ReplaceConfiguratorConfigurationMetadata options.

The replaceConfiguratorConfigurationMetadata options.

parameters

  • The cloud resource name of the service.

  • The project id of the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The catalog id from the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The description of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html
  • The name of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • The cloud resource name of the service.

  • The project id of the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The catalog id from the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The description of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html
  • The name of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html

Response

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Status Code

  • configuration metadata successfully replaced

  • Error in replacing configuration metadata. The request you used is invalid. Please revalidate and try again.

  • Problem processing request. The user is not authenticated.

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

  • Internal error occured in replacing configuration metadata.

Example responses
  • {
      "name": "configuration_metadata",
      "description": "sample configuration metadata",
      "storage_type": "Cloud storage",
      "project_id": "52a72453-597c-4fb3-a518-c815225e3ea9",
      "catalog_id": "8a3cc967-81c4-49a3-86a2-208059819b24",
      "role": "admin",
      "collaborators": "AP",
      "assets": [
        {
          "asset_name": "person-100.csv",
          "asset_status": "Mapped",
          "asset_record_type": "Person",
          "asset_source": "project",
          "asset_mappings": [
            {
              "key": "COLUMN1",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_source",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            },
            {
              "key": "COLUMN2",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_id",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            }
          ],
          "asset_id": "0777c0a7-9a3f-40a8-a094-c85091fa2ec7"
        }
      ]
    }
  • {
      "name": "configuration_metadata",
      "description": "sample configuration metadata",
      "storage_type": "Cloud storage",
      "project_id": "52a72453-597c-4fb3-a518-c815225e3ea9",
      "catalog_id": "8a3cc967-81c4-49a3-86a2-208059819b24",
      "role": "admin",
      "collaborators": "AP",
      "assets": [
        {
          "asset_name": "person-100.csv",
          "asset_status": "Mapped",
          "asset_record_type": "Person",
          "asset_source": "project",
          "asset_mappings": [
            {
              "key": "COLUMN1",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_source",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            },
            {
              "key": "COLUMN2",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_id",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            }
          ],
          "asset_id": "0777c0a7-9a3f-40a8-a094-c85091fa2ec7"
        }
      ]
    }

Update configuration metadata

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

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

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

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

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

PATCH /mdm/v1/configuration_metadata
(mdm *MdmV1) UpdateConfiguratorConfigurationMetadata(updateConfiguratorConfigurationMetadataOptions *UpdateConfiguratorConfigurationMetadataOptions) (result *ConfigurationMetadata, response *core.DetailedResponse, err error)
(mdm *MdmV1) UpdateConfiguratorConfigurationMetadataWithContext(ctx context.Context, updateConfiguratorConfigurationMetadataOptions *UpdateConfiguratorConfigurationMetadataOptions) (result *ConfigurationMetadata, response *core.DetailedResponse, err error)
ServiceCall<ConfigurationMetadata> updateConfiguratorConfigurationMetadata(UpdateConfiguratorConfigurationMetadataOptions updateConfiguratorConfigurationMetadataOptions)
updateConfiguratorConfigurationMetadata(params)
update_configurator_configuration_metadata(self,
        *,
        project_id: str = None,
        catalog_id: str = None,
        description: str = None,
        name: str = None,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.manage

Request

Instantiate the UpdateConfiguratorConfigurationMetadataOptions struct and set the fields to provide parameter values for the UpdateConfiguratorConfigurationMetadata method.

Use the UpdateConfiguratorConfigurationMetadataOptions.Builder to create a UpdateConfiguratorConfigurationMetadataOptions object that contains the parameter values for the updateConfiguratorConfigurationMetadata method.

Query Parameters

  • The cloud resource name of the service.

Configuration metadata details.

Examples:
ConfigurationMetadataExample

WithContext method only

The UpdateConfiguratorConfigurationMetadata options.

The updateConfiguratorConfigurationMetadata options.

parameters

  • The cloud resource name of the service.

  • The project id of the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The catalog id from the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The description of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html
  • The name of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • The cloud resource name of the service.

  • The project id of the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The catalog id from the linked WKC project.

    Examples:
    value
    _source
    _lines
    _html
  • The description of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html
  • The name of the Configuration metadata.

    Examples:
    value
    _source
    _lines
    _html

Response

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Configuration metadata details.

Status Code

  • configuration metadata successfully updated

  • Error in updating configuration metadata. The request you used is invalid. Please revalidate and try again.

  • Problem processing request. The user is not authenticated.

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

  • Internal error occured in getting configuration metadata.

Example responses
  • {
      "name": "configuration_metadata",
      "description": "sample configuration metadata",
      "storage_type": "Cloud storage",
      "project_id": "52a72453-597c-4fb3-a518-c815225e3ea9",
      "catalog_id": "8a3cc967-81c4-49a3-86a2-208059819b24",
      "role": "admin",
      "collaborators": "AP",
      "assets": [
        {
          "asset_name": "person-100.csv",
          "asset_status": "Mapped",
          "asset_record_type": "Person",
          "asset_source": "project",
          "asset_mappings": [
            {
              "key": "COLUMN1",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_source",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            },
            {
              "key": "COLUMN2",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_id",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            }
          ],
          "asset_id": "0777c0a7-9a3f-40a8-a094-c85091fa2ec7"
        }
      ]
    }
  • {
      "name": "configuration_metadata",
      "description": "sample configuration metadata",
      "storage_type": "Cloud storage",
      "project_id": "52a72453-597c-4fb3-a518-c815225e3ea9",
      "catalog_id": "8a3cc967-81c4-49a3-86a2-208059819b24",
      "role": "admin",
      "collaborators": "AP",
      "assets": [
        {
          "asset_name": "person-100.csv",
          "asset_status": "Mapped",
          "asset_record_type": "Person",
          "asset_source": "project",
          "asset_mappings": [
            {
              "key": "COLUMN1",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_source",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            },
            {
              "key": "COLUMN2",
              "classified_class": "X",
              "data_mapping_name": "record_id",
              "data_mapping_default_display_name": "record_id",
              "exclude_column": "FALSE",
              "auto_mapped": true,
              "completeness_percent": "90"
            }
          ],
          "asset_id": "0777c0a7-9a3f-40a8-a094-c85091fa2ec7"
        }
      ]
    }

Replace configuration metadata asset

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

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

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

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

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

PUT /mdm/v1/configuration_metadata/assets/{asset_id}
(mdm *MdmV1) ReplaceConfiguratorConfigurationAsset(replaceConfiguratorConfigurationAssetOptions *ReplaceConfiguratorConfigurationAssetOptions) (result *AssetMetadata, response *core.DetailedResponse, err error)
(mdm *MdmV1) ReplaceConfiguratorConfigurationAssetWithContext(ctx context.Context, replaceConfiguratorConfigurationAssetOptions *ReplaceConfiguratorConfigurationAssetOptions) (result *AssetMetadata, response *core.DetailedResponse, err error)
ServiceCall<AssetMetadata> replaceConfiguratorConfigurationAsset(ReplaceConfiguratorConfigurationAssetOptions replaceConfiguratorConfigurationAssetOptions)
replaceConfiguratorConfigurationAsset(params)
replace_configurator_configuration_asset(self,
        asset_id: str,
        asset_name: str,
        asset_status: str,
        *,
        asset_created_date: str = None,
        asset_mappings: List['AssetMapping'] = None,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > name > Access policies.

  • mdm-oc.configurator.manage

Request

Instantiate the ReplaceConfiguratorConfigurationAssetOptions struct and set the fields to provide parameter values for the ReplaceConfiguratorConfigurationAsset method.

Use the ReplaceConfiguratorConfigurationAssetOptions.Builder to create a ReplaceConfiguratorConfigurationAssetOptions object that contains the parameter values for the replaceConfiguratorConfigurationAsset method.

Path Parameters

  • Unique identifier of project asset

Query Parameters

  • The cloud resource name of the service.

Request object for updating an asset.

Examples:
projectAssetExample

WithContext method only

The ReplaceConfiguratorConfigurationAsset options.

The replaceConfiguratorConfigurationAsset options.

parameters

  • The cloud resource name of the service.

  • Unique identifier of project asset.

  • Name of the data asset.

    Examples:
    value
    _source
    _lines
    _html
  • The status of the Data Asset.

    Examples:
    value
    _source
    _lines
    _html
  • The date of data asset creation.

    Examples:
    value
    _source
    _lines
    _html
  • Details of Data Asset column mappings with the data model.

    Examples:
    value
    _source
    _lines
    _html