# Read Data Matching Definition

Read an existing Data Matching Definition by its ID.

Endpoint: GET /datamatchingdefinitions/{id}
Version: 2
Security: apiKey

## Path parameters:

  - `id` (string, required)
    ID of the Data Matching Definition.
    Example: "6461e6113b1865304b3038b6"

## Response 200 fields (application/json):

  - `id` (string)
    Id of the data matching definition.
    Example: "6461e6113b1865304b3038b6"

  - `name` (string)
    A human-readable name for the Data Matching Definition instance.
    Example: "Custom Matching Definition Name"

  - `creatorUsername` (string)
    Unique ID of a user.
    Example: "johndoe"

  - `creatorOrganization` (string)
    Uniquely identifying ID of the organization.
    Example: "cdq_monitor"

  - `createdAt` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2025-08-29T09:46:53Z"

  - `lastModifiedAt` (string)
    Date of modification (ISO 8601-compliant).
    Example: "2025-08-29T09:46:53Z"

  - `type` (string)
    Type of the matching configuration.
    Enum: "DEDUPLICATION", "LINKAGE"

  - `xmlDukeConfiguration` (string)
    Holds the Duke XML configuration for data matching.
    Example: "<duke>...</duke>"

  - `reportConfiguration` (object)
    Configuration for generating reports related to the Data Matching Definition.

  - `reportConfiguration.header` (array)
    List of column mappings for the header of the report.

  - `reportConfiguration.header.attributeJsonPath` (string)
    JSON path to the attribute in the result object.
    Example: "attributeJsonPath"

  - `reportConfiguration.header.columnName` (string)
    Name of the column in the report.

Accessible values are:
* 
* 
* 
* 
* 
*
    Example: "External ID"

  - `goldenRecordConfiguration` (object)
    Configuration for creating Golden Records in the context of Data Matching.

  - `goldenRecordConfiguration.decisionStrategy` (object)
    Defines how the decision tree is created.

  - `goldenRecordConfiguration.decisionStrategy.root` (object)
    Defines a node in the decision tree.

  - `goldenRecordConfiguration.decisionStrategy.root.rule` (object)
    Defines a rule that can be used to filter records.

  - `goldenRecordConfiguration.decisionStrategy.root.rule.type` (string)
    Defines the type of the rule.
    Enum: "HAS_VALUE", "HAS_NOT_VALUE", "HAS_VALUE_IN", "HAS_NOT_VALUE_IN", "HAS_VALUE_LIKE", "HAS_NOT_VALUE_LIKE", "HAS_HIGHEST_VALUE", "HAS_LOWEST_VALUE", "IS_MARKED", "IS_NOT_MARKED", "IS_MOST_COMPLETE", "HAS_HIGHEST_MATCH_SCORE"

  - `goldenRecordConfiguration.decisionStrategy.root.rule.jsonPath` (string)
    JSON path to the attribute in the record.
    Example: "attributeJsonPath"

  - `goldenRecordConfiguration.decisionStrategy.root.rule.valueType` (string)
    Defines the type of the value.
    Enum: "TEXT", "DATE", "NUMBER", "FLOATING_POINT_NUMBER"

  - `goldenRecordConfiguration.decisionStrategy.root.rule.expectedValues` (array)
    List of expected values for the attribute.
    Example: ["expectedValue"]

  - `goldenRecordConfiguration.decisionStrategy.root.yesBranch` (object)
    Defines a node in the decision tree.

  - `goldenRecordConfiguration.decisionStrategy.root.noBranch` (object)
    Defines a node in the decision tree.

  - `goldenRecordConfiguration.creationStrategy` (object)
    Defines the strategy for creating Golden Records in the context of Data Matching.

  - `goldenRecordConfiguration.creationStrategy.type` (string, required)
    Defines how an attributes should be added to the Golden Record.
    Enum: "CONSTANT", "MAJORITY", "JOIN_DISTINCT"

  - `goldenRecordConfiguration.creationStrategy.protectedAttributes` (array)
    List of attributes of base record that should be kept.
    Example: ["External ID"]

  - `goldenRecordConfiguration.creationStrategy.recordExclusionRules` (array)
    List of rules to exclude certain records from Golden Record creation (e.g. has a deletion flag).

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules` (array)
    List of rules to define if and how a certain attribute should be included or removed from the Golden Record.

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.attributes` (array, required)
    List of attributes affected by this rule of enhancement.
    Example: ["External ID"]

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.constraintChain` (object)
    Defines a chain of constraints that are applied to the attributes.

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.constraintChain.constraints` (array)
    List of attributes affected by this rule of enhancement.

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.constraintChain.allRecordsShouldMatch` (boolean)
    If true, all records should match the constraints. If false, at least one record should match the constraints.
    Example: "true"

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.constraintChain.constraintChainType` (string)
    Defines the type of the constraint chain.
    Enum: "AND", "OR"

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.creationType` (string)
    Defines how an attributes should be added to the Golden Record.
    Enum: "CONSTANT", "MAJORITY", "JOIN_DISTINCT"

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.creationConstant` (string)
    Constant value that should be used for the attribute.
    Example: "constantValue"

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.executionType` (string, required)
    Defines options for handling attributes.
    Enum: "SET", "ENRICH", "REMOVE"

  - `goldenRecordConfiguration.creationStrategy.attributeEnhancementRules.fallbackExecutionType` (string)
    Defines options for handling attributes.
    Enum: "SET", "ENRICH", "REMOVE"

  - `workspace` (object)
    Collaboration space to share/configure configurations.

  - `workspace.id` (string)
    Uniquely identifying ID of the workspace.
    Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

## Response 400 fields (application/json):

  - `path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `status` (integer)
    RFC 7231 status code for this error.
    Example: "400"

  - `timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-08-29T09:46:53Z"

  - `error` (string)
    RFC 7231 error which belongs to the status code.
    Example: "BAD_REQUEST"

  - `message` (string)
    Details about the error.
    Example: "This user is not allowed to access this service."

## Response 403 fields (application/json):

  - `path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `status` (integer)
    RFC 7231 status code for this error.
    Example: "400"

  - `timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-08-29T09:46:53Z"

  - `error` (string)
    RFC 7231 error which belongs to the status code.
    Example: "BAD_REQUEST"

  - `message` (string)
    Details about the error.
    Example: "This user is not allowed to access this service."