Skip to content

Data Matching API (3)

This API provides services for executing Business Partner Duplicate Matching process.

Download OpenAPI description
api-v3.json
api-v3.yaml
Languages
Servers
Production

https://api.cdq.com/data-matching/rest/

Analytics

Provides functionalities for generating and polling data matching reports. These endpoints support creating reports and checking their status, ensuring comprehensive analytics for data matching activities.

Operations

Build Matching Reports

Request

Requests the building of data matching reports.

Security
apiKey
Bodyapplication/jsonrequired

cmd

matchingJobIdstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
reportsConfigurationobject(MatchingReportsConfiguration)

Configuration for generating matching reports.

curl -i -X POST \
  https://api.cdq.com/data-matching/rest/matchingreports \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "matchingJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
    "reportsConfiguration": {
      "duplicateMatching": {
        "build": "false",
        "includeSingles": "false"
      },
      "duplicateConsolidation": {
        "build": "false",
        "includeSingles": "false"
      },
      "linkage": {
        "build": "false",
        "includeSingles": "false"
      }
    }
  }'

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
statusstring(schemas-JobStatus)

Job execution status.

Example: "RUNNING"
statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-15T11:08:26Z"
finishedAtstring

ISO 8601 representation of the timestamp when the Matching Report was finished.

Example: "2025-08-15T11:08:26Z"
userstring(UserId)

Unique ID of a user.

Example: "johndoe"
attachmentsArray of objects(Attachment)

List of attachments that are part of the report.

progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
reportsConfigurationobject(MatchingReportsConfiguration)

Configuration for generating matching reports.

Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "createdAt": "2025-08-15T11:08:26Z",
  "finishedAt": "2025-08-15T11:08:26Z",
  "user": "johndoe",
  "attachments": [
    { … }
  ],
  "progress": "77",
  "reportsConfiguration": {
    "duplicateMatching": { … },
    "duplicateConsolidation": { … },
    "linkage": { … }
  }
}

Poll Matching Reports

Request

Polls the status of the matching reports.

Security
apiKey
Path
idstringrequired

ID of the matching report.

Example: 65dcc3c60cecd503bcc88c92
curl -i -X GET \
  https://api.cdq.com/data-matching/rest/matchingreports/65dcc3c60cecd503bcc88c92 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
statusstring(schemas-JobStatus)

Job execution status.

Example: "RUNNING"
statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-15T11:08:26Z"
finishedAtstring

ISO 8601 representation of the timestamp when the Matching Report was finished.

Example: "2025-08-15T11:08:26Z"
userstring(UserId)

Unique ID of a user.

Example: "johndoe"
attachmentsArray of objects(Attachment)

List of attachments that are part of the report.

progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
reportsConfigurationobject(MatchingReportsConfiguration)

Configuration for generating matching reports.

Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "createdAt": "2025-08-15T11:08:26Z",
  "finishedAt": "2025-08-15T11:08:26Z",
  "user": "johndoe",
  "attachments": [
    { … }
  ],
  "progress": "77",
  "reportsConfiguration": {
    "duplicateMatching": { … },
    "duplicateConsolidation": { … },
    "linkage": { … }
  }
}

Business Partner

Provides functionalities for managing business partners. These endpoints support matching business partners against data matching definitions, ensuring comprehensive analytics for data matching activities.

Data Matching

Provides functionalities for managing Data Matching Definitions, which are configurations for matching jobs to identify duplicates or link records across data sources. These endpoints support creating, reading, updating, and deleting these configurations.

Operations

Duplicate Matching

Provides functionalities for managing duplications within a single data source. These endpoints support creating Deduplication Job and checking the Deduplication Job Status.

Operations

Linkage Matching

Provides functionalities for managing linkages across multiple data sources. These endpoints support creating Linkage Job and checking the Linkage Job Status.

Operations

Public

Provides functionalities for polling the Matching Reports.

Operations

User Feedback

Provides functionalities for managing user feedback related to data matching decisions.

Operations