catissuecoreopenspecimen/rest/ng/storage-containers/{containerIdid}
Use this resource for update the Storage Containerstorage container. Use HTTP PUT method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request body:
| containerId | id of storage container to be updated Name| name. It should be unique in application |
| barcode [Optional] | Container |
BarcodetempratureInCentigrade| barcode, By default it will be null. It should be unique in application if barcode is provided |
| activityStatus | Activity Status of container |
| createdBy | User Id who had been created the container |
Temperature of storage container. By default it will be null | | Container type name. |
| siteName | Site name in which the container is present |
. Either siteName or parentContainerName is mandatory.parentContainerName |
| storageLocation [Optional] |
Parent container name. By default is will be null. Either siteName or parentContainerName is mandatory. | | holdsCPTitles[Optional] | Title of collection protocols to restrict specific protocol for storage |
| holdsSpecimenTypes[Optional] | Specimen of specified types are allowed in container |
| oneDimensionCapacity | Max capacity of dimension one eg.30 |
| twoDimensionCapacity | Max capacity of dimension two eg.30 |
| comments [optional] | Comments for container, By default it will be null |
oneDimentionLabelingScheme[Optional] | By Default it will be Numbers. Available Permissible In case of child level container, specify position of the container within parent container. | id | Identifier of the parent container | | name | Name of the parent container. | | positionX | Column position | | positionY | Row position |
|
| noOfRows | Number of rows in container |
| noOfColumns | Number of columns in conatiner |
| rowLabelingScheme [Optional] | Row labeling scheme, by default it will be Numbers. Available permissible values are : {Numbers, |
Alphabates Alphabates Alphabets Lower Case, Roman Upper Case, Roman Lower Case} |
twoDimentionLabelingScheme| columnLabelingScheme [Optional] |
By Default Column labeling scheme, by default it will |
be Numbers Permissible permissible values are : {Numbers, |
Alphabates Alphabates Alphabets Lower Case, Roman Upper Case, Roman Lower Case} |
| Details |
| temperature [Optional] | Temperature of the container. |
| storeSpecimensEnabled | Allow to store specimens in container. |
| allowedSpecimenClasses [Optional] | Allowed specimen classes to store in container |
| allowedSpecimenTypes [Optional] | Allowed specimen types to store in container |
| allowedCollectionProtocols [Optional] | Title of collection protocols to restrict specific protocol for storage |
| createdBy | User info object containing loginName and domainName of user, who had been created the container. |
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/storage-containers/{containerIdid}
Use this URL to update Storage Container storage container in caTissue openSpecimen application.
Result:
The response of this request will contains the details of the updated Storage Containerstorage container.
Below is the example of the update Storage Containerstorage container:
catissuecore| openspecimen/rest/ng/storage-containers/ |
{containerId}| 1 |
| Method | PUT |
| Request | application/json |
| json | |
Container1
"barcode":"ARKF1",
"typeName":" |
|
2-edpwesdadas-343
"activityStatus":"Active",
"siteName":"Arkansas Repository",
"storageLocation":{}, |
|
"tempratureInCentigrade":22.22,
"siteName":"My Site",
"parentContainerName": "Freezer",
"holdsCPTitles":["Cp1","My CP"],
"holdsSpecimenTypes" : ["Blood","Tissue"],
"comments":"Blah blah blah",
"oneDimensionCapacity":10,
"twoDimensionCapacity":10
}
Response | {
"loginName":"admin@admin.com",
"domain":"openspecimen",
"emailAddress":"openspecimendemo@gmail.com"
},
"noOfColumns":1,
"noOfRows":4,
"storeSpecimensEnabled":true,
"childContainers":null,
"temperature":-80,
"columnLabelingScheme":"Numbers","rowLabelingScheme":"Numbers",
"comments":null,
"allowedSpecimenClasses":["Fluid"],
"allowedSpecimenTypes":["DNA"],
"allowedCollectionProtocols":["LCP"]
} |
|
Response | |
Container1
"barcode":"ARKF1",
"typeName":" |
|
2-edpwesdadas-343
"activityStatus":"Active",
"siteName":"Arkansas Repository",
"storageLocation":{}, |
|
,"tempratureInCentigrade":22.22,
"siteName":"My Site",
"parentContainerName": "Freezer",
"holdsCPTitles":["Cp1","My CP"],
"holdsSpecimenTypes" : ["Blood","Tissue"],
"comments":"Blah blah blah",
"oneDimensionCapacity":10,
"twoDimensionCapacity":10,
"oneDimentionalLabellingScheme ,
"firstName":"Admin",
"lastName":"Admin",
"loginName":"admin@admin.com",
"domain":"openspecimen",
"emailAddress":"openspecimendemo@gmail.com",
"instituteName":null,
"admin":true,
"manageForms":false,
"cpCount":0,
"creationDate":null
},
"noOfColumns":1,
"noOfRows":4,
"freePositions":0,
"storeSpecimensEnabled":false,
"childContainers":null,
"temperature":-80,
"columnLabelingScheme":"Numbers", |
|
twoDimentionalLabellingScheme rowLabelingScheme":"Numbers |
|
"",
"comments":null,
"allowedSpecimenClasses":["Fluid"],
"calcAllowedSpecimenClasses":["Fluid"],
"allowedSpecimenTypes":["DNA"],
"calcAllowedSpecimenTypes":["DNA"],
"allowedCollectionProtocols":["LCP"],
"calcAllowedCollectionProtocols":["LCP"],
"occupiedPositions":[1,2,3,4]
} |
|
Error Cases :
Storage Container | Storage container has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate |
Container Name Container Name | container name etc |
| 401 | All requests | Authorization failed, |
User Authority| authority |
| 404 | All requests | Container not found, |
Container | container with given details not present in the system |
| 500 | All requests | Internal server error, |
Encountered | encountered server error while performing operations |