Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

catissuecore/rest/ng/storage-containers

Use this resource to create new storage container in the caTissue application. Use HTTP POST 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
nameRole Name. It should be unique in application
privilegeNames

Privilege names that comes under the role, permissible values are

{ User Provisioning, Storage Administration, Protocol Administration, Specimen Processing, Registration, Distribution, Read Denied }

description[optional]Description for role, By default it will be null

 


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

Use this URL to add storage container in caTissue application.

Result:

The response of this request will contains the details of the created storage container.

Below is the example of the create storage container:

 

URLhttp://<host>:<port>/catissuecore/rest/ng/roles
MethodPOST
Requestapplication/json
json{
    "name":"Scientiest",
    "privilegeNames" : ["User Provisioning", "Registration"]
}

Response

{

    "id" : "1",

    "name":"Scientiest",

    "privilegeNames" : ["User Provisioning", "Registration"] 
}

 

 

 Error Cases :

 

code
Applies to
Status Message
200All resourcesStorage Container has been created successfully
400All requestsInvalid parameters, e.g  duplicate Container Name, blank Container Name etc
401All requestsAuthorization failed, User doesn’t have Authority
500All requestsInternal server error, Encountered server error while performing operations

 

 

catissuecore/rest/ng/storage-containers
Use this resource to create new storage container in the caTissue application. Use HTTP POST 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
description[optional]
Description for role, By default it will be null
name
Role Name. It should be unique in application
privilegeNames
Privilege names that comes under the role, permissible values are
{ User Provisioning, Storage Administration, Protocol Administration, Specimen Processing, Registration, Distribution, Read Denied }

http[s]:<host>:<port>/catissuecore/rest/ng/storage-containers
Use this URL to add storage container in caTissue application.
Result:
The response of this request will contains the details of the created storage container.
Below is the example of the create storage container:
URL
http://<host>:<port>/catissuecore/rest/ng/storage-containers
Method
POST
Request
application/json
json
{
    "name":"Scientiest",
    "privilegeNames" : ["User Provisioning", "Registration"]
}
Response
{
    "id" : "1",
    "name":"Scientiest",
    "privilegeNames" : ["User Provisioning", "Registration"] 
}
 
 Error Cases :
code
Applies to
Status Message
200
All resources
Storage Container container has been created 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
500
All requests
Internal server error, Encountered server error while performing operations