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.

GET Vaults, Saved Searches, Projects, Protocols and Data Sets

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, protocols 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).

 

Vaults

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}]

 

Searches

Return a list of accessible saved searches for the given vault.

GET /api/v1/vaults/$VAULT_ID/searches


Example:

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


Result:

[{"name":"triple 6 SMARTS","id":241},

{"name":"Knime demo search","id":264},

{"name":"Imantinib similarity search","id":326}]

 

Projects

Return a list of accessible projects for the given vault, including hidden projects

GET /api/v1/vaults/$VAULT_ID/projects


Example:

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

 

Result:

[{"name":"Big Exciting Project","id":2001},

{"name":"Discover Program B","id":2002}]

 

Protocols

Return a list of accessible protocols for the given vault

GET /api/v1/vaults/$VAULT_ID/protocols


Example:

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

 

 

Data Sets

Return a list of accessible public data sets for the given vault.
GET /api/v1/vaults/$VAULT_ID/data_sets

Example:

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


Result:

[{"name":"TB: Drugs and leads with targets - data used in mobile app","id":3843},

{"name":"Parasite Inhibitors via Target Repurposing - NEU","id":3798},

{"name":"DILI Search v2","id":3781},

{"name":"TB: TAACF Assay Results","id":2414},

{"name":"FDA/Orphan Drugs","id":2413}]
Have more questions? Submit a request

3 Comments

  • 0
    Avatar
    Cyrus Harmon

    It would be nice if this were updated with the API v1.1 calls so there was a single place listing the API calls for listing available objects.

  • 0
    Avatar
    Bryant Piano

    This is a comment from ZD Support. Happy May 15th!

  • 0
    Avatar
    Aaron Hundt - Zendesk

    This is a comment from ZD Support. Looks like an interesting API.

Please sign in to leave a comment.