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.

ELN Entries [GET]

For security purposes, the GET ELN Entries CDD Vault API command documented here is only available for Vault Administrators.


GET /api/v1/vaults/<vault_id>/eln/entries


Returns a summary of all available ELN entries for the Vault specified


GET /api/v1/vaults/<vault_id>/eln/entries?async=true


Returns a zip file containing the export of all available ELN entries


Query Parameters (all optional):

 
eln_entries Comma-separated list of ELN entry IDs
author Comma separated list of ELN author IDs
Note: Must be users' IDs, users' names cannot be used
status

Returns ELN entries that have the status specified

Note: Status values are case-sensitive and are: open, submitted, or finalized

async

Boolean
If true, do an asynchronous export (see Async Export)
Use if you wish to retrieve a zip file containing exports of the actual ELN entries along with any files atatched within the ELN entries

created_before Date (YYYY-MM-DDThh:mm:ss±hh:mm)
created_after Date (YYYY-MM-DDThh:mm:ss±hh:mm)
modified_before

Date (YYYY-MM-DDThh:mm:ss±hh:mm)

Note: Uses date the ELN entry was last modified

modified_after

Date (YYYY-MM-DDThh:mm:ss±hh:mm)

Note: Uses date the ELN entry was last modified

submitted_date_before Date (YYYY-MM-DDThh:mm:ss±hh:mm)
submitted_date_after Date (YYYY-MM-DDThh:mm:ss±hh:mm)
finalized_date_before Date (YYYY-MM-DDThh:mm:ss±hh:mm)
finalized_date_after Date (YYYY-MM-DDThh:mm:ss±hh:mm)
offset The index of the first object actually returned. Defaults to 0.
page_size The maximum number of objects to return in this call when not using the async parameter. Default is 50, maximum is 1000.
projects Comma-separated list of project IDs
Defaults to all available projects
Limits scope of query

 

Notes on Date/Time 

The CDD Vault API accepts ISO 8601 date/time formats in any API call that allows a date-type parameter. For example, the full date and timestamp may be used in GET calls that support a date parameter. You may still simply provide a date-only parameter like "created_after=2020-05-20".

You may also specify a date + timestamp, like "created_after= 2020-05-20 14:53:12", to indicate "20 May 2020 14:53:12 PDT" (PDT is based on the user's time zone setting). The timestamp portion can also include a UTC (Coordinated Universal Time) offset, like "created_after= 2020-05-27T14:48:40-07:00" which indicates that the time specified is -7 hours from the UTC time.

 

Examples

curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/<vault_id>/eln/entries?eln_entries=<elnid>,<elnid>

Returns:

{
    "count"2,
    "offset"0,
    "page_size"50,
    "objects": [
        {
            "id": <elnid>,
            "name""Entry: Principles of Early Drug Discovery",
            "status""open",
            "author": {
                "id": 123,
                "first_name""Given-Name",
                "last_name""Surname"
            },
            "url""https://app.collaborativedrug.com/vaults/<vault_id>/eln/entries/<elnid>"
        },
        {
            "id": <elnid>,
            "name""Entry: Data for synthesis",
            "status""finalized",
            "author": {
                "id": 987,
                "first_name": First",
                "last_name""Last"
            },
            "url""https://app.collaborativedrug.com/vaults/<vault_id>/eln/entries/<elnid>"
        }
    ]
}

 

To retrieve a zip file containing the full exports of ELN entries:

curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/<vault_id>/eln/entries?eln_entries=<elnid>,<elnid>&async=true

Returns:

{
"id": 2980457,
"created_at": "2020-08-10T19:51:03.000Z",
"modified_at": "2020-08-10T19:51:03.000Z",
"status": "new"
}

 

Noteworthy Tips

  • To include the “author” parameter in your API call, you must provide the user ID, not a user name. Vault Administrators may discover the available user IDs in your CDD Vault using the GET Users API call.

curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/<vault_id>/users

  • The “async” parameter is required to retrieve a ZIP export of your ELN entries. As an example, this GET ELN Entries API call, when used with the async=true parameter, will return an Export ID that can subsequently be retrieved using the GET Exports API call.