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.

General API Parameters

API GET calls objects can take a variety of parameters. These are specified in the URL using standard HTTP syntax.

GET /api/v1/vaults/23/protocols?projects=24888,45466&page_size=500&offset=2000

Parameters may be specified in any order. This documentation section describes parameters that are valid for all calls; individual calls define additional ones.

General Parameters (all optional).

These two parameters define the scope of the query. The default is to query all accessible projects and none of the public datasets.

projects

comma-separated list of project ids

data_sets

comma-separated list of public dataset ids

 

General Parameters for set-retrieval calls (all optional):

async if set, do an asynchronous export (see below)
offset The index of the first object actually returned. Defaults to 0.
page_size The maximum number of objects to return in this call. Default is 50, maximum is 1000.

Asynchronous responses

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

Example:

curl -H X-CDD-Token:$TOKEN 'https://app.collaborativedrug.com/api/v1/vaults/23/protocols?async=true'

 

Result:

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

Data is then retrieved using the bulk export API (see step 2 and 3).

Date formats

Date parameters should be of the form "YYYY-MM-DD" (other formats may be accepted but are not recommended). Dates are interpreted inclusively, ie, when querying for molecules, specifying created_after=2008-01-01 will return molecules created on that date or after.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.