Data Matching API (2.0)

Download OpenAPI specification:Download

This API provides services to maintain matching definition used as configuration for matching jobs and services to match 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
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": "string",
  • "reportsConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "status": "string",
  • "statusMessage": "string",
  • "createdAt": "string",
  • "finishedAt": "string",
  • "user": "string",
  • "attachments": [
    ],
  • "progress": 0,
  • "reportsConfiguration": {
    }
}

Poll Matching Reports

SecurityapiKey
Request
path Parameters
id
required
string

ID of the matching report

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/matchingreports/{id}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "status": "string",
  • "statusMessage": "string",
  • "createdAt": "string",
  • "finishedAt": "string",
  • "user": "string",
  • "attachments": [
    ],
  • "progress": 0,
  • "reportsConfiguration": {
    }
}