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

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

List Links

Request

Reads a page of links of the Business Partners starting from the 'startAfter' and with a size of 'limit'.

Security
apiKey
Query
startAfterstring

Only items with an ID greater than the given one will be retrieved.

When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page.

Example: startAfter=5712566172571652
limitinteger(int32)>= 1

Number of items to be returned on the page.

Default 500
Example: limit=100
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: storageId=72d6900fce6b326088f5d9d91049e3e6
referenceDataSourceArray of strings

Reference data source as ALEI prefix of the linked Business Partner.

Example: referenceDataSource=CDQ.POOL
businessPartnerIdArray of strings(BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
externalIdArray of strings(BusinessPartnerExternalId)

Business Partner externalIDs.

Example: externalId=The ID managed in the customer's SAP systems.
dataSourceIdArray of strings(BusinessPartnerStorageDataSourceId)

Filter by specified Data Source ID.

Example: dataSourceId=648824a691d8d2503d65103e
cdqIdsArray of strings

CDQ IDs which should be filtered.

Example: cdqIds=VIES:PL8660001429
featuresOnArray of strings(BusinessPartnerIdentityLinksReadFeatureParam)

Features to be activated.

Items Enum ValueDescription
ACCEPT_REPLICATION_DELAYS

Accepts replication delays in persisting to the database. Allows faster data access. By default, deactivated.

NUMBER_OF_TOTAL

Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.

Example: featuresOn=ACCEPT_REPLICATION_DELAYS
featuresOffArray of strings(BusinessPartnerIdentityLinksReadFeatureParam)

Features to be deactivated.

Items Enum ValueDescription
ACCEPT_REPLICATION_DELAYS

Accepts replication delays in persisting to the database. Allows faster data access. By default, deactivated.

NUMBER_OF_TOTAL

Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.

Example: featuresOff=ACCEPT_REPLICATION_DELAYS
curl -i -X GET \
  'https://api.cdq.com/data-exchange/rest/v4/businesspartners/identitylinks?storageId=72d6900fce6b326088f5d9d91049e3e6' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(BusinessPartnerIdentityLink)

List of Business Partner Identity Links.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "total": "67",
  "values": [
    { … }
  ]
}