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

Request File Upload

Request

Create a file in the file storage using the url provided. Maximum allowed file size is 5GB.

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
urlstringrequired

File name which will be uploaded in customer-uploads/ directory.

Example: "dq-chart.png or requestedDirectory/dq-chart.png"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/files/upload \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "url": "dq-chart.png or requestedDirectory/dq-chart.png"
  }'

Responses

OK

Bodyapplication/json
uploadLinkstring

Url to file.

Example: "https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png"
uploadMethodstring

Method of uploading file.

Example: "PUT"
expiresAtstring(ExpiresAt)

Date of expiration (ISO 8601-compliant).

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

Url to file, place where it is stored.

Example: "customer-uploads/cdlbot/dq-chart.png"
Response
application/json
{
  "uploadLink": "https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png",
  "uploadMethod": "PUT",
  "expiresAt": "2020-08-31T16:47+00:00",
  "url": "customer-uploads/cdlbot/dq-chart.png"
}

Request Files Delete

Request

Delete files in the customer-uploads directory using the provided urls.

Security
basicAuth
Query
urlArray of stringsnon-emptyrequired

Url of the file to delete.

Example: url=dq-chart.png or requestedDirectory/dq-chart.png
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/files?url=dq-chart.png+or+requestedDirectory%2Fdq-chart.png' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
resultsArray of objects(FileDeleteResult)

List of results for each file.

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

List All Resources

Request

Returns list of all resources, which are available at the specific url path.

Security
basicAuth
Query
urlstring

Path of requested directory for which resources should be listed.

Example: url=requestedDirectory/ or requestedDirectory/otherDirectory
startAfterstring

Continuation token. Encoded s3 path from which listing resources should be started.

Example: startAfter=1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u
limitinteger(int32)>= 1

Allowed maximum elements.

Default 300
Example: limit=200
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/files/resources \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
startAfterstring

Value of continuation token from the request.

Example: "1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u"
limitinteger(Limit)

Number of items per page.

Example: "100"
nextStartAfterstring

Value of continuation token required to retrieve results from next page. Should be passed in the next request as "startAfter" parameter.

Example: "1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u"
filesArray of objects(FileResource)

Array of FileResource objects.

Response
application/json
{
  "startAfter": "1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u",
  "limit": "100",
  "nextStartAfter": "1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u",
  "files": [
    { … }
  ]
}

Request File Download

Request

Download file from CDQ Cloud.

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
urlstringrequired

ID of the file.

Example: "customer-upload/user/file.xlsx"
downloadLinkAgeinteger(int64)

Number of milliseconds the download link is active.

Default 0
Example: "0"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/files/download \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "url": "customer-upload/user/file.xlsx",
    "downloadLinkAge": "0"
  }'

Responses

OK

Bodyapplication/json
urlstring

Url of file stored.

Example: "/customer-upload/file.xlsx"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Date of modification (ISO 8601-compliant).

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

Date of expiration (ISO 8601-compliant).

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

Url to file.

Example: "https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png"
downloadMethodstring

Method of uploading file.

Example: "GET"
Response
application/json
{
  "url": "/customer-upload/file.xlsx",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "expiresAt": "2020-08-31T16:47+00:00",
  "downloadLink": "https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png",
  "downloadMethod": "GET"
}

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