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.

Plate(s) [GET, DELETE]

API calls related to Plate objects:

Retrieve

Delete

Retrieve

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

Get a single plate.


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

Get a collection of plates. 


Note, the use of Query Parameters that are included in the URL is no longer officially supported.  While the legacy Query parameters will continue to work, users are highly encouraged to switch to the use of JSON parameters for all GET Plates API calls.

JSON Parameters (all optional):

plates Comma delimited list of plate ids
names Comma delimited list of plate names
locations Comma delimited list of plate locations
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. Note: any page_size parameter used in an API GET call that also uses the async=true parameter will be ignored. The GET call will return all valid data for the given GET call.
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. Note: any page_size parameter used in an API GET call that also uses the async=true parameter will be ignored. The GET call will return all valid data for the given GET call.
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

GET https://app.collaborativedrug.com/api/v1/vaults/489978881/plates

Passing JSON containing this parameter:

{ "plates": [1] }

Returns:

{
  "id": 1,
  "class": "plate",
  "name": "plate 1",
  "volume": 0.0,
  "concentration": 0.0,
  "statistics": [
    {
      "id": 39339139,
      "class": "plate statistics",
      "z_prime_factor": 0.844,
      "z_factor": 0.711054342932417,
      "positive_control_mean": 18670.0,
      "negative_control_mean": 123.85,
      "positive_control_standard_deviation": 947.523,
      "negative_control_standard_deviation": 13.93,
      "sample_mean": 678.7,
      "sample_standard_deviation": 785.313,
      "sample_count": 2,
      "run": 2,
      "readout_definition": 1
    },
    {
      "id": 82709074,
      "class": "plate statistics",
      "positive_control_mean": 10.0,
      "negative_control_mean": 1.0,
      "sample_count": 0,
      "run": 2,
      "readout_definition": 3
    },
    {
      "id": 174132653,
      "class": "plate statistics",
      "sample_mean": 10.0,
      "sample_count": 1,
      "run": 1,
      "readout_definition": 3
    },
    {
      "id": 867196446,
      "class": "plate statistics",
      "sample_mean": 86.7,
      "sample_count": 1,
      "run": 1,
      "readout_definition": 1
    }
  ],
  "wells": [
    {
      "row": 0,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 1,
      "plate": 1,
      "batch": 787637732
    },
    {
      "row": 0,
      "col": 2,
      "plate": 1,
      "batch": 618771089
    },
    {
      "row": 0,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 10,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 0,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 1,
      "plate": 1,
      "batch": 787637732
    },
    {
      "row": 1,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 1,
      "col": 10,
      "plate": 1,
      "batch": 858251680
    },
    {
      "row": 1,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 1,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 10,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 2,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 1,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 3,
      "col": 10,
      "plate": 1
    },
    {
      "row": 3,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 1,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 4,
      "col": 10,
      "plate": 1
    },
    {
      "row": 4,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 1,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 5,
      "col": 10,
      "plate": 1
    },
    {
      "row": 5,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 1,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 6,
      "col": 10,
      "plate": 1
    },
    {
      "row": 6,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 0,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 1,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 2,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 3,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 4,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 5,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 6,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 7,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 8,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 9,
      "plate": 1,
      "batch": 700861902
    },
    {
      "row": 7,
      "col": 10,
      "plate": 1
    },
    {
      "row": 7,
      "col": 11,
      "plate": 1,
      "batch": 700861902
    }
  ]
}

 

GET https://app.collaborativedrug.com/api/v1/vaults/489978881/plates

Passing JSON containing this parameter:

{ "plates": [2,47349766] }

Returns:

{
  "count": 2,
  "offset": 0,
  "page_size": 50,
  "objects": [
    {
      "id": 2,
      "class": "plate",
      "name": "empty plate",
      "location": "Rack 5, row 23",
      "volume": 0.0,
      "concentration": 0.0
    },
    {
      "id": 47349766,
      "class": "plate",
      "name": "plate 3",
      "volume": 0.0,
      "concentration": 0.0,
      "wells": [
        {
          "row": 0,
          "col": 32,
          "plate": 47349766,
          "batch": 700861902
        },
        {
          "row": 31,
          "col": 47,
          "plate": 47349766,
          "batch": 700861902
        }
      ]
    }
  ]
}

 

Additional examples:

GET https://app.collaborativedrug.com/api/v1/vaults/489978881/plates

Passing JSON containing this parameter:

{ "names": ["Plate 20211005", "Sample Plate 29181108"] }

 

GET https://app.collaborativedrug.com/api/v1/vaults/489978881/plates

Passing JSON containing this parameter:

{ "locations": ["Shelf A", "Box 99"] }

 

Delete

DELETE /api/v1/vaults/<vault_id>/plates/<id>

Delete a single plate.

 

 

Examples

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

Returns:

{
    "message": "Object has been destroyed"
}