Skip to content

Data Exchange API (5)

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

Overview
URL

https://www.cdq.ch/team

Michal Malinka

michal.malinka@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/

Production SOAP

https://api.corporate-data-league.ch/data-exchange/soap/v5/

Production

https://api.corporate-data-league.ch/data-exchange/

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.

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

Subscriptions

Provides functionalities for managing subscriptions.

Operations

Subscribe to Business Partner

Request

Creates and updates subscriptions for all CDQ IDs provided in the request for the organization of the user. A CDQ ID always refers to a Business Partner and a specific address.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

cmd

subscriptionsArray of objects(SubscriptionUpsert)[ 1 .. 1000 ] itemsrequired

List of subscriptions.

subscriptions[].​idstring

Uniquely identifying ID of the subscription.

Example: "601ab61bc840f7000186cada"
subscriptions[].​cdqIdstring(SubscriptionCdqId)required

Unique CDQ ID of the subscription.

Example: "CDQ.POOL:5E580DD08E8B454820E8F67E0"
subscriptions[].​typesArray of strings(SubscriptionType)non-emptyuniquerequired

List of subscription types.

Items ValueDescription
UPDATES

Subscription for updates.

Example: ["UPDATES"]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/businesspartners/subscriptions \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "subscriptions": [
      {
        "id": "601ab61bc840f7000186cada",
        "cdqId": "CDQ.POOL:5E580DD08E8B454820E8F67E0",
        "types": [
          "UPDATES"
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfInsertsinteger(int32)

Number of inserted subscriptions.

Example: "50"
numberOfUpdatesinteger(int32)

Number of updated subscriptions.

Example: "50"
numberOfFailedinteger(int32)

Number of failed subscriptions.

Example: "50"
failuresArray of objects(SubscriptionFailureLog)

List of failed subscriptions.

Response
application/json
{
  "numberOfInserts": "50",
  "numberOfUpdates": "50",
  "numberOfFailed": "50",
  "failures": [
    { … }
  ]
}

List Subscriptions

Request

Reads a page of subscription of the users organization starting from the ID 'startAfter' and with a size of 'limit'

Security
basicAuth
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
referenceDataSourcestring

Reference Data Source as ALEI prefix of the subscribed Business Partner used to filter the result of subscriptions returned.

Example: referenceDataSource=CDQ.POOL
sortstring

Defines the attribute to sort by (ascending). Supported attributes are 'id' and 'cdqId'.

Example: sort=id
featuresOnArray of strings(ReadSubscriptionsFeatureParam)

Feature to be activated.

Items ValueDescription
TOTAL_UNIQUE_CDQ_IDS

Total number of subscriptions unique by cdqId.

Example: featuresOn=TOTAL_UNIQUE_CDQ_IDS
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/businesspartners/subscriptions \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

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(Subscription)

List of subscriptions.

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

Delete Subscriptions

Request

Deletes subscriptions of the users organization by the given CDQ ID.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

The CDQ ID for which the subscription should be deleted.

cdqIdsArray of strings[ 1 .. 1000 ] itemsrequired

List of unique CDQ IDs of the subscriptions.

Example: ["CDQ.POOL:5E580DD08E8B454820E8F67E0"]
curl -i -X DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/businesspartners/subscriptions \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "cdqIds": [
      "CDQ.POOL:5E580DD08E8B454820E8F67E0"
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfDeletedinteger(int32)

Number of deleted subscriptions.

Example: "50"
numberOfFailedinteger(int32)

Number of failed deletions.

Example: "50"
failuresArray of objects(SubscriptionFailureLog)

List of failed subscriptions.

Response
application/json
{
  "numberOfDeleted": "50",
  "numberOfFailed": "50",
  "failures": [
    { … }
  ]
}

Read Subscription

Request

Reads a subscription related to the users organization and the given CDQ ID

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

The CDQ ID for which the subscription should be read.

cdqIdstringrequired

Unique identifier for the Business Partner.

Example: "VIES:PL8660001429"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/businesspartners/subscriptions/fetchSubscription \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "cdqId": "VIES:PL8660001429"
  }'

Responses

OK

Bodyapplication/json
idstring

Uniquely identifying ID of the subscription.

Example: "601ab61bc840f7000186cada"
cdqIdstringrequired

Unique identifier for the Business Partner.

Example: "VIES:PL8660001429"
typesArray of stringsnon-emptyuniquerequired

List of types of subscription.

Example: ["UPDATES"]
organizationstringread-only

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
Response
application/json
{
  "id": "601ab61bc840f7000186cada",
  "cdqId": "VIES:PL8660001429",
  "types": [
    "UPDATES"
  ],
  "organization": "cdq_monitor",
  "createdAt": "2020-08-31T16:47+00:00"
}

List Subscriptions Metadata

Request

Reads multiple subscriptions metadata (e.g. numberOfSubscribers, ...) related to the given CDQ IDs.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

List of CDQ IDs for which the subscription metadata should be read.

cdqIdsArray of strings<= 1000 items

List of unique IDs of the subscriptions.

Example: ["CDQ.POOL:5E580DD08E8B454820E8F67E0"]
subscriptionMetadataRequestsArray of objects(SubscriptionMetadataRequest)<= 1000 items

List of parameters for fetching subscription metadata.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/businesspartners/subscriptions/fetchMetadata \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "cdqIds": [
      "CDQ.POOL:5E580DD08E8B454820E8F67E0"
    ],
    "subscriptionMetadataRequests": [
      {
        "cdqId": "VIES:PL8660001429",
        "businessPartnerId": "63e635235c06b7396330fe40"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
subscriptionsMetadataArray of objects(SubscriptionMetadata)

List of subscriptions metadata.

Response
application/json
{
  "subscriptionsMetadata": [
    { … }
  ]
}

List Links

Request

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

Security
basicAuth
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
linkageStatusesArray of strings(LinkageStatus)

Filter by specified Linkage Status.

Example: linkageStatuses=SUCCESSFULLY_LINKED
sortstring

Defines the attributes to sort by. Supported attribute is 'id' and the sort direction in front of each attribute. '+' means ascending, '-' means descending. Default sort, if direction is not given, is ascending.

Example: sort=+id
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
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/v4/businesspartners/identitylinks?storageId=72d6900fce6b326088f5d9d91049e3e6' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

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": [
    { … }
  ]
}

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

Update Classification

Operations

Event Stores

Operations

Business Partner Storages (None Public)

Operations

Restart Monitor Job

Operations

Cache

Operations

Configuration

Operations

Event Store

Operations

CDQ Community Pool

Operations