Skip to content

Data Exchange API (5)

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

Download OpenAPI description
api-v5.json
api-v5.yaml
Languages
Servers
Production

https://api.cdq.com/data-exchange/rest/

Seed Updates

Manages operations such as creating, updating, or transforming Business Partner data to ensure that the information is current and accurate.

Operations

Start Seed Updates Generate Job

Request

Start a Seed Updates Generate Job for the given storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Bodyapplication/jsonrequired
referenceDataSourcestring(DataSourceTechnicalKey)required

Technical key of the data source.

Example: "BR_RF"
dataSourceIdsArray of strings(StorageDataSourceIds)

List of data source IDs to be processed.

Example: ["5e2874fb8d2a7400011acee1"]
externalIdsArray of strings(BusinessPartnerExternalIds)

List of business partner external IDs to be processed.

Example: ["The ID managed in the customer's SAP systems."]
businessPartnerIdsArray of strings(BusinessPartnerIds)

List of business partner IDs to be processed.

Example: ["63e635235c06b7396330fe40"]
countryShortNamestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
curl -i -X POST \
  https://api.cdq.com/data-exchange/rest/v5/storages/72d6900fce6b326088f5d9d91049e3e6/seedupdates/generate \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "referenceDataSource": "BR_RF",
    "dataSourceIds": [
      "5e2874fb8d2a7400011acee1"
    ],
    "externalIds": [
      "The ID managed in the customer'\''s SAP systems."
    ],
    "businessPartnerIds": [
      "63e635235c06b7396330fe40"
    ],
    "countryShortName": "CH"
  }'

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
namestring(JobName)

Name of a Job.

Example: "Process vendor data."
descriptionstring(JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
statusstring(schemas-JobStatus)

Job execution status.

Example: "RUNNING"
statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"
referenceDataSourcestring(DataSourceTechnicalKey)

Technical key of the data source.

Example: "BR_RF"
dataSourceIdsArray of strings(StorageDataSourceIds)

List of data source IDs to be processed.

Example: ["5e2874fb8d2a7400011acee1"]
externalIdsArray of strings(BusinessPartnerExternalIds)

List of business partner external IDs to be processed.

Example: ["The ID managed in the customer's SAP systems."]
businessPartnerIdsArray of strings(BusinessPartnerIds)

List of business partner IDs to be processed.

Example: ["63e635235c06b7396330fe40"]
countryShortNamestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "name": "Process vendor data.",
  "description": "I started this job to improve quality of our data.",
  "progress": "77",
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "createdBy": "76248934691294444",
  "createdAt": "2025-08-19T06:23:16Z",
  "modifiedAt": "2025-08-19T06:23:16Z",
  "referenceDataSource": "BR_RF",
  "dataSourceIds": [
    "5e2874fb8d2a7400011acee1"
  ],
  "externalIds": [
    "The ID managed in the customer's SAP systems."
  ],
  "businessPartnerIds": [
    "63e635235c06b7396330fe40"
  ],
  "countryShortName": "CH"
}

Poll Seed Updates Generate Job

Request

Poll a Seed Updates Generate Job for the given storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
jobIdstring(JobId)required

ID of the job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
curl -i -X GET \
  https://api.cdq.com/data-exchange/rest/v5/storages/72d6900fce6b326088f5d9d91049e3e6/seedupdates/generate/35f23c03-1c22-45fe-9484-3ffe769325de \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
namestring(JobName)

Name of a Job.

Example: "Process vendor data."
descriptionstring(JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
statusstring(schemas-JobStatus)

Job execution status.

Example: "RUNNING"
statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"
referenceDataSourcestring(DataSourceTechnicalKey)

Technical key of the data source.

Example: "BR_RF"
dataSourceIdsArray of strings(StorageDataSourceIds)

List of data source IDs to be processed.

Example: ["5e2874fb8d2a7400011acee1"]
externalIdsArray of strings(BusinessPartnerExternalIds)

List of business partner external IDs to be processed.

Example: ["The ID managed in the customer's SAP systems."]
businessPartnerIdsArray of strings(BusinessPartnerIds)

List of business partner IDs to be processed.

Example: ["63e635235c06b7396330fe40"]
countryShortNamestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "name": "Process vendor data.",
  "description": "I started this job to improve quality of our data.",
  "progress": "77",
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "createdBy": "76248934691294444",
  "createdAt": "2025-08-19T06:23:16Z",
  "modifiedAt": "2025-08-19T06:23:16Z",
  "referenceDataSource": "BR_RF",
  "dataSourceIds": [
    "5e2874fb8d2a7400011acee1"
  ],
  "externalIds": [
    "The ID managed in the customer's SAP systems."
  ],
  "businessPartnerIds": [
    "63e635235c06b7396330fe40"
  ],
  "countryShortName": "CH"
}

Analytics

Provides functionalities for analyzing and processing Business Partner data, enabling users to gain insights and perform various analytical operations on the data.

Operations

Business Partner Storages

Provides functionalities for creating, retrieving, updating and deleting Business Partner storage, as well as managing associated data sources and data monitors.

Operations

Business Partners

Provides functionalities for creating, retrieving, updating, and deleting Business Partner records, as well as performing various operations such as lookup and upsert.

Operations

Data Import

Provides functionalities for uploading external data and enabling users to enhance and update their Business Partner records with new information.

Operations

Data Mapping

Provides functionalities for defining and managing data mappings, enabling users to transform and map raw data into structured formats suitable for processing and analysis.

Operations

Data Monitors

Provides functionalities for creating, retrieving, updating and deleting data monitors.

Operations

Data Transformation

Provides functionalities for converting raw data into structured formats.

Operations

DNB Storages

Provides functionalities for creating, retrieving, updating and deleting DNB storage, as well as managing associated data sources and data monitors.

Operations

Files

Provides functionalities for uploading, downloading and deleting files.

Operations

Data Mappers

Provides functionalities for transforming raw data into structured Business Partner data using predefined data mapper definitions. This allows users to convert various data formats into a standardized format suitable for processing and analysis.

Operations

Relations

Manages relationships between Business Partners.

Operations

Subscriptions

Operations