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

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

Update Data SourcesDeprecated

Request

This endpoint is deprecated. Please use

Update all data sources of a given storage.

  • When a new data source without id is added to the list, it is created. In case data source is created within DATA_MIRROR and does not have dataMapperDefinitionId or dataTransformationDefinitionId filled, dataMapperDefinitionId is set to default.
  • When existing data source is provided on a list with id included, it is updated.
  • When data source identified by id is not included in a list, it is deleted with all its related Business Partners, data monitors and sharing scopes for that data source are adjusted (data source is removed from the data sources list of a resource and resource is removed if data source was the only one assigned).

Note: all data sources that are expected to remain in the storage must be included on a list.

Warn: If you have an integration with one data source, please check if data source id is included in the upsert request before adding a new data source. Otherwise, adding new data source may lead to upsert failures visible as bad request containing message "No DataSource was provided for the given Business Partners and the storage has more than one attached to it.".

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique ID of Business Partner storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Bodyapplication/jsonrequired
dataSourcesArray of objects(DataSourceParam)[ 1 .. 100 ] itemsrequired

List of Data Sources.

dataSources[].​idstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
dataSources[].​createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"
dataSources[].​lastUpdatedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"
dataSources[].​namestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"
dataSources[].​dataMapperDefinitionIdstring(DataMapperDefinitionId)

ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.

Example: "6440dba32b30176c5917b1b7"
dataSources[].​dataTransformationDefinitionIdstring(DataTransformationDefinitionId)

Unique identifier for a data transformation definition.

Example: "SAP.ODM"
curl -i -X PUT \
  https://api.cdq.com/data-exchange/rest/storages/72d6900fce6b326088f5d9d91049e3e6/datasources \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "dataSources": [
      {
        "id": "648824a691d8d2503d65103e",
        "createdAt": "2025-08-19T06:23:16Z",
        "lastUpdatedAt": "2025-08-19T06:23:16Z",
        "name": "Internal customers",
        "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
        "dataTransformationDefinitionId": "SAP.ODM"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
createdinteger(int64)(UpsertResultCreated)

Number of created Data Sources for monitoring.

Example: "4"
updatedinteger(int64)(UpsertResultUpdated)

Number of updated Data Sources for monitoring.

Example: "0"
failedinteger(int64)(UpsertResultFailed)

Number of failed updates.

Example: "4"
Response
application/json
{
  "created": "4",
  "updated": "0",
  "failed": "4"
}

List Update Monitors' Data SourcesDeprecated

Request

List all data sources available for update monitoring.

Security
apiKey
curl -i -X GET \
  https://api.cdq.com/data-exchange/rest/updatemonitors/datasources \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataSourcesArray of strings(BusinessPartnerStorageDataSourceId)

List of Data Sources.

Example: ["648824a691d8d2503d65103e"]
Response
application/json
{
  "dataSources": [
    "648824a691d8d2503d65103e"
  ]
}

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