Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Disable Storage Container

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
idId of the storage container
nameName 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 :

URLhttp://<host>:<port>/openspecimen/rest/ng/storage-containers/2
MethodDELETE
Requestapplication /json

Response

"success"

 

 Error Cases :

code
Applies to
Status Message
200All resourcesstorage container has been disabled successfully
401All requestsAuthorization failed, User doesn’t have Authority
404All requestsstorage container not found, storage container with given details not present in the system
500All requestsInternal server error, Encountered server error while performing operations

 

 

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com