List Data Matching Definitions

Read a page of existing Data Matching Definitions.

SecurityapiKey

Request

query Parameters

matchingType

string (MatchingType)

Type of the matching configuration.

Enum:	Description
DEDUPLICATION	The matching configuration is used to identify duplicates in a storage.
LINKAGE	The matching configuration is used to identify links between records in different storages.

Example: matchingType=DEDUPLICATION

page

integer <int32> >= 0

Default: 0

Number of the retrieved result page.

Example: page=1

pageSize

integer <int32> >= 1

Default: 20

Maximum number of items to be returned in the result page.

Example: pageSize=20

workspaceId

string (WorkspaceId)

ID of the workspace.

Example: workspaceId=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

400

The sent request is malformed.

403

Permission denied.

get/datamatchingdefinitions

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"page": "1",
"pageSize": "100",
"numberOfPages": "3",
"total": "67",
"values": [{"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": [null
]
},
"yesBranch": { },
"noBranch": { }
}
},
"creationStrategy": {"type": "CONSTANT",
"protectedAttributes": ["External ID"
],
"recordExclusionRules": [{"type": "HAS_VALUE",
"jsonPath": "attributeJsonPath",
"valueType": "TEXT",
"expectedValues": [null
]
}
],
"attributeEnhancementRules": [{"attributes": [null
],
"constraintChain": {"constraints": [ ],
"allRecordsShouldMatch": null,
"constraintChainType": null
},
"creationType": "CONSTANT",
"creationConstant": "constantValue",
"executionType": "SET",
"fallbackExecutionType": "SET"
}
]
}
},
"workspace": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
]
}