Download OpenAPI specification:Download
This API provides services to upload, manipulate and download businesspartner data in the CDL Cloud
BusinessPartnerReportsRequest
OK
Unauthorized
Forbidden
Not Found
{- "storageId": "string",
- "reportsConfiguration": {
- "subscription": {
- "build": false,
- "countryShortNames": [
- "DE"
], - "dataSource": "string",
- "provenanceTechnicalKeys": [
- "LEI",
- "VIES"
], - "featuresOn": [
- "FETCH_VALIDATION_RESULTS"
]
}, - "updates": {
- "build": false,
- "from": "2019-12-31T08:35",
- "to": "2019-12-31T16:47",
- "dataSourceIds": [
- "string",
- "string"
], - "countryShortNames": [
- "PL",
- "DE",
- "CZ",
- "SK"
], - "provenanceTechnicalKeys": [
- "ORGANIZATION",
- "DATA_SHARING_REVIEW",
- "LEI",
- "VIES"
], - "propertyChangeTypeTechnicalKeys": [
- "ADDED",
- "MODIFIED",
- "DELETED"
], - "affectedConceptTechnicalKeys": [
- "NAME",
- "ADDRESS",
- "IDENTIFIER"
]
}
}
}
{- "summary": {
- "updates": {
- "numberOfUpdates": "342",
- "numberOfCountries": "23"
}
}, - "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2020-08-31T16:47+00:00",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "reportsConfiguration": {
- "subscription": {
- "build": "false",
- "countryShortNames": [
- "DE"
], - "dataSource": "444s28f64a8726d834",
- "provenanceTechnicalKeys": "['CH_UIDR', 'LEI' ,'VIES']",
- "featuresOn": "['FETCH_VALIDATION_RESULTS']"
}, - "updates": {
- "build": "false",
- "from": "2019-12-31T08:35",
- "to": "2019-12-31T16:47",
- "dataSourceIds": "['5d78014f5fda44000191d020', '5ea2d5a3e1cb86000159675c']",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']",
- "provenanceTechnicalKeys": "['ORGANIZATION', 'DATA_SHARING_REVIEW', 'LEI' ,'VIES']",
- "propertyChangeTypeTechnicalKeys": "['ADDED','MODIFIED', 'DELETED']",
- "affectedConceptTechnicalKeys": "['NAME','ADDRESS','IDENTIFIER']"
}
}
}
Build storage dump reports. Validation of the request can be found in description of StorageDumpReportsRequest below.
StorageDumpReportsRequest Request requirements:
OK
Unauthorized
Forbidden
Not Found
{- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "reportsConfiguration": {
- "dnbDumpReport": {
- "build": "false",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']"
}, - "storageDumpReport": {
- "build": "false",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']",
- "dataSourceIds": "['61236a2781bf2e000164bac8']",
- "featuresOn": [
- "FETCH_RECORD"
]
}
}
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2020-08-31T16:47+00:00",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "reportsConfiguration": {
- "dnbDumpReport": {
- "build": "false",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']"
}, - "storageDumpReport": {
- "build": "false",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']",
- "dataSourceIds": "['61236a2781bf2e000164bac8']",
- "featuresOn": [
- "FETCH_RECORD"
]
}
}
}
OK
Unauthorized
Forbidden
Not Found
{- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "reportsConfiguration": {
- "technicalProfiler": {
- "build": "false",
- "sourceFileUrl": "customer-upload/user/file.xlsx",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "featuresOn": [
- "STORE_TECHNICAL_PROFILE"
]
}
}
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2020-08-31T16:47+00:00",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "reportsConfiguration": {
- "technicalProfiler": {
- "build": "false",
- "sourceFileUrl": "customer-upload/user/file.xlsx",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "featuresOn": [
- "STORE_TECHNICAL_PROFILE"
]
}
}
}
OK
Unauthorized
Forbidden
Not Found
{- "summary": {
- "updates": {
- "numberOfUpdates": "342",
- "numberOfCountries": "23"
}
}, - "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2020-08-31T16:47+00:00",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "reportsConfiguration": {
- "subscription": {
- "build": "false",
- "countryShortNames": [
- "DE"
], - "dataSource": "444s28f64a8726d834",
- "provenanceTechnicalKeys": "['CH_UIDR', 'LEI' ,'VIES']",
- "featuresOn": "['FETCH_VALIDATION_RESULTS']"
}, - "updates": {
- "build": "false",
- "from": "2019-12-31T08:35",
- "to": "2019-12-31T16:47",
- "dataSourceIds": "['5d78014f5fda44000191d020', '5ea2d5a3e1cb86000159675c']",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']",
- "provenanceTechnicalKeys": "['ORGANIZATION', 'DATA_SHARING_REVIEW', 'LEI' ,'VIES']",
- "propertyChangeTypeTechnicalKeys": "['ADDED','MODIFIED', 'DELETED']",
- "affectedConceptTechnicalKeys": "['NAME','ADDRESS','IDENTIFIER']"
}
}
}
Poll Storage Dump Reports by id. The id is returned by the build Storage Dump Reports request.
OK
Unauthorized
Forbidden
Not Found
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2020-08-31T16:47+00:00",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "reportsConfiguration": {
- "dnbDumpReport": {
- "build": "false",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']"
}, - "storageDumpReport": {
- "build": "false",
- "countryShortNames": "['PL', 'DE', 'CZ', 'SK']",
- "dataSourceIds": "['61236a2781bf2e000164bac8']",
- "featuresOn": [
- "FETCH_RECORD"
]
}
}
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2020-08-31T16:47+00:00",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "reportsConfiguration": {
- "technicalProfiler": {
- "build": "false",
- "sourceFileUrl": "customer-upload/user/file.xlsx",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "featuresOn": [
- "STORE_TECHNICAL_PROFILE"
]
}
}
}