Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Reserve Specimens

Specimens can be reserved for distribution to a project (distribution protocol) using the below API. Reserved specimens can neither be edited nor distributed to another project/distribution protocol.

API

http[s]://<host>:<port>/openspecimen/rest/ng/distribution-protocols/{dp-id}/reserved-specimens

Method

PUT

Body

{ "specimens": [ { "id": <spmn-id-1>, "cpShortTitle": <spmn-cp-1>, "label": <spmn-label-1>, "barcode": <spmn-barcode-1> }, { "id": <spmn-id-2>, "cpShortTitle": <spmn-cp-2>, "label": <spmn-label-2>, "barcode": <spmn-barcode-2> }, ... many more specimens ... ] }
  1. {dp-id} is placeholder for the ID of distribution protocol for which the specimens are to be reserved.

  2. The specimens to be reserved can be identified by any of the following mechanism:

    1. Unique specimen ID <spmn-id-1>, <spmn-id-2>

    2. CP short title and label tuple {<spmn-cp-1>, <spmn-label-1>}

    3. CP short title and barcode tuple {<spmn-cp-1>, <spmn-barcode-1>}

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com