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.
Below are the attributes which need to be sent in the request body:
Parameter | Details |
---|---|
institute Id | Identifier of institute to Update |
name | Institute name |
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 | { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerDetails":{ "name":"Freezer", "barcode":"2-edpwesdadas", "activityStatus":"Active", "specimenPositionDetails":[], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":10, "twoDimensionCapacity":10 } }, "specimenPositionDetails":[ { "id" : 1, "specimenName":"Myspecimen1", "positionDimensionOne":1, "positionDimensionTwo":2, "positionDimensionOneString":"row", "positionDimensionTwoString":"column" } ], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":10, "twoDimensionCapacity":10} } |
Response | { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerDetails":{ "name":"Freezer", "barcode":"2-edpwesdadas", "activityStatus":"Active", "specimenPositionDetails":[], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":10, "twoDimensionCapacity":10 } }, "specimenPositionDetails":[ { "id" : 1, "specimenName":"Myspecimen1", "positionDimensionOne":1, "positionDimensionTwo":2, "positionDimensionOneString":"row", "positionDimensionTwoString":"column" }, { "id" : 2, "specimenName":"Myspecimen2", "positionDimensionOne":2, "positionDimensionTwo":2, "positionDimensionOneString":"row", "positionDimensionTwoString":"column" } ], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":20, "twoDimensionCapacity":20 } } |
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 |