catissuecore/rest/ng/roles
Use this resource to create new role 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 |
---|---|
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/roles
Use this URL to add role in caTissue application.
Result:
The response of this request will contains the details of the created role.
Below is the example of the create role:
URL | http://<host>:<port>/ catissuecore/rest/ng/roles |
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 | Role has been created successfully |
400 | All requests | Invalid parameters, e.g duplicate Role Name, blank Role Name etc |
401 | All requests | Authorization failed, User doesn’t have Authority |
500 | All requests | Internal server error, Encountered server error while performing operations |