Skip to content

Data Curation API (3)

This API provides services to curate and enrich Business Partner and address data.

Address Curation
Download OpenAPI description
api-v3.json
api-v3.yaml
Overview
URL

https://www.cdq.ch/team

Sylwester Lew

sylwester.lew@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/

Production SOAP

https://api.cdq.com/data-curation/soap/v3/

Production

https://api.cdq.com/data-curation/

Batch Curation

Everything about Batch Curation

Operations

Business Partners

Everything about Business Partners

Operations

Processing Logs

Operations

Configuration

Operations

List Available Features

Request

Allows users to retrieve a list of all the available features that can be used for data curation.

Security
basicAuth
Query
pageinteger(int32)

Current page number.

Example: page=10
pageSizeinteger(int32)

Number of items per page.

Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/public/features?page=10&pageSize=10'

Responses

OK

Bodyapplication/json
numberOfPagesinteger(int32)

Number of pages.

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

Current page number.

Default 0
Example: "1"
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"
valuesArray of objects(ConfigurationFeature)

List of available Features.

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

List Available Profiles

Request

Allows users to retrieve a list of all the available Profiles with its features that can be used for data curation.

Security
basicAuth
Query
pageinteger(int32)

Current page number.

Example: page=10
pageSizeinteger(int32)

Number of items per page.

Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/public/profiles?page=10&pageSize=10'

Responses

OK

Bodyapplication/json
numberOfPagesinteger(int32)

Number of pages.

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

Current page number.

Default 0
Example: "1"
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"
valuesArray of objects(ConfigurationProfile)

List of available Profiles.

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

List Available Concepts

Request

Allows users to retrieve a list of all the available concepts that can be used for data curation.

Security
basicAuth
Query
pageinteger(int32)

Current page number.

Example: page=10
pageSizeinteger(int32)

Number of items per page.

Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/public/outputcharsets/concepts?page=10&pageSize=10'

Responses

OK

Bodyapplication/json
numberOfPagesinteger(int32)

Number of pages.

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

Current page number.

Default 0
Example: "1"
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"
valuesArray of objects(ConfigurationConcept)

List of available Concepts.

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

List Available Character Sets

Request

Allows users to retrieve a list of all the available character sets that can be used for data curation.

Security
basicAuth
Query
pageinteger(int32)

Current page number.

Example: page=10
pageSizeinteger(int32)

Number of items per page.

Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/public/outputcharsets/charactersets?page=10&pageSize=10'

Responses

OK

Bodyapplication/json
numberOfPagesinteger(int32)

Number of pages.

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

Current page number.

Default 0
Example: "1"
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"
valuesArray of objects(ConfigurationCharacterSet)

List of available Character Sets.

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

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

Default null
Example: defaultConfiguration=true
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/public/configurations/businesspartnercuration?startAfter=5712566172571652&limit=100&defaultConfiguration=true'

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 Curation Configuration

Request

Allows users to create a new configuration for Data Curation.

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(DataCurationConfiguration)

Allows users to configure Data Curation settings.

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-curation-api/api-v3/public/configurations/businesspartnercuration \
  -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": {
      "contextConfigurations": [
        {
          "context": {
            "country": {
              "shortName": "CH",
              "value": "Switzerland"
            }
          },
          "addressCurationLevelThreshold": "0.5",
          "outputLanguageTechnicalKey": "DE",
          "outputCharsets": [
            {
              "concept": "ADDRESS",
              "charset": "LATIN"
            }
          ],
          "profile": "STANDARD",
          "featuresOn": [
            "ENRICH_ADDRESS"
          ],
          "featuresOff": [
            "ENRICH_ADDRESS"
          ],
          "addressDataSources": {
            "primaryAddressDataSource": {
              "technicalKey": "HERE",
              "threshold": "0.4"
            },
            "secondaryAddressDataSources": [
              {
                "technicalKey": "HERE",
                "threshold": "0.4"
              }
            ]
          },
          "numberSeparator": {
            "value": ","
          },
          "inputAddressConceptsIgnored": [
            "BUILDING"
          ]
        }
      ],
      "goldenRecordSettings": {
        "dataSources": [
          {
            "countryScope": {
              "shortName": "CH",
              "value": "Switzerland"
            },
            "primaryDataSource": {
              "technicalKey": "BR_RF"
            },
            "secondaryDataSources": [
              {
                "technicalKey": "BR_RF"
              }
            ],
            "otherDataSources": [
              {
                "technicalKey": "BR_RF"
              }
            ],
            "unallowedDataSources": [
              {
                "technicalKey": "BR_RF"
              }
            ]
          }
        ]
      }
    },
    "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
