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

List Storages

Request

List all storages to which user has access to.

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
labelstring

Filter the result by the given label. Keep in mind that labels are case-sensitive.

Example: label=My Storage
includeSharedStoragesboolean

Optionally extend the result with metadata for storages that have been shared by other users of your organization. Alias for INCLUDE_SHARED_STORAGES feature.

Default false
Example: includeSharedStorages=true
sortstring

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

Example: sort=-createdAt
dataMonitorTypeTechnicalKeyArray of strings(DataMonitorTypeTechnicalKeyEnum)

Filter the result and Data Monitors by the given Type Technical Key of Data Monitor.

Items Enum ValueDescription
AUGMENTATION

Augmentation monitor returning Augmented Business Partner as a result of the curation process and raw updates from Reference Data Sources.

DATA_QUALITY_PROFILING

Data validation monitor based on the configuration provided by cusotmer providing lis tof data defects of monitored business partners.

SCREENING

Monitor for sanction & watchlist screening processes.

DUPLICATE

Monitoring detecting duplicates in customer data sources.

QUALIFICATION

Monitor for Tax Guard qualification processes.

Example: dataMonitorTypeTechnicalKey=AUGMENTATION
dataMapperDefinitionIdArray of strings(DataMapperDefinitionId)

Filter the result and Data Sources by Data Mapper Definition ID.

Example: dataMapperDefinitionId=6440dba32b30176c5917b1b7
dataTransformationDefinitionIdArray of strings(DataTransformationDefinitionId)

Filter the result and Data Sources by Data Transformation Definition ID.

Example: dataTransformationDefinitionId=SAP.ODM
havingFeatureOnArray of strings<= 1 items

Filter the result by the given feature

Example: havingFeatureOn=DATA_MIRROR
featuresOnArray of strings(BusinessPartnerStorageMetadataPageReadFeatureParam)

Features to be activated.

Items Enum ValueDescription
NUMBER_OF_TOTAL

Returns the total number of storages.

INCLUDE_SHARED_STORAGES

Returns the shared storages.

INCLUDE_SHARED_WORKSPACE_STORAGES

Returns the shared workspace storages.

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

Responses

OK

Bodyapplication/json
valuesArray of objects(BusinessPartnerStorageMetadata)

List of Business Partner Storages Metadata Page.

limitinteger(Limit)

Number of items per page.

Example: "100"
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"
totalinteger(PageTotal)

Total number of items which can be paged.

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

Create Storage

Request

If no data source is provided, a minimal data source (name=default and without mapping ID) is attached.

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/json
namestring(BusinessPartnerStorageName)<= 100 characters

Name of the Business Partner Storage.

Example: "CDQ AG"
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"
organizationIdstring

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

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"
dataSourcesArray of objects

List of Data Sources.

featuresOnArray of strings
Items Enum"LOOKUP""UPDATES""LAB_USE_INDEX_API""SHARING""DATA_MIRROR""HOMELAND""NEVER_EXPIRE""RELATIONS""TAGS_MANAGED_BY_UPSERT"
Example: ["LOOKUP"]
sharedWithOrganizationboolean

Indicates if this storage is shared with all users of the same organization.

Default false
Example: "false"
labelsArray of strings(StorageLabels)<= 10 itemsunique
Example: ["Custom Storage Name"]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/v2/storages \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "name": "string",
    "dataMatchingDefinitionId": "string",
    "dataSources": [
      {
        "dataSourceName": "string",
        "dataMapperDefinitionId": "string"
      }
    ],
    "featuresOn": [
      "LOOKUP"
    ],
    "sharedWithOrganization": false,
    "labels": [
      "string"
    ]
  }'

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"
  ]
}

Create ReferenceData Storage

Request

Create storage for Reference Data Source. Can be used only when new Reference Data Source is integrated.

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
namestring<= 50 charactersrequired

Name of the Reference Data Source.

Example: "Custom Reference Data Source Name"
dataMapperDefinitionIdstring(DataMapperDefinitionId)

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

Example: "6440dba32b30176c5917b1b7"
dataTransformationDefinitionIdstring(DataTransformationDefinitionId)

Unique identifier for a data transformation definition.

Example: "SAP.ODM"
prefixstring(Prefix)required

Additional prefix for data source name.

Example: "Custom prefix"
tagsArray of strings(schemas-Tag)<= 10 itemsunique

List of tags.

Example: ["Reporting"]
systemboolean

Indicator if is a system storage. Needed for tests.

Default true
Example: "true"
relationsboolean

Indicator if storage should have relations feature.

Default false
Example: "true"
featuresOnArray of strings(ReferenceDataStorageCreateFeature)

List of features to be activated during reference data create.

Example: ["LAB_UPDATED_BUSINESS_PARTNER"]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/v2/storages/createReferenceDataStorage \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "name": "Custom Reference Data Source Name",
    "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
    "dataTransformationDefinitionId": "SAP.ODM",
    "prefix": "Custom prefix",
    "tags": [
      "Reporting"
    ],
    "system": "true",
    "relations": "true",
    "featuresOn": [
      "LAB_UPDATED_BUSINESS_PARTNER"
    ]
  }'

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"
  ]
}

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