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.

Readout_Rows [PUT, DELETE]

API calls related to individual readout rows:

Update

Destroy

Update

PUT /api/v1/vaults/<vault_id>/readout_rows/

Updates an existing readout row (including the ability to flag an existing readout row as an outlier).

This PUT Readout_Rows API call allows users to update a specified row of Protocol data, delete a specified row of Protocol data, or flag a specified row of Protocol data as an outlier.

 

Noteworthy tips:

  • The GET Protocol Data API call will be useful to ascertain the id of the readout row id for the Protocol data you wish to edit.
  • The GET Protocols API call also provides the readout definition IDs.

 

Examples

curl -H "X-CDD-Token: $TOKEN" -X PUT -H "Content-Type: application/json" -d "@data.json" https://app.collaborativedrug.com/api/v1/vaults/489978881/readout_rows/1122334455

 

File data.json used to edit a row of Protocol data:

{
   "readouts": {
   "283130": ">99",
   "283131": 77}
}

File data.json used to flag a readout value as an outlier:

{
   "readouts":
  {"640916": {"outlier": true}}
}

File data.json used to set a readout value to null:

{
  "readouts": {
    "283130": ">99",
    "283131": null}
}

Destroy

DELETE /api/v1/vaults/<vault_id>/readout_rows/

Delete a row of Protocol data.

 

Examples

Delete a row of Protocol data

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

Returns:

{"message": "Readout row with ID 753311875 has been destroyed"}