configurationobject(DataCurationConfiguration)

Allows users to configure Data Curation settings.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

User or Client UUID which modified the resource.

Example: "76248934691294444"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
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,
  "configuration": {
    "contextConfigurations": [ … ],
    "goldenRecordSettings": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "76248934691294444",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read 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-curation-api/api-v3/public/configurations/businesspartnercuration/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
configurationobject(DataCurationConfiguration)

Allows users to configure Data Curation settings.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

User or Client UUID which modified the resource.

Example: "76248934691294444"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
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,
  "configuration": {
    "contextConfigurations": [ … ],
    "goldenRecordSettings": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "76248934691294444",
  "createdBy": "76248934691294444",
  "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(DataCurationConfiguration)

Allows users to configure Data Curation settings.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/public/configurations/businesspartnercuration/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "My configuration",
    "configuration": {
      "contextConfigurations": [
        {
          "context": {
            "country": {
              "shortName": "CH",
              "value": "Switzerland"
            }
          },
          "addressCurationLevelThreshold": "0.5",
          "outputLanguageTechnicalKey": "DE",
          "outputCharsets": [
            {
              "concept": "ADDRESS",
              "charset": "LATIN"
            }
          ],
          "profile": "STANDARD",
          "featuresOn": [
            "ENRICH_ADDRESS"
          ],
          "featuresOff": [
            "ENRICH_ADDRESS"
          ],
          "addressDataSources": {
            "primaryAddressDataSource": {
              "technicalKey": "HERE",
              "threshold": "0.4"
            },
            "secondaryAddressDataSources": [
              {
                "technicalKey": "HERE",
                "threshold": "0.4"
              }
            ]
          },
          "numberSeparator": {
            "value": ","
          },
          "inputAddressConceptsIgnored": [
            "BUILDING"
          ]
        }
      ],
      "goldenRecordSettings": {
        "dataSources": [
          {
            "countryScope": {
              "shortName": "CH",
              "value": "Switzerland"
            },
            "primaryDataSource": {
              "technicalKey": "BR_RF"
            },
            "secondaryDataSources": [
              {
                "technicalKey": "BR_RF"
              }
            ],
            "otherDataSources": [
              {
                "technicalKey": "BR_RF"
              }
            ],
            "unallowedDataSources": [
              {
                "technicalKey": "BR_RF"
              }
            ]
          }
        ]
      }
    }
  }'

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
configurationobject(DataCurationConfiguration)

Allows users to configure Data Curation settings.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

User or Client UUID which modified the resource.

Example: "76248934691294444"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
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,
  "configuration": {
    "contextConfigurations": [ … ],
    "goldenRecordSettings": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "76248934691294444",
  "createdBy": "76248934691294444",
  "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-curation-api/api-v3/public/configurations/businesspartnercuration/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4?transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2&featuresOn=CREATE_TRANSACTION'

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
configurationobject(DataCurationConfiguration)

Allows users to configure Data Curation settings.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

User or Client UUID which modified the resource.

Example: "76248934691294444"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
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,
  "configuration": {
    "contextConfigurations": [ … ],
    "goldenRecordSettings": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "76248934691294444",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Business Partner Curation Configuration Version

Request

Read a specific version of a business partner curation 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-curation-api/api-v3/public/configurations/businesspartnercuration/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the business partner curation 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(DataCurationConfiguration)

Allows users to configure Data Curation settings.

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": {
    "contextConfigurations": [ … ],
    "goldenRecordSettings": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Cache

Operations

Addresses

Operations