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.

Vaults [GET]

Prior to making API calls to export data, it can be useful to retrieve information describing the sources of data available. This data can be used to populate, for example, drop-down menus in a user interface.  In this section, calls that return available vaults, saved searches, projects, and public data sets are described.


The responses to all calls in this section is a JSON array; each element is a dictionary with id and name fields.  e.g.

[{"name":"Large Pharma Vault", "id":1343434},
 {"name":"Narcolepsy Vault", "id":3812}]

In the calls below, $VAULT_ID should be replaced with a numeric vaultID value.

Examples here are given using the command line tool curl, but should work with any HTTP client program or library. The -H argument to curl specifies an extra heading in the HTTP request that contains the API token (substitute $TOKEN with the actual token).

 

Get list of accessible vaults (note that this call, unlike the others, does not take a vault id parameter):

GET /api/v1/vaults

Example:

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


Result:

[{"name":"Pharmaco Vault","id":23},

{"name":"My Sandbox Vault","id":489978881}]

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.