Data Matching API (2)

Download OpenAPI specification:Download

This API provides services for maintaining matching definitions used as configuration for matching jobs, as well as services for matching data with a job.

Analytics

Build Matching Reports

Requests the building of data matching reports.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

matchingJobId
string (JobId)

Unique identifier of a job.

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

Configuration for generating matching reports.

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/matchingreports
Request samples
application/json
{
  • "matchingJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "reportsConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2024-12-21T01:35:17Z",
  • "finishedAt": "2024-12-21T01:35:17Z",
  • "user": "johndoe",
  • "attachments": [
    ],
  • "progress": "77",
  • "reportsConfiguration": {
    }
}

Poll Matching Reports

Polls the status of the matching reports.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the matching report.

Example: 65dcc3c60cecd503bcc88c92
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/matchingreports/{id}
Request samples 
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2024-12-21T01:35:17Z",
  • "finishedAt": "2024-12-21T01:35:17Z",
  • "user": "johndoe",
  • "attachments": [
    ],
  • "progress": "77",
  • "reportsConfiguration": {
    }
}