Skip to content

Data Clinic API (2)

This API provides services for Data Clinic

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Production

https://api.cdq.com/data-clinic/rest/

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

List Lookup Features

Request

Retrieve a list of available features for lookup settings.

Security
apiKey
Query
pageinteger(Page)>= 0

Page number.

Default 0
Example: page=1
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Page size.

Default 10
Example: pageSize=100
curl -i -X GET \
  https://api.cdq.com/data-clinic/rest/configurations/augmentation/lookup/features \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(LookupFeatureSearchResult)

List of lookup features.

Response
application/json
{
  "pageSize": "100",
  "total": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

List Fetch Features

Request

Retrieve a list of available features for fetch settings.

Security
apiKey
Query
pageinteger(Page)>= 0

Page number.

Default 0
Example: page=1
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Page size.

Default 10
Example: pageSize=100
curl -i -X GET \
  https://api.cdq.com/data-clinic/rest/configurations/augmentation/fetch/features \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(FetchFeatureSearchResult)

List of fetch features.

Response
application/json
{
  "pageSize": "100",
  "total": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

List Curation Features

Request

Retrieve a list of available features for curation settings.

Security
apiKey
Query
pageinteger(Page)>= 0

Page number.

Default 0
Example: page=1
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Page size.

Default 10
Example: pageSize=100
curl -i -X GET \
  https://api.cdq.com/data-clinic/rest/configurations/augmentation/curation/features \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(CurationFeatureSearchResult)

List of curation features.

Response
application/json
{
  "pageSize": "100",
  "total": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

List Curation Profiles

Request

Retrieve a list of available profiles for curation settings.

Security
apiKey
Query
pageinteger(Page)>= 0

Page number.

Default 0
Example: page=1
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Page size.

Default 10
Example: pageSize=100
curl -i -X GET \
  https://api.cdq.com/data-clinic/rest/configurations/augmentation/curation/profiles \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(CurationProfileSearchResult)
Response
application/json
{
  "pageSize": "100",
  "total": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

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