Data Exchange API (4)

Download OpenAPI specification:Download

Michal Malinka: michal.malinka@cdq.ch URL: https://www.cdq.ch/team

This API provides services to upload, manipulate and download businesspartner data in the CDL Cloud

Analytics

Build Business Partner Reports

SecurityapiKey
Request
Request Body schema: application/json
required

BusinessPartnerReportsRequest

description
string (JobDescription)

Detailed description of a Job.

name
string (JobName)

Name of a Job.

object (BusinessPartnerReportsConfiguration)

Configures if and how business partner reports are generated.

storageId
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/businesspartnerreports
Request samples
application/json
{
  • "storageId": "string",
  • "reportsConfiguration": {
    }
}
Response samples
application/json
{
  • "summary": {
    },
  • "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": [
    ],
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "reportsConfiguration": {
    }
}

Build Storage Dump Reports

Build storage dump reports. Validation of the request can be found in description of StorageDumpReportsRequest below.

SecurityapiKey
Request
Request Body schema: application/json
required

StorageDumpReportsRequest Request requirements:

  • expect that either storadeDumpReport or dnbDumpReport has build = true, never both together
  • expect that storageId is not provided when dnbDumpReport has build = true
description
string (JobDescription)

Detailed description of a Job.

name
string (JobName)

Name of a Job.

object (StorageDumpReportsConfiguration)

Configures if and how Storage Dump reports are generated.

storageId
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/storagedumpreports
Request samples
application/json
{
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "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": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "reportsConfiguration": {
    }
}

Build Technical Reports

SecurityapiKey
Request
Request Body schema: application/json
required

TechnicalReportsRequest

description
string (JobDescription)

Detailed description of a Job.

name
string (JobName)

Name of a Job.

object (TechnicalReportsConfiguration)

Configures if and how technical reports are generated.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/technicalreports
Request samples
application/json
{
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "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": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "reportsConfiguration": {
    }
}

Poll Business Partner Reports

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Business Partner reports job

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/businesspartnerreports/{id}
Request samples 
Response samples 
application/json
{
  • "summary": {
    },
  • "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": [
    ],
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "reportsConfiguration": {
    }
}
Poll Storage Dump Reports
Poll Storage Dump Reports by id. The id is returned by the build Storage Dump Reports request.


SecurityapiKey 
Request 
path Parameters
id
required
string
ID of the storage dump reports job


 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


get/storagedumpreports/{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": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "reportsConfiguration": {
    }
}
Poll Technical Reports
SecurityapiKey 
Request 
path Parameters
id
required
string
ID of the technical reports job


 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


get/technicalreports/{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": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "reportsConfiguration": {
    }
}