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

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

Find User Configurations

Request

Allows user to retrieve their configurations for their workspace.

Security
basicAuth
Query
startAfterstring(StartAfter)

Used to retrieve the next page of results.

Example: startAfter=5712566172571652
limitinteger(Limit)

Number of items per page. Maximum 100 items can be returned in one page.

Example: limit=100
defaultConfigurationboolean

Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.

Example: defaultConfiguration=true
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/configurations/updateclassification

Responses

Successful operation

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

Total number of items which can be paged.

Example: "67"
valuesArray of objects(WorkspaceConfigurationSearchResult)

List of Workspace Configurations.

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

Create Configuration

Request

Allows users to create a new configuration.

Security
basicAuth
Bodyapplication/json
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
featuresOnArray of strings(TransactionFeaturesOn)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

Example: ["CREATE_TRANSACTION"]
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring

The name of the configuration.

Example: "My configuration"
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/configurations/updateclassification \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "My configuration",
    "configuration": {
      "updateClassificationRules": [
        {
          "url": "http://meta.cdq.com/Feature/data_clinic/update_classification/rule_000035",
          "technicalKey": "UPDATE_RULE_000035",
          "shortDescription": "Custom rule for classification",
          "targetConcepts": [
            "NAME"
          ],
          "conceptFilter": [
            "LOCAL_NAME"
          ],
          "countryShortNames": [
            "CH"
          ],
          "actions": [
            "ADDED"
          ],
          "ruleType": "FILTER",
          "filter": "REGEX_MATCH",
          "threshold": "[0.0 : 0.9)",
          "classification": "MAJOR",
          "configuration": "{}",
          "executionScope": "DEFAULT",
          "dataSourceTechnicalKeys": [
            "VIES"
          ],
          "dataSourceTechnicalKeysExclusions": [
            "VIES"
          ]
        }
      ]
    },
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "configuration": {
    "updateClassificationRules": [ … ]
  },
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Find Users Configuration

Request

Allows users to retrieve their configuration for their organization.

Security
basicAuth
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/configurations/updateclassification/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

Successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "configuration": {
    "updateClassificationRules": [ … ]
  },
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update Configuration

Request

Allows users to update their configuration for their organization.

Security
basicAuth
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
featuresOnArray of strings(TransactionFeaturesOn)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

Example: ["CREATE_TRANSACTION"]
namestring

The name of the configuration.

Example: "My configuration"
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/configurations/updateclassification/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "My configuration",
    "configuration": {
      "updateClassificationRules": [
        {
          "url": "http://meta.cdq.com/Feature/data_clinic/update_classification/rule_000035",
          "technicalKey": "UPDATE_RULE_000035",
          "shortDescription": "Custom rule for classification",
          "targetConcepts": [
            "NAME"
          ],
          "conceptFilter": [
            "LOCAL_NAME"
          ],
          "countryShortNames": [
            "CH"
          ],
          "actions": [
            "ADDED"
          ],
          "ruleType": "FILTER",
          "filter": "REGEX_MATCH",
          "threshold": "[0.0 : 0.9)",
          "classification": "MAJOR",
          "configuration": "{}",
          "executionScope": "DEFAULT",
          "dataSourceTechnicalKeys": [
            "VIES"
          ],
          "dataSourceTechnicalKeysExclusions": [
            "VIES"
          ]
        }
      ]
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "configuration": {
    "updateClassificationRules": [ … ]
  },
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Delete Configuration

Request

Allows to delete their configuration for their organization.

Security
basicAuth
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Query
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2
featuresOnArray of strings(TransactionFeatureParam)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

Example: featuresOn=CREATE_TRANSACTION
curl -i -X DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/configurations/updateclassification/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

OK.

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "configuration": {
    "updateClassificationRules": [ … ]
  },
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Update Classification Configuration Version

Request

Read a specific version of an update classification configuration by id and version number.

Security
basicAuth
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
versionintegerrequired

Version number of the configuration.

Example: 1
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/configurations/updateclassification/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the update classification configuration version. Not to be confused with the configuration ID.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring

The name of the configuration

Example: "Configuration Name"
configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(UpdateClassificationConfiguration)

Model that allows customization of update classification rules.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

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

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-22T13:45+00:00"
createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"
modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "updateClassificationRules": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Event Store

Operations

CDQ Community Pool

Operations