# Data Curation API

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

Version: 3

## Servers

Production
```
https://api.cdq.com/data-curation/rest
```

## Security

### apiKey

Type: apiKey
In: header
Name: X-API-KEY

## Download OpenAPI description

[Data Curation API](https://developer.cdq.com/_bundle/apis/data-curation-api/@data-curation-api-v3/api-v3.yaml)

## Batch Curation

Everything about Batch Curation

### Start Curation Job

 - [POST /curationjobs](https://developer.cdq.com/apis/data-curation-api/api-v3/batch-curation/paths/~1curationjobs/post.md): Start a batch curation job on a given storage.

### Poll Curation Job

 - [GET /curationjobs/{id}](https://developer.cdq.com/apis/data-curation-api/api-v3/batch-curation/paths/~1curationjobs~1%7Bid%7D/get.md): After you have started a curation job, you will receive a job id in the response. {
  'id' : ``
} Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the results.

### List Business Partner Curation Results

 - [GET /v2/curationjobs/{id}/results](https://developer.cdq.com/apis/data-curation-api/api-v3/batch-curation/paths/~1v2~1curationjobs~1%7Bid%7D~1results/get.md): Retrieves curation results for particular job.

## Business Partners

Everything about Business Partners

### Curate Business Partner

 - [POST /v3/businesspartners/curate](https://developer.cdq.com/apis/data-curation-api/api-v3/business-partners/paths/~1v3~1businesspartners~1curate/post.md): Analyze and improve the quality of data through a curation process.

Curate Business Partner or address.

### Create Bulk Curation

 - [POST /v3/businesspartners/curate/bulks](https://developer.cdq.com/apis/data-curation-api/api-v3/business-partners/paths/~1v3~1businesspartners~1curate~1bulks/post.md): Create a bulk to curate multiple business partners at a time.

### Read Bulk Curation

 - [GET /v3/businesspartners/curate/bulks/{id}](https://developer.cdq.com/apis/data-curation-api/api-v3/business-partners/paths/~1v3~1businesspartners~1curate~1bulks~1%7Bid%7D/get.md): Read a bulk with multiple curated business partners.

### Cancel Bulk Curation

 - [DELETE /v3/businesspartners/curate/bulks/{id}](https://developer.cdq.com/apis/data-curation-api/api-v3/business-partners/paths/~1v3~1businesspartners~1curate~1bulks~1%7Bid%7D/delete.md): Cancel Bulk Curation

### Generate Golden Record

 - [POST /v2/businesspartners/goldenrecords/generate](https://developer.cdq.com/apis/data-curation-api/api-v3/business-partners/paths/~1v2~1businesspartners~1goldenrecords~1generate/post.md): Generate a Golden Record from a list of provided Business Partners.

## Processing Logs

### List Processing Log Results

 - [GET /v3/curationlogs/{storageId}/results](https://developer.cdq.com/apis/data-curation-api/api-v3/processing-logs/paths/~1v3~1curationlogs~1%7Bstorageid%7D~1results/get.md): Retrieves latest data curation results persisted in Processing Log.

Data is populated only when Data Monitor is configured for provided storage.

## Configuration

### List Available Features

 - [GET /features](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1features/get.md): Allows users to retrieve a list of all the available features that can be used for data curation.

### List Available Profiles

 - [GET /profiles](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1profiles/get.md): Allows users to retrieve a list of all the available Profiles with its features that can be used for data curation.

### List Available Concepts

 - [GET /outputcharsets/concepts](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1outputcharsets~1concepts/get.md): Allows users to retrieve a list of all the available concepts that can be used for data curation.

### List Available Character Sets

 - [GET /outputcharsets/charactersets](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1outputcharsets~1charactersets/get.md): Allows users to retrieve a list of all the available character sets that can be used for data curation.

### List User Configurations

 - [GET /configurations/businesspartnercuration](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1configurations~1businesspartnercuration/get.md): Allows user to retrieve their configurations for their workspace.

### Read Users Configuration

 - [GET /configurations/businesspartnercuration/{configurationId}](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1configurations~1businesspartnercuration~1%7Bconfigurationid%7D/get.md): Allows users to retrieve their configuration for their organization.

### Update Configuration

 - [PUT /configurations/businesspartnercuration/{configurationId}](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1configurations~1businesspartnercuration~1%7Bconfigurationid%7D/put.md): Allows users to update their configuration for their organization.

### Delete Configuration

 - [DELETE /configurations/businesspartnercuration/{configurationId}](https://developer.cdq.com/apis/data-curation-api/api-v3/configuration/paths/~1configurations~1businesspartnercuration~1%7Bconfigurationid%7D/delete.md): Allows to delete their configuration for their organization.