openspecimen/rest/ng/storage-containers/{containerIdid}
Use this resource for patch the storage 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||
|---|---|---|---|---|
| name | Container | |||
| name. It should be unique in application | ||||
| Activity Status of container | ||||
| 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||
| activityStatus | Activity status of container. | |||
| tempratureInCentigrade[Optional] | Temperature of storage container. By default it will be null | holdsCPTitles[Optinal] | Title of collection protocols to restrict specific protocol for storage.holdsSpecimenTypes[Optional] | Specimen of specified types are allowed in container |
| createdBy | User Info info object containing loginName and domainName of user, who had been created the container | |||
| oneDimensionCapacity | Max capacity of dimension one eg.30 | |||
| parentContainerName[Optional] | Parent container name. By default is will be null | |||
| siteName | Site name in which the container is present. Either either siteName or parentContainerName is mandatory. | |||
| tempratureInCentigradeparentContainerName[Optional] | Temperature of storage Parent container name. By default it is will be null.Either , 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 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>/openspecimen/rest/ng/storage-containers/{containerId}1
Use this URL to update storage container in openSpecimen application.
...
| URL | http://<host>:<port>/opespecimen/rest/ng/storage-containers/{containerId}1 |
| Method | PATCH |
| Request | application/json |
| json | { "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "createdBy" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "Freezerfreezer", "holdsCPTitles":["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" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "Freezerfreezer", "holdsCPTitles":["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 has been patched successfully |
| 400 | All requests | Invalid parameters, e.g duplicate container Namename, blank container Name name etc |
| 401 | All requests | Authorization failed, User user doesn’t have Authorityauthority |
| 404 | All requests | Container not found, container with given details not present in the system |
| 500 | All requests | Internal server error, Encountered encountered server error while performing operations |