openspecimen/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 updatedParameter | Details |
|---|---|---|
| name | Container Namename. 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 | |
| activityStatus | Activity Status status of container. | |
| tempratureInCentigrade[Optional] | Temperature of storage container. By By default it will be null. | |
| createdBy | User Info 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 | |
| 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} | |
Parameter | Details |
numbers, alphabates upper case, alphabates lower case, roman upper case, roman lower case} |
http[s]:<host>:<port>/openspecimen/rest/ng/storage-containers/{containerId}
...
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 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 encountered server error while performing operations |