Patch Storage Container

openspecimen/rest/ng/storage-containers/{id}

Use this resource for patch the storage container. Use HTTP PATCH 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
name	Container name. It should be unique in application
barcode[Optional]	Container barcode, By default it will be null. It should be unique in application if barcode is provided
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
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 it will be `Numbers`. Available permissible values are : {numbers, alphabates upper case, alphabates lower case, roman upper case, roman lower case}
twoDimentionLabelingScheme[Optional]	By default it will be `Numbers.` Available permissible values are : {numbers, alphabates upper case, alphabates lower case, roman upper case, roman lower case}

http[s]:<host>:<port>/openspecimen/rest/ng/storage-containers/1

Use this URL to update storage container in openSpecimen 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>/`opespecimen/rest/ng/storage-containers/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": "freezer", "holdsCPTitles":["Cp1","My CP"], "holdsSpecimenTypes" : ["blood","tissue"], "comments":"Blah blah blah", "oneDimensionCapacity":10, "twoDimensionCapacity":10 }
Response	{ "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"active", "createdBy" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerName": "freezer", "holdsCPTitles":["Cp1","My CP"], "holdsSpecimenTypes" : ["blood","tissue"], "comments":"Blah blah blah", "oneDimensionCapacity":10, "twoDimensionCapacity":10, "oneDimentionalLabellingScheme ": "numbers", "twoDimentionalLabellingScheme ": "numbers" }

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 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