openspecimen/rest/ng/storage-containers/{id}
or
openspecimen/rest/ng/storage-containers/name={name}
Use this resource to disable the storage container. Use HTTP DELETE 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 |
|---|---|
id | Id of the storage container |
| name | Name of storage container |
http[s]:<host>:<port>/openspecimen/rest/ng/storage-containers/{id}
or
http[s]:<host>:<port>/openspecimen/rest/ng/storage-containers/name={name}
Use this URL to disable storage container in openspecimen application.
Result:
The response of this request will contains the details of the disabled storage container.
Below is the example of the disable storage container :
| URL | http://<host>:<port>/openspecimen/rest/ng/storage-containers/2 |
| Method | DELETE |
| Request | application /json |
Response | "success" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | storage container has been disabled successfully |
| 401 | All requests | Authorization failed, User doesn’t have Authority |
| 404 | All requests | storage container not found, storage container with given details not present in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operations |