Get the list of study roles containing particular rights
get
/ec-auth-svc/rest/v1.0/studyroles/{StudyID}/rolesRights
Retrieves the list of study roles containing particular list of rights , the result shows active/inactive status and template/custom role anc can exclude template roles.
Request
Path Parameters
-
StudyID(required): string(uuid)
Study IDExample:
ABE31741A0E945F6B827048B279F2F19
Query Parameters
-
excludeTemplateRoles: boolean
Result should exclude the template roleExample:
true -
rightToFilter:
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
array-
Array of:
object DisplayStudyRoleRightsDto
Represents a study role with rights details for display.
Nested Schema : DisplayStudyRoleRightsDto
Type:
objectRepresents a study role with rights details for display.
Show Source
-
activeStatus(required): string
Active status of the study role.Example:
Active -
rights(required): object
rights
DTO for right display information including human-readable name and identifier.
-
roleCategory(required): string
Category of the study role (e.g., SITE_SPECIFIC, STUDY_SPECIFIC).Example:
Site -
roleId(required): string
Unique identifier for the study role.Example:
B748C913E61B4B18A9B5D80F349BC8FD -
roleName(required): string
Name of the study role.Example:
Site User -
roleType(required): string
Type of the roleExample:
Runtime
Nested Schema : rights
Type:
objectDTO for right display information including human-readable name and identifier.
Show Source
-
displayName(required): string
Human-readable name for this right.Example:
Create shipments to DDF -
rightName(required): string
Right name identifier.Example:
OrsSiteShipmentPost
Example:
[
{
"displayName":"Create shipments to DDF",
"rightName":"OrsSiteShipmentPost"
}
]Examples
400 Response
Bad request
Root Schema : AuthResponse
Type:
objectGeneric API response wrapper containing result, error data, response version and status.
Show Source
-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
Result data of the API response; actual type depends on the API
-
status: string
(none)
Indicates request success ("success") or failure ("failure").Example:
success -
version: integer
(int32)
Version of the response schema.Example:
1
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
objectResult data of the API response; actual type depends on the API
Example:
oracle.doceng.json.BetterJsonNull@3565a0f5