Create Aliquots

Use of this REST API is to create aliquots for given specimen.

You can create aliquots through POST URL http://<host>:<port>/catissuecore/rest/ng/specimens/{specimenId}/aliquots

Here specimenId refers to the identifier of the specimen for which you want to create aliquot

Parameter Details :

The aliquot creation API takes the following parameters in json request :

Parameter

Details

noOfAliquots

Number of aliquots to create from specimen.It is mandatory field.

quantityPerAliquot [optional]

Specimen quantity to create each aliquot.

As quantity is optional, if not given then quantity per Aliquot will be calculated as:
quantity per Aliquot = Specimen Quantity / number of Aliquots.

Positions [optional]

List of positions to store created aliquot.

List Contains

containerName	Name of Container
positionX	X Position in container
positionY	Y Position in container

As Position is optional, If not given then aliquots will be stored virtually.
If only container name is given then first available position will be allocated in specified container.If position is not available then throws error message.

Result :

Response of this request contains list of created aliquots.

API Example :

URL	`http://<host>:<port>/`catissuecore/rest/ng/specimens/{specimenId}/aliquots
Request	application/json
Method	POST
json	{ "noOfAliquots":2, "quantityPerAliquot":2, "positions":[ {"containerName":"cont1","positionX":"X","positionY":"Y"}, {"containerName":"cont2","positionX":"X","positionY":"Y"} ], }
Response	{ [ { "id":1, "tissueSite" : "S1", "tissueSide" : "Tissue", "pathologicalStatus" : "Not Specified", "lineage": "Aliquot", "initialQuantity": 2, "availableQuantity": 2, "specimenClass": "Tissue", "specimenType": "Fresh Tissue", "concentrationInMicrogramPerMicroliter": " 1", "label": "29_1", "activityStatus": "Active", "isAvailable": "true", "barcode": " 1111", "comment": null, "createdOn": "04-04-2014 ", "collectionStatus": " Collected", "specimenCollectionGroup": {"id": 1, "name": "TestSCG", ...}, "biohazardCollection": {"id":1 , "name": "RadioActive" , "type" : "RadioActive"}, "externalIdentifierCollection": {"id": 1, "name": "", "value": ""} }, { "id":2, "tissueSite" : "S1", "tissueSide" : "Tissue", "pathologicalStatus" : "Not Specified", "lineage": "Aliquot", "initialQuantity": 2, "availableQuantity": 2, "specimenClass": "Tissue", "specimenType": "Fresh Tissue", "concentrationInMicrogramPerMicroliter": " 1", "label": "29_1", "activityStatus": "Active", "isAvailable": "true", "barcode": " 1111", "comment": null, "createdOn": "04-04-2014 ", "collectionStatus": " Collected", "specimenCollectionGroup": {"id": 1, "name": "TestSCG", ...}, "biohazardCollection": {"id":1 , "name": "RadioActive" , "type" : "RadioActive"}, "externalIdentifierCollection": {"id": 1, "name": "", "value": ""} } ]

Response Status :

code	Applies to	Status Message
200	All resources	Aliquots has been created successfully
400	All requests	Invalid parameters, like noOfAliquots should be greater than 0, Insufficient parent quantity,Specified container has no space to store aliquots
401	All requests	Authorization failed, User doesn't have Authority to create Aliquot
500	All requests	Internal server error, Encountered server error while performing operations