catissuecore/rest/ng/storage-containers/{containerId}
Use this resource for update the Storage Container. Use HTTP PUT method to call this API by passing the below details in JSON format.
containerId | id of storage container to be updated |
name | Container Name. It should be unique in application |
barcode | Container Barcode |
activityStatus | Activity Status of container |
tempratureInCentigrade | Temperature of storage container. |
createdBy | User Id who had been created the container |
siteName | Site name in which the container is present |
parentContainerName[Optional] | Parent container name. By default is will be null |
cpTitleCollection[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 |
Parameter | Details |
---|
http[s]:<host>:<port>/catissuecore/rest/ng/storage-containers/{containerId}
Use this URL to update Storage Container in caTissue application.
Result:
The response of this request will contains the details of the updated Storage Container.
Below is the example of the update Storage Container:
URL | http://<host>:<port>/ catissuecore/rest/ng/storage-containers/{containerId} |
Method | PUT |
Request | application/json |
json | { "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "createdBy" : 1, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "Freezer" "cpTitleCollection":["Cp1","My CP"], "holdsSpecimenTypes" : ["Blood","Tissue"], "comment":"Blah blah blah", "oneDimensionCapacity":10, "twoDimensionCapacity":10 } |
Response | { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "createdBy" : 1, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "Freezer" "cpTitleCollection":["Cp1","My CP"], "holdsSpecimenTypes" : ["Blood","Tissue"], "comment":"Blah blah blah", "oneDimensionCapacity":10, "twoDimensionCapacity":10 } |
Error Cases :
code | Applies to | Status Message |
---|---|---|
200 | All resources | Storage Container has been updated successfully |
400 | All requests | Invalid parameters, e.g duplicate Container Name, blank Container Name etc |
401 | All requests | Authorization failed, User doesn’t have Authority |
404 | All requests | Container not found, Container with given details not present in the system |
500 | All requests | Internal server error, Encountered server error while performing operations |