Data Curation API (2)

Download OpenAPI specification:Download

Sylwester Lew: sylwester.lew@cdq.com URL: https://www.cdq.ch/team

This API provides services to curate and enrich Business Partner and address data.

Address Curation

Analytics

Everything about Analytics

Build Data Curation ReportsWSDL

Start a job to build selected reports. Before you can request reports you need to run a curation job first. With the build toggle you can control which report is generated or not. Every report may have specific additional configuration options which are explained in detail below.

SecurityapiKey
Request
Request Body schema: application/json
required

Request to create curation report.

dataCurationJobId is required.

dataCurationJobId
string (DataCurationJobId)

Unique ID of a data curation job.

Example: "a34fb367-85aa-400f-b369-53863432050c"
description
string <= 200 characters

Description of the job.

Example: "The report will be generated for the Data Curation Job with ID: a34fb367-85aa-400f-b369-53863432050c."
name
string <= 50 characters

Name of the job.

Example: "Data Curation Reports Job"
required
object (DataCurationReportsConfiguration)

Configures if and how Data Curation reports are generated.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/datacurationreports
Request samples
application/json
{
  • "dataCurationJobId": "a34fb367-85aa-400f-b369-53863432050c",
  • "name": "Data Curation Reports Job",
  • "description": "The report will be generated for the Data Curation Job with ID: a34fb367-85aa-400f-b369-53863432050c.",
  • "reportsConfiguration": {
    }
}
Response samples
application/json
{
  • "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": "2024-04-25T08:59:31Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "reportsConfiguration": {
    }
}

Poll Data Curation ReportsWSDL

After you have started a report job, you will receive a job id in the response. { 'id' : '' } Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the report files which you will find in attachments in the response.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

ID of the Data Curation reports job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/datacurationreports/{id}
Request samples 
Response samples 
application/json
{
  • "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": "2024-04-25T08:59:31Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "reportsConfiguration": {
    }
}