# Data Clinic API This API provides services for Data Clinic Version: 2 ## Servers Production ``` https://api.cdq.com/data-clinic/rest ``` ## Security ### apiKey Type: apiKey In: header Name: X-API-KEY ## Download OpenAPI description [Data Clinic API](https://developer.cdq.com/_spec/apis/data-clinic-api/@data-clinic-api-v2/api-v2.yaml) ## 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. ### List Storage's Decisions - [GET /storages/{storageId}/decisions](https://developer.cdq.com/apis/data-clinic-api/api-v2/decision-log/paths/~1storages~1%7Bstorageid%7D~1decisions/get.md): Read decisions from given storage. ### Upsert Decisions - [POST /storages/{storageId}/decisions](https://developer.cdq.com/apis/data-clinic-api/api-v2/decision-log/paths/~1storages~1%7Bstorageid%7D~1decisions/post.md): Upsert decisions for given storage. Decisions are distinguished by business partner id and type. Already existing decision will be replaced. ### Clear Decisions - [POST /storages/{storageId}/decisions/clear](https://developer.cdq.com/apis/data-clinic-api/api-v2/decision-log/paths/~1storages~1%7Bstorageid%7D~1decisions~1clear/post.md): Deletes decisions of a given type. Delete all if type not provided. ### Delete Decisions - [POST /storages/{storageId}/decisions/delete](https://developer.cdq.com/apis/data-clinic-api/api-v2/decision-log/paths/~1storages~1%7Bstorageid%7D~1decisions~1delete/post.md): Deletes decisions of a given ids. ### Import Curation Decision - [POST /jobs/curationdecisionimportjobs](https://developer.cdq.com/apis/data-clinic-api/api-v2/decision-log/paths/~1jobs~1curationdecisionimportjobs/post.md): Starts curation decision import job ### Poll Curation Decision Import Job - [GET /jobs/curationdecisionimportjobs/{jobId}](https://developer.cdq.com/apis/data-clinic-api/api-v2/decision-log/paths/~1jobs~1curationdecisionimportjobs~1%7Bjobid%7D/get.md): Poll curation decision import job. ## 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. ### Read Augmented Business Partner - [POST /v2/storages/{storageId}/datasources/{dataSourceId}/augmentedbusinesspartners/fetch](https://developer.cdq.com/apis/data-clinic-api/api-v2/augmented-business-partners/paths/~1v2~1storages~1%7Bstorageid%7D~1datasources~1%7Bdatasourceid%7D~1augmentedbusinesspartners~1fetch/post.md): Read an Augmented Business Partner from a given Data Source. ### List Augmented Business Partners - [GET /v2/storages/{storageId}/augmentedbusinesspartners](https://developer.cdq.com/apis/data-clinic-api/api-v2/augmented-business-partners/paths/~1v2~1storages~1%7Bstorageid%7D~1augmentedbusinesspartners/get.md): Read a page of Augmented Business Partners from a given storage. ## Augmented Configuration Properties Used to define and manipulate the settings, which include various parameters and configurations for the augmentation of Business Partners. ### List Lookup Features - [GET /configurations/augmentation/lookup/features](https://developer.cdq.com/apis/data-clinic-api/api-v2/augmented-configuration-properties/paths/~1configurations~1augmentation~1lookup~1features/get.md): Retrieve a list of available features for lookup settings. ### List Fetch Features - [GET /configurations/augmentation/fetch/features](https://developer.cdq.com/apis/data-clinic-api/api-v2/augmented-configuration-properties/paths/~1configurations~1augmentation~1fetch~1features/get.md): Retrieve a list of available features for fetch settings. ### List Curation Features - [GET /configurations/augmentation/curation/features](https://developer.cdq.com/apis/data-clinic-api/api-v2/augmented-configuration-properties/paths/~1configurations~1augmentation~1curation~1features/get.md): Retrieve a list of available features for curation settings. ### List Curation Profiles - [GET /configurations/augmentation/curation/profiles](https://developer.cdq.com/apis/data-clinic-api/api-v2/augmented-configuration-properties/paths/~1configurations~1augmentation~1curation~1profiles/get.md): Retrieve a list of available profiles for curation settings. ## Configuration Used to create, read, update, and delete the configurations, which define the settings for the augmentation process of Business Partners. ### List Augmentation Configurations - [GET /configurations/augmentation](https://developer.cdq.com/apis/data-clinic-api/api-v2/configuration/paths/~1configurations~1augmentation/get.md): Read augmentation configurations of this workspace. ### Create Augmentation Configuration - [POST /configurations/augmentation](https://developer.cdq.com/apis/data-clinic-api/api-v2/configuration/paths/~1configurations~1augmentation/post.md): Endpoint to create a new augmentation configuration. ### Read Augmentation Configuration - [GET /configurations/augmentation/{configurationId}](https://developer.cdq.com/apis/data-clinic-api/api-v2/configuration/paths/~1configurations~1augmentation~1%7Bconfigurationid%7D/get.md): Endpoint to retrieve an augmentation configuration based on its ID. ### Update Augmentation Configuration - [PUT /configurations/augmentation/{configurationId}](https://developer.cdq.com/apis/data-clinic-api/api-v2/configuration/paths/~1configurations~1augmentation~1%7Bconfigurationid%7D/put.md): Endpoint to update an existing augmentation configuration. ### Delete Augmentation Configuration - [DELETE /configurations/augmentation/{configurationId}](https://developer.cdq.com/apis/data-clinic-api/api-v2/configuration/paths/~1configurations~1augmentation~1%7Bconfigurationid%7D/delete.md): Endpoint to delete an existing augmentation configuration. ### Read Augmentation Configuration Version - [GET /configurations/augmentation/{configurationId}/versions/{version}](https://developer.cdq.com/apis/data-clinic-api/api-v2/configuration/paths/~1configurations~1augmentation~1%7Bconfigurationid%7D~1versions~1%7Bversion%7D/get.md): Read a specific version of an augmentation configuration by id and version number. ## Business Partners ### Confirm Business Partner - [POST /v2/businesspartners/confirm](https://developer.cdq.com/apis/data-clinic-api/api-v2/business-partners/paths/~1v2~1businesspartners~1confirm/post.md): BETAConfirms the validity of a trading partner by checking the provided data against various CDQ services.