Data Validation API (2.0)

Download OpenAPI specification:Download

This API provides services to validate businesspartners and identifiers

Analytics

Build Validation Reports

Requests the building of data validation reports. All provided job IDs need to belong to the same storage.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

dataValidationJobId
string (ValidationJobId)

ID of the job which generated the data validation results.

object (DataValidationReportsConfiguration)

Configures if and how Data Validation reports are generated.

Responses
200

OK

201

Created

400

The sent request is malformed.

401

Unauthorized

403

Forbidden

404

Not Found

post/validationreports
Request samples
application/json
{
  • "reportsConfiguration": {
    },
  • "dataValidationJobId": "id"
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "finishedAt": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "attachments": [
    ],
  • "progress": "77",
  • "dataValidationJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "reportsConfiguration": {
    },
  • "metrics": {
    }
}

Poll Validation Reports

After you have requested the building of validation reports, you will receive a job id in the response. { "id" : "<ID>" } Use this ID to poll for the status of the job using this endpoint.

SecurityapiKey
Request
path Parameters
id
required
string (DataValidationJobId)

ID of the validation report.

Example: ef450653-a3bc-4476-83d3-d67397d475a0
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/validationreports/{id}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "finishedAt": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "attachments": [
    ],
  • "progress": "77",
  • "dataValidationJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "reportsConfiguration": {
    },
  • "metrics": {
    }
}