Download OpenAPI specification:Download
This API provides services used for business partner qualification
Requests the building of data validation reports. All provided job IDs need to belong to the same storage.
cmd
OK
Created
The sent request is malformed.
Unauthorized
Forbidden
Not Found
{- "reportsConfiguration": {
- "address": {
- "build": false
}, - "businesspartner": {
- "build": false
}, - "identifier": {
- "build": false
}, - "overall": {
- "build": false
}, - "qualification": {
- "build": true
}, - "qualityImprovement": {
- "build": false,
- "dataValidationJobIds": [
- "6be92567-4327-4463-813f-a8c990410d79",
- "f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"
]
}, - "countryShortNames": [
- "PL",
- "DE",
- "CZ",
- "SK"
]
}, - "dataValidationJobId": "id"
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2024-10-22T12:32:48Z",
- "finishedAt": "2024-10-22T12:32:48Z",
- "user": "742429-234242-4343-232323",
- "attachments": [
- {
- "name": "filename.xlsx",
- "type": "REPORT_COLLECTION",
- "url": "cdl-runtime-data/folder/filename.xlsx",
- "tags": [
- "REPORT_FILE_12"
]
}
], - "progress": "77",
- "dataValidationJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "reportsConfiguration": {
- "address": {
- "build": "true"
}, - "businesspartner": {
- "build": "true"
}, - "identifier": {
- "build": "true"
}, - "overall": {
- "build": "true"
}, - "qualification": {
- "build": "true"
}, - "qualityImprovement": {
- "build": "true",
- "dataValidationJobIds": [
- "6be92567-4327-4463-813f-a8c990410d79",
- "f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"
]
}, - "countryShortNames": "['PL', 'DE', 'CZ', 'SK']"
}, - "metrics": {
- "numberOfRecords": "50",
- "numberOfCountries": "5",
- "numberOfDefects": "10",
- "identifierDefectRate": "0.2",
- "defectRate": "0.1"
}
}
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.
OK
Unauthorized
Forbidden
Not Found
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2024-10-22T12:32:48Z",
- "finishedAt": "2024-10-22T12:32:48Z",
- "user": "742429-234242-4343-232323",
- "attachments": [
- {
- "name": "filename.xlsx",
- "type": "REPORT_COLLECTION",
- "url": "cdl-runtime-data/folder/filename.xlsx",
- "tags": [
- "REPORT_FILE_12"
]
}
], - "progress": "77",
- "dataValidationJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "reportsConfiguration": {
- "address": {
- "build": "true"
}, - "businesspartner": {
- "build": "true"
}, - "identifier": {
- "build": "true"
}, - "overall": {
- "build": "true"
}, - "qualification": {
- "build": "true"
}, - "qualityImprovement": {
- "build": "true",
- "dataValidationJobIds": [
- "6be92567-4327-4463-813f-a8c990410d79",
- "f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"
]
}, - "countryShortNames": "['PL', 'DE', 'CZ', 'SK']"
}, - "metrics": {
- "numberOfRecords": "50",
- "numberOfCountries": "5",
- "numberOfDefects": "10",
- "identifierDefectRate": "0.2",
- "defectRate": "0.1"
}
}