Page Comparison

Use of POST openspecimen/rest/ng/specimens/collect

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

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

Parameter Details :The aliquot

creation This API takes the following parameters in json request :accepts the array of aliquots details in JSON format. Each element in array is considered as single aliquot.

Below are parameters for single aliquot detail.

Parameter

Details

noOfAliquots

Number of aliquots to create from specimen

quantityPerAliquotlabel

Label given to aliquot.

initialQty

Specimen quantity to create

each

aliquot

Positions

List of positions to store created aliquot.

List Contains

containerName

.

visitId

Visit id under which the parent specimen is present.

parentId

Parent specimen id of which aliquot will be created.

storageLocation [optional]

Storage location to store the created aliquot.

The location detail is also a JSON object, which contains :

name	Name of Container
positionX [optional]	X Position in container
positionY [optional]	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.

lineage

This property value should be "Aliquot". This property is used to show that we want to create aliquot of specimen.

status

This value shows the aliquot status. This value should be "Collected".

createdOn

The date:time on which the aliquot is created.

closeAfterChildrenCreation [optional]

This is boolean property. Possible values are true, false.

If value is present on parent specimen detail object then the parent specimen will be closed after aliquots are created.

children

This is the JSON array of specimen details object.

If we are specifying the the closeAfterChildrenCreation option to close the parent specimen then the children array will contain the object of aliquots details which needs to be created.

specimenPool

This is the JSON array of specimen detail object.

This object contains the details of specimens.

Result :

Response of this request contains list array of created aliquots. If parent specimen is closed then parent specimen detail object with created aliquot details in children array.

API Example :

URL

http://<host>:<port>/catissuecore/

openspecimen/rest/ng/specimens/

{specimenId}/aliquots

collect
Request	application/json
Method	POST
json	[ { "initialQty":"10",

"count

"label":"label1",

"visitId":1,

"storageLocation":{"name":"Fluid Container"},

"parentId":1,

"quantityPerAliquot":2

"lineage":"Aliquot",

"status":"Collected",

"createdOn":"2015-12-03T04:37:03.779Z",

"children":[],

"

positions

specimensPool":[]

},

{

"

containerName

initialQty":"

cont1

10",

"

position1

label":"

X","position2

label2",

"visitId":1,

"storageLocation":{"name":"

Y

Fluid Container"},

{"containerName

"parentId":1,

"lineage":"

cont2

Aliquot",

"

position1

status":"

X

Collected",

"

position2

createdOn":"

Y"}

2015-12-03T04:37:03.779Z",

"children":[],

"specimensPool":[]

}

]

Response

{

[
{
"id": 12,
"cpId": 1,
"cprId": 1,
"eventId": null,
"visitId": 1,
"

tissueSite

visitName": "

S1

first visit",
"

tissueSide

cpShortTitle": "

Tissue

blood",
"

pathologicalStatus"lineage

reqId":

"Not Specified",

null,
"sortOrder": null,
"label": "

Aliquot

label1",
"

initialQuantity

barcode":

2

null,
"

availableQuantity

type":

2

"Whole Blood",
"specimenClass": "

Tissue

Fluid",
"

specimenType

lineage": "

Fresh Tissue

Aliquot",
"

concentrationInMicrogramPerMicroliter

anatomicSite": "

1

Autonomic nervous system, NOS",
"

label

laterality": "

29_1

Not Applicable",
"

activityStatus

status": "

Active"

Collected",
"reqLabel": null,
"

isAvailable

pathology": "

true

Malignant, Pre-Invasive",
"

barcode

initialQty":

" 1111",

"comment": null,

"createdOn": "04-04-2014 ",

"collectionStatus": " Collected",

"specimenCollectionGroup": {

10,
"availableQty": 10,
"available": true,
"concentration": 10,
"parentId": 1,
"parentLabel": "blood1",
"storageLocation":
{
"id": 1,
"name": "Fluid Container",
"positionX": "

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": ""}

7",
"positionY": "A"
},
"storageType": null,
"collectionContainer": null,
"activityStatus": "Active",
"createdOn": 1449117420000,
"code": null,
"distributed": null,
"collectionEvent": null,
"receivedEvent": null,
"labelFmt": null,
"biohazards":
[
],
"comments": null,
"closeAfterChildrenCreation": null,
"children":
[
],
"pooledSpecimenId": null,
"pooledSpecimenLabel": null,
"specimensPool": null,
"closeParent": null,
"poolSpecimen": null,
"extensionDetail": null
},
{
"id": 13,
"cpId": 1,
"cprId": 1,
"eventId": null,
"visitId": 1,
"visitName": "first visit",
"cpShortTitle": "blood",
"reqId": null,
"sortOrder": null,
"label": "label2",
"barcode": null,
"type": "Whole Blood",
"specimenClass": "Fluid",
"lineage": "Aliquot",
"anatomicSite": "Autonomic nervous system, NOS",
"laterality": "Not Applicable",
"status": "Collected",
"reqLabel": null,
"pathology": "Malignant, Pre-Invasive",
"initialQty": 10,
"availableQty": 10,
"available": true,
"concentration": 10,
"parentId": 1,
"parentLabel": "blood1",
"storageLocation":
{
"id": 1,
"name": "Fluid Container",
"positionX": "8",
"positionY": "A"
},
"storageType": null,
"collectionContainer": null,
"activityStatus": "Active",
"createdOn": 1449117420000,
"code": null,
"distributed": null,
"collectionEvent": null,
"receivedEvent": null,
"labelFmt": null,
"biohazards":
[
],
"comments": null,
"closeAfterChildrenCreation": null,
"children":
[
],
"pooledSpecimenId": null,
"pooledSpecimenLabel": null,
"specimensPool": null,
"closeParent": null,
"poolSpecimen": null,
"extensionDetail": null
}
]

Response Status :

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

Versions Compared

Old Version 13

New Version Current

Key