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

Count Storages

Request

Count all Business Partner Storages of the user's organization.

Security
basicAuth
Query
workspaceIdsArray of strings(WorkspaceId)

Workspace ids that are to be calculated.

Example: workspaceIds=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
featuresOnArray of strings(CountStoragesFeatureParam)

Features to be activated during counting Business Partner Storages.

Items Enum ValueDescription
INCLUDE_ORGANIZATION

Includes current organization Business Partner Storages count. By default, deactivated.

INCLUDE_USER

Includes current user Business Partner Storages. By default, turned on.

INCLUDE_WORKSPACES

Includes workspaces Business Partner Storages count current or provided by parameters. By default, deactivated.

Example: featuresOn=INCLUDE_USER
featuresOffArray of strings(CountStoragesFeatureParam)

Features to be deactivated during counting Business Partner Storages.

Items Enum ValueDescription
INCLUDE_ORGANIZATION

Includes current organization Business Partner Storages count. By default, deactivated.

INCLUDE_USER

Includes current user Business Partner Storages. By default, turned on.

INCLUDE_WORKSPACES

Includes workspaces Business Partner Storages count current or provided by parameters. By default, deactivated.

Example: featuresOff=INCLUDE_USER
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/storages/count \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
valuesArray of objects(BusinessPartnerStorageCount)

List of Business Partner Storages.

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

Update Storage

Request

Update a Business Partner Storage.

Security
basicAuth
Path
storageIdstring(BusinessPartnerStorageId)required

Unique ID of a Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
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
namestring(BusinessPartnerStorageName)<= 100 characters

Name of the Business Partner Storage.

Example: "CDQ AG"
labelsArray of strings(StorageLabels)<= 10 itemsunique

List of Storages labels.

Example: ["Custom Storage Name"]
dataMatchingDefinitionIdstring(DataMatchingDefinitionId)

ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.

Example: "6400955811c68a034bcef311"
sharedWithOrganizationboolean(SharedWithOrganization)

Indicates if this Business Partner Storage is shared with all users of the same organization

Example: "true"
curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/storages/72d6900fce6b326088f5d9d91049e3e6 \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "name": "CDQ AG",
    "labels": [
      "Custom Storage Name"
    ],
    "dataMatchingDefinitionId": "6400955811c68a034bcef311",
    "sharedWithOrganization": "true"
  }'

Responses

OK

Bodyapplication/json
idstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
namestring(BusinessPartnerStorageName)<= 100 characters

Name of the Business Partner Storage.

Example: "CDQ AG"
eventStoreIdstring(EventStoreId)

Internal ID of Event Store.

Example: "72d6900fce6b326123f5d9d91049e3e6"
decisionLogIdstring(DecisionLogId)

ID of related decision log.

Example: "72d6900fc3wb326088f5d9d91044e3e6"
searchIndexIdstring

ID of index in Index API.

Example: "reference_data_staging-88466b2a-92d6-4541-af91-eebe5cba0fa4"
organizationstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
workspaceIdstring

Uniquely identifying ID of the workspace. When provided, workspaceId from JWT is ignored (use case:/ when data mirror is created in user management).

Example: "64d4b623bda6e867724df5cd"
sharingClientIdstring

ID of technical client for streaming sharing process.

Example: "12345678-1234-5678-1234-567812345678"
userstring(UserId)

Unique ID of a user.

Example: "johndoe"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
expiresAtstring

Date when storage expires.

Possible values:

  • a date when a storage expires,
  • NEVER when storage is a Data Mirror or has been created including NEVER_EXPIRE feature.

Expiry date is calculated based on the date of last write operation related to a storage (upsert of data, update of data sources, executed job) plus 6 months, refreshed as most 2 weeks before previous storage expiration date.

Example: "2019-08-31T16:47+00:00"
dataMatchingDefinitionIdstring(DataMatchingDefinitionId)

ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.

Example: "6400955811c68a034bcef311"
dataSourcesArray of objects(DataSource)

List of Data Sources.

dataMonitorsArray of objects(DataMonitor)

List of data monitors.

featuresobject

Features of a storage.

numberOfCountriesinteger(int64)(NumberOfCountries)

Number of countries in the Business Partner Storage.

Example: "12"
numberOfRecordsinteger(int64)(NumberOfRecords)

Number of records in the Business Partner Storage.

Example: "500"
countryStatisticsArray of objects(CountryStatistic)
originalFileHeaderArray of strings

List of headers used for a modification of metadata.

Example: ["BusinessPartnerId, Name, Address"]
originalFileNamestring(OriginalFileName)

Name of the last file that was used to import data into this Business Partner Storage.

Example: "business-partner.csv"
resultsobject(Results)

Results of a Business Partner Storage.

statusstring(StorageMetadataStatus)

Status of a Business Partner Storage.

Example: "FILE_IMPORTED_SUCCESSFULLY"
statusMessagestring(StorageMetadataStatusMessage)

Details related to status.

Example: "BusinessPartner batch could not be upserted into Business Partner Storage."
sharedWithOrganizationboolean(SharedWithOrganization)

Indicates if this Business Partner Storage is shared with all users of the same organization

Example: "true"
labelsArray of strings(StorageLabels)<= 10 itemsunique

Labels to categorize the storage.

Example: ["Custom Storage Name"]
domainstring(Domain)Deprecated

Domain of a Business Partner Storage.

Example: "BusinessPartner"
Response
application/json
{
  "id": "648824a691d8d2503d65103e",
  "name": "CDQ AG",
  "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
  "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
  "searchIndexId": "reference_data_staging-88466b2a-92d6-4541-af91-eebe5cba0fa4",
  "domain": "BusinessPartner",
  "organization": "cdq_monitor",
  "workspaceId": "64d4b623bda6e867724df5cd",
  "sharingClientId": "12345678-1234-5678-1234-567812345678",
  "user": "johndoe",
  "createdAt": "2020-08-31T16:47+00:00",
  "expiresAt": "2019-08-31T16:47+00:00",
  "dataMatchingDefinitionId": "6400955811c68a034bcef311",
  "dataSources": [
    { … }
  ],
  "dataMonitors": [
    { … }
  ],
  "features": {
    "lookup": { … },
    "updates": { … },
    "sharing": { … },
    "neverExpire": { … },
    "tagsManagedByUpsert": { … },
    "dataMirror": { … }
  },
  "numberOfCountries": "12",
  "numberOfRecords": "500",
  "countryStatistics": [
    { … }
  ],
  "originalFileHeader": [
    "BusinessPartnerId, Name, Address"
  ],
  "originalFileName": "business-partner.csv",
  "results": {
    "addressCurationReports": [ … ],
    "goldenRecordGenerationReports": [ … ],
    "resultItems": [ … ],
    "validationReports": [ … ]
  },
  "status": "FILE_IMPORTED_SUCCESSFULLY",
  "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
  "sharedWithOrganization": "true",
  "labels": [
    "Custom Storage Name"
  ]
}

Delete Storage

Request

Delete a Business Partner Storage.

Security
basicAuth
Path
storageIdstring(BusinessPartnerStorageId)required

Unique ID of a Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Query
featuresOnArray of strings(StorageDeleteFeatureParam)

Features to be activated on during deleting Business Partner Storage.

Items ValueDescription
FORCE_DATA_MIRROR

Delete the data mirror of the Business Partner Storage. This will delete all data of the Business Partner Storage and all events.

Example: featuresOn=FORCE_DATA_MIRROR
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 DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/storages/72d6900fce6b326088f5d9d91049e3e6 \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

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

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