catissuecoreopenspecimen/rest/ng/storage-containers/{containerIdid}
Use this resource for patch the Storage Containerstorage container. Use HTTP PATCH method to call this API by passing the below details in JSON format.
...
Parameter | Details |
|---|---|
| containerId | Id of storage container to be updated |
| activityStatus | Activity Status of container |
| name | Container name. It should be unique in application |
| barcode[Optional] | Container Barcodebarcode, By default it will be null. It should be unique in application if barcode is provided |
| comments [optional] | Comments for container, By default it will be null |
| activityStatus | Activity status of container. |
| tempratureInCentigrade[Optional] | Temperature of storage container. By default it will be null. |
| createdBy | User info object containing loginName and domainName of user, who had been created the container. |
| siteName | Site name in which the container is present. either siteName or parentContainerName is mandatory. |
| parentContainerName[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 |
| createdBy | User Id who has created the container |
| name | Container Name. It should be unique in application |
| oneDimensionCapacityoneDimensionCapacity | Max capacity of dimension one eg.30 |
| twoDimensionCapacity | Max capacity of dimension one two eg.30 |
| parentContainerNamecomments [Optionaloptional] | Parent Comments for container name. , By default is it will be null |
| siteName | Site name in which the container is present |
| tempratureInCentigrade | Temperature of storage container. |
| twoDimensionCapacity | Max capacity of dimension two eg.30 |
| oneDimentionLabelingScheme[Optional] | By Default default it will be {Numbers, Alphabates Upper Case, Alphabates Lower Case, Roman Upper Case, Roman Lower Casenumbers, alphabates upper case, alphabates lower case, roman upper case, roman lower case} |
| twoDimentionLabelingScheme[Optional] | By Default default it will be {Numbers, Alphabates Upper Case, Alphabates Lower Case, Roman Upper Case, Roman Lower Case} |
numbers, alphabates upper case, alphabates lower case, roman upper case, roman lower case} |
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/storage-containers/{containerId}1
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:
| URL | http://<host>:<port>/catissuecoreopespecimen/rest/ng/storage-containers/{containerId}1 |
| Method | PATCH |
| Request | application/json |
| json | { "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "createdBy" : 1" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "Freezerfreezer", "cpTitleCollectionholdsCPTitles":["Cp1","My CP"], "holdsSpecimenTypes" : ["Bloodblood","Tissuetissue"], "comments":"Blah blah blah", "oneDimensionCapacity":10, "twoDimensionCapacity":10 } |
Response | { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Activeactive", "createdBy" : 1" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "Freezerfreezer", "cpTitleCollectionholdsCPTitles":["Cp1","My CP"], "holdsSpecimenTypes" : ["Bloodblood","Tissuetissue"], "comments":"Blah blah blah", "oneDimensionCapacity":10, "twoDimensionCapacity":10, "oneDimentionalLabellingScheme ": "Numbersnumbers", "twoDimentionalLabellingScheme ": "Numbersnumbers" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Storage Container Storage container has been patched successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Container Namecontainer name, blank Container Name container name etc |
| 401 | All requests | Authorization failed, User user doesn’t have Authorityauthority |
| 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 |