Read Data Matching Definition

Read an existing Data Matching Definition by its ID.

SecurityapiKey

Request

path Parameters

required

string (DataMatchingDefinitionId)

ID of the Data Matching Definition.

Example: 6461e6113b1865304b3038b6

Responses

200

400

The sent request is malformed.

403

Permission denied.

get/datamatchingdefinitions/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "6461e6113b1865304b3038b6",
"name": "Custom Matching Definition Name",
"creatorUsername": "johndoe",
"creatorOrganization": "cdq_monitor",
"createdAt": "2025-03-14T11:41:22Z",
"lastModifiedAt": "2025-03-14T11:41:22Z",
"type": "DEDUPLICATION",
"xmlDukeConfiguration": "<duke>...</duke>",
"reportConfiguration": {"header": [{"attributeJsonPath": "attributeJsonPath",
"columnName": "External ID"
}
]
},
"goldenRecordConfiguration": {"decisionStrategy": {"root": {"rule": {"type": "HAS_VALUE",
"jsonPath": "attributeJsonPath",
"valueType": "TEXT",
"expectedValues": ["expectedValue"
]
},
"yesBranch": { },
"noBranch": { }
}
},
"creationStrategy": {"type": "CONSTANT",
"protectedAttributes": ["External ID"
],
"recordExclusionRules": [{"type": "HAS_VALUE",
"jsonPath": "attributeJsonPath",
"valueType": "TEXT",
"expectedValues": ["expectedValue"
]
}
],
"attributeEnhancementRules": [{"attributes": ["External ID"
],
"constraintChain": {"constraints": [{"type": null,
"jsonPath": null,
"valueType": null,
"expectedValues": [ ]
}
],
"allRecordsShouldMatch": "true",
"constraintChainType": "AND"
},
"creationType": "CONSTANT",
"creationConstant": "constantValue",
"executionType": "SET",
"fallbackExecutionType": "SET"
}
]
}
},
"workspace": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}