Information submitted through the support site is private but is not hosted within your secure CDD Vault. Please do not include sensitive intellectual property in your support requests.

Async Export [GET]

API calls related to export objects:

Check Export Status 

Download Data

 

For any call made with the parameter async=true and for all saved search retrievals, you need to use the following steps to retrieve the status of your exports.

When retrieving large data sets (i.e. larger than the maximum page size), consider doing an asynchronous request. This allows you to download all requested data in one go.

A typical response for async requests is:

{
  "id": 18765',
  "status": "new"
}

 

Check Export Status

Check on the status of your export task. Repeat this call every 5-10 seconds (suggested interval) until the status is “finished”

GET /api/v1/vaults/<vault_id>/export_progress/<export_id>

Response:

Status should be one of:

new
started
finished

If it is any other value, something has gone wrong with your export.

Example:

curl -H "X-CDD-Token: $TOKEN" 'https://app.collaborativedrug.com/api/v1/vaults/23/export_progress/18765'

Result: 

{
  "id": 18765',
  "status": "finished"
}

 

Download Data

Once the file is ready (when its status “finished”), you can download the data through this URL:

GET /api/v1/vaults/<vault_id>/exports/<export_id>

Response:

File contents of the saved search export in whatever format was requested or the JSON of the async request.

If the export is not ready, the server will return HTTP status code 403 (Forbidden) and a JSON response corresponding with Check Export Status.

Example:

curl -H "X-CDD-Token: $TOKEN" 'https://app.collaborativedrug.com/api/v1/vaults/23/exports/18765'

Result:

Molecule Name,CDD Number,Arginine kinase inhibition: RFU (rfu)
Benzene,CDD-1,0.17