Skip to content

Data Clinic API (2)

This API provides services for Data Clinic

Overview
URL

https://www.cdq.com/team

Sylwester Lew

sylwester.lew@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-clinic-api/api-v2/

Production SOAP

https://api.corporate-data-league.ch/data-clinic/soap/v2/

Production

https://api.corporate-data-league.ch/data-clinic/

Decision Log

Provides services for managing decisions for Business Partners. Decisions are stored in a Decision Log and can be retrieved, upserted, cleared or deleted.

Operations

Augmented Business Partners

Represent entities enhanced with supplementary data derived from many distinct data sources, providing a comprehensive view of the Business Partner's information.

Operations

Augmented Configuration Properties

Used to define and manipulate the settings, which include various parameters and configurations for the augmentation of Business Partners.

Operations

Configuration

Used to create, read, update, and delete the configurations, which define the settings for the augmentation process of Business Partners.

Operations

Business Partners

Operations

Data Clinic

Operations

List Log's Decisions

Request

Read decisions from given decision log.

Security
basicAuth
Path
decisionLogIdstringrequired

Decision Log ID.

Example: 65dcb1d68f01e37c2cf9bbb2
Query
startAfterstring

Start after the provided pagination ID. Leave empty for the first query. The response will contain a property nextStartAfter, which needs to be used for any subsequent queries until nextStartAfter is empty. See CDQ - Developer Guidelines.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
limitinteger(int32)>= 1

Number of items to be returned on the page.

Default 500
Example: limit=100
businessPartnerIdsArray of strings(DecisionLogBusinessPartnerId)<= 500 items

Only show decisions for listed business partner IDs.

Example: businessPartnerIds=63e635235c06b7396330fe40
typestring(DecisionLogTypeTechnicalKeyParam)

Only show decisions of given type.

Enum ValueDescription
CURATIONS

Curation decisions.

NATURAL_PERSONS

Natural person decisions.

DUPLICATES

Duplicate decisions.

Example: type=CURATIONS
Headers
X-Credential-Usernamestring

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-clinic-api/api-v2/decisionlogs/65dcb1d68f01e37c2cf9bbb2/decisions

Responses

OK

Bodyapplication/json
valuesArray of objects(DecisionLogSearchResult)

List of decisions.

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

Delete Decision Log

Request

Delete decision log (for internal use only during storage deletion)

Security
basicAuth
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Headers
X-Credential-Usernamestring

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-clinic-api/api-v2/storages/72d6900fce6b326088f5d9d91049e3e6/decisionlog

Responses

OK

Response
No content