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.

Protocol(s) [GET]


GET /api/v1/vaults/<vault_id>/protocols/<id>


Returns a single protocol


GET /api/v1/vaults/<vault_id>/protocols


Returns a list of protocols based on criteria as specified by parameters:


Query Parameters (all optional):

 
protocols Comma-separated list of protocol ids
Cannot be used with other parameters
names Comma separated list of protocol names
Cannot be used with other parameters
async Boolean
If true, do an asynchronous export (see Async Export)
Use for large data sets. This is recommended any time you want to download more than page_size results.
created_before Date (YYYY-MM-DD)
created_after Date (YYYY-MM-DD)
modified_before Date (YYYY-MM-DD)
modified_after Date (YYYY-MM-DD)
plates Comma-separated list of plate ids
molecules Comma-separated list of molecule ids
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. If the response exceeds the page_size, we strongly recommend using the async option instead of downloading multiple chunks.
projects Comma-separated list of project ids
Defaults to all available projects
Limits scope of query
data_sets Comma-separated list of public dataset ids
Defaults to no data sets
Limits scope of query

 

Examples

curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/489978881/protocols/537677966

Returns:

{
  "id": 537677966,
  "class": "protocol",
  "name": "Tartine Country Loaf",
  "category": "baking",
  "data_set":
  {
    "name": "McKerrow Vault",
    "id": 489978881
  },
  "readout_definitions": [
    {
      "id": 630753459,
      "class": "readout definition",
      "name": "Shape",
      "data_type": "PickList",
      "precision_number": 3,
      "description": "The bread's shape.",
      "protocol_condition": false
    },
    {
      "id": 852435863,
      "class": "readout definition",
      "name": "Pattern",
      "data_type": "PickList",
      "precision_number": 3,
      "description": "The score pattern.",
      "protocol_condition": false
    }
  ],
  "runs": [
    {
      "id": 293172708,
      "class": "run",
      "run_date": "2017-01-13"
    }
  ],
  "projects": [
    {
      "name": "McKerrow Vault",
      "id": 938429932
    }
  ],
  "owner": "another user",
  "created_at": "2017-01-11",
  "modified_at": "2017-01-11"
}

 

To retrieve protocol details with IDs 1 and 537677966:

curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/489978881/protocols?protocols=1,537677966

Returns:

{
  "count": 2,
  "offset": 0,
  "page_size": 50,
  "objects": [
    {
      "id": 1,
      "class": "protocol",
      "name": "Falcipain-2 (rec) Ki (nM)",
      "description": "Falcipain blah blah blah",
      "category": "enzyme",
      "data_set":
      {
        "name": "McKerrow Vault",
        "id": 489978881
      },
      "readout_definitions": [
        {
          "id": 1,
          "class": "readout definition",
          "name": "IC50",
          "unit_label": "uM",
          "data_type": "Number",
          "precision_number": 3,
          "description": "Assays performed as described in Knight, Z.A. et al. Bioorg. Med. Chem. 2004, 12, 4749-4759.",
          "protocol_condition": false
        },
        {
          "id": 2,
          "class": "readout definition",
          "name": "Comment",
          "data_type": "Text",
          "description": "Investigator comment",
          "protocol_condition": false
        },
        {
          "id": 3,
          "class": "readout definition",
          "name": "Count",
          "data_type": "Number",
          "precision_type": "decimal place",
          "precision_number": 0,
          "description": "Count of something",
          "protocol_condition": false
        }
      ],
      "runs": [
        {
          "id": 1,
          "class": "run",
          "run_date": "2006-02-24",
          "person": "Barry",
          "place": "Hogan 6-120",
          "conditions": "partly cloudy"
        },
        {
          "id": 2,
          "class": "run",
          "run_date": "2007-03-09",
          "person": "Barry Botter",
          "place": "Lab 43B",
          "conditions": "not enough sleep"
        },
        {
          "id": 3,
          "class": "run",
          "run_date": "1985-09-14",
          "person": "Little Willy",
          "place": "Silver Cross Hospital",
          "conditions": "going to disneyland next week"
        }
      ],
      "projects": [
        {
          "name": "McKerrow Vault",
          "id": 938429932
        }
      ],
      "owner": "Full-Access User",
      "created_at": "2007-12-17",
      "modified_at": "2007-12-17"
    },
    {
      "id": 537677966,
      "class": "protocol",
      "name": "Tartine Country Loaf",
      "category": "baking",
      "data_set":
      {
        "name": "McKerrow Vault",
        "id": 489978881
      },
      "readout_definitions": [
        {
          "id": 630753459,
          "class": "readout definition",
          "name": "Shape",
          "data_type": "PickList",
          "precision_number": 3,
          "description": "The bread's shape.",
          "protocol_condition": false
        },
        {
          "id": 852435863,
          "class": "readout definition",
          "name": "Pattern",
          "data_type": "PickList",
          "precision_number": 3,
          "description": "The score pattern.",
          "protocol_condition": false
        }
      ],
      "runs": [
        {
          "id": 293172708,
          "class": "run",
          "run_date": "2017-01-13"
        }
      ],
      "projects": [
        {
          "name": "McKerrow Vault",
          "id": 938429932
        }
      ],
      "owner": "another user",
      "created_at": "2017-01-11",
      "modified_at": "2017-01-11"
    }
  ]
}