Versions Compared

Key

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

catissuecoreopenspecimen/rest/ng/roles

Use this resource to create new role in the caTissue openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.

...

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>/catissuecoreopenspecimen/rest/ng/roles

Use this URL to add role in caTissue openSpecimen application.

Result:

The response of this request will contains the details of the created role.

Below is the example of the create role:

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

Response

{

    "id" : "1",

    "name":"Scientiest",

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

 

...

code
Applies to
Status Message
200All resourcesRole has been created successfully
400All requestsInvalid parameters, e.g  duplicate Role Namerole name, blank Role Name role name etc
401All requestsAuthorization failed, User user doesn’t have Authorityauthority
500All requestsInternal server error, Encountered encountered server error while performing operations

...