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

Roll Event Store

Request

Roll Event Store for Business Partner Storage

This endpoint facilitates the transition to a new event store for Business Partner Storage. The process involves several key steps: Validation: Ensure that the collection associated with previousEventStoreId does not exist. If it does, rolling to a new event store is prohibited. Creation: Establish a new collection intended to store events for the Business Partner Storage's event store. Backup: Safeguard the current eventStoreId by storing it as previousEventStoreId within the Business Partner Storage Metadata. Assignment: Update the Business Partner Storage Metadata by setting the new collection ID as the eventStoreId. Preservation: Retain the previousEventStoreId without dropping it, as it is now prepared for backup.

This endpoint ensures a smooth transition while maintaining the integrity and accessibility of historical event data.

Security
basicAuth
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/v2/storages/72d6900fce6b326088f5d9d91049e3e6/eventstore/roll

Responses

OK

Bodyapplication/json
statusobject(Status)

Details about status or error of a service

newEventStoreIdstring(EventStoreId)

Internal ID of Event Store.

Example: "72d6900fce6b326123f5d9d91049e3e6"
previousEventStoreIdstring(EventStoreId)

Internal ID of Event Store.

Example: "72d6900fce6b326123f5d9d91049e3e6"
Response
application/json
{
  "status": {
    "code": "200",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2019-08-31T16:47+00:00"
  },
  "newEventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
  "previousEventStoreId": "72d6900fce6b326123f5d9d91049e3e6"
}

List Update Monitors' Data Sources

Request

List all data sources available for update monitoring.

Security
basicAuth
Query
featuresOnArray of strings(UpdateMonitoringReferenceDataSourcesReadFeatureParam)

Features to be activated.

Items ValueDescription
FETCH_ACTIVATION_STATUS

Returns information which data source is inactive for the organization.

Example: featuresOn=FETCH_ACTIVATION_STATUS
organizationIdstring(OrganizationId)

List all data source available for a given organizationId. If not given organization id is taken from security context. Only system clients and cdq administrators are allowed to use this option.

Example: organizationId=cdq_monitor
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/updatemonitors/referencedatasources \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
referenceDataSourcesArray of objects(ReferenceDataSource)

List of Reference Data Sources.

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

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/jsonrequired
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"
dataSourcesArray of objects(BusinessPartnerStorageDataSourceCreate)

List of Data Sources.

featuresOnArray of strings(BusinessPartnerStorageFeatureParam)

Available features of a storage.

Items Enum ValueDescription
LOOKUP

Enables search capabilities for the given storage.

UPDATES

Enables storing and querying of updates for the given storage.

SHARING

Enables storage to participate in the CDQ sharing process.

DATA_MIRROR

Defines storage as a Data Mirror. Turns on - NEVER_EXPIRE, LOOKUP, UPDATES, SHARING features. SHARING is not applied when records are not disclosed.

HOMELAND

Defines storage as a Homeland Data Mirror. Turns on - DATA_MIRROR feature including its features.

NEVER_EXPIRE

Specifies whether a storage should never expire. Always turned on for DATA_MIRROR. Caution - don't use too often due to quota limits.

RELATIONS

Enables storage to contain relations.

TAGS_MANAGED_BY_UPSERT

Tags are accepted from upsert, not via dedicated endpoints. Allowed only when storage does not have HOMELAND activated.

Example: ["LOOKUP"]
tagsArray of strings(StorageTag)<= 10 itemsunique
Example: ["Custom Tag"]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/v3/storages \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "name": "CDQ AG",
    "dataMatchingDefinitionId": "6400955811c68a034bcef311",
    "dataSources": [
      {
        "name": "Internal customers",
        "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
        "dataTransformationDefinitionId": "SAP.ODM"
      }
    ],
    "featuresOn": [
      "LOOKUP"
    ],
    "tags": [
      "Custom Tag"
    ]
  }'

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"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
organizationobject(BusinessPartnerStorageMetadataOrganization)

Your organization to which Business Partner storage is assigned.

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"
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.

featuresobject(FeatureStatuses)

List of the feature statuses.

tagsArray of strings(StorageTag)<= 10 itemsunique

List of tags.

Example: ["Custom Tag"]
Response
application/json
{
  "id": "648824a691d8d2503d65103e",
  "name": "CDQ AG",
  "createdBy": "76248934691294444",
  "organization": {
    "id": "cdq_monitor"
  },
  "workspaceId": "64d4b623bda6e867724df5cd",
  "createdAt": "2020-08-31T16:47+00:00",
  "expiresAt": "2019-08-31T16:47+00:00",
  "dataMatchingDefinitionId": "6400955811c68a034bcef311",
  "dataSources": [
    { … }
  ],
  "features": {
    "lookup": { … },
    "updates": { … },
    "relations": { … },
    "sharing": { … },
    "neverExpire": { … },
    "tagsManagedByUpsert": { … },
    "dataMirror": { … },
    "dnb": { … },
    "sgw": { … },
    "monitor": { … },
    "system": { … },
    "cx": { … }
  },
  "tags": [
    "Custom Tag"
  ]
}

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