Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

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

...

Parameter
Details
noOfAliquotsNumber of aliquots to create from specimen
quantityPerAliquotSpecimen quantity to create each aliquot
Positions
List of positions to store created aliquot.
List Contains

 

containerNameName of Container
positionXX Position in container
positionYY Position in container


API Example :

 

MethodURLPOST http://<host>:<port>/catissuecore/rest/ng/specimens/{specimenId}/aliquots
Requestapplication/json
MethodPOST
json

{

"count":1,

"quantityPerAliquot":2,

"positions":[

{"containerName":"cont1","position1":"X","position2":"Y"},

{"containerName":"cont2","position1":"X","position2":"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
200All resourcesAliquots has been created successfully
400All requestsInvalid parameters, like count count should be greater than 0
401All requestsAuthorization failed, User doesn’t have Authority to create Aliquot
500All requestsInternal server error, Encountered server error while performing operations