REST API for Clinical One Platform

Get groups of permissions for a study role for a study ID

get

/ec-auth-svc/rest/v1.0/studyroles/{StudyRoleID}/study/{StudyID}/rightsgroups

Fetch all rights groups associated with a specific role for a given study. Returns all permissions and properties assigned to the study role.

Request

Path Parameters

StudyID(required): string(uuid)
UUID of the study to query. Example: "9340F1E228C34D28A16B173472BF437E"
Example:
```
9340F1E228C34D28A16B173472BF437E
```
StudyRoleID(required): string(uuid)
UUID of the study role. Example: "3D2ACEF7D4DC4A719B5F8C8649C5F96F"
Example:
```
3D2ACEF7D4DC4A719B5F8C8649C5F96F
```

Query Parameters

studyRoleType(required): string
Study role type string identifier. Example: "SITE_SPECIFIC"
Example:
```
SITE_SPECIFIC
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List of rights groups for the given study role and study.

Root Schema : schema

Type: array

Show Source

Array of: object DisplayRoleWithRightsDto

Represents a role with associated rights and additional attributes.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisplayRoleWithRightsDto"
    }
}

Nested Schema : DisplayRoleWithRightsDto

Type: object

Represents a role with associated rights and additional attributes.

Show Source

id(required): string (uuid)

The unique identifier for the role.
objectVersionNumber: number

Object version number.

Example: 3
rights: object rights

A right associated with a role. Contains the unique identifier and name of the right.
roleCategory(required): string

Category to which the role belongs.

Example: STUDY_SPECIFIC
roleName(required): string

Name of the role.

Example: Rule Designer
roleSubCategory: string

Sub-category for this role.

Example: LEAD
selected: boolean

Indicates if this role is selected.

Example: true
unblinded: string

Whether the role is unblinded ('YES' or 'NO').

Example: YES

{
    "required":[
        "id",
        "roleCategory",
        "roleName"
    ],
    "type":"object",
    "properties":{
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "example":3
        },
        "selected":{
            "type":"boolean",
            "description":"Indicates if this role is selected.",
            "example":true
        },
        "rights":{
            "required":[
                "id",
                "rightName"
            ],
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The unique identifier for the right.",
                    "format":"uuid"
                },
                "rightName":{
                    "type":"string",
                    "description":"The name of the right.",
                    "example":"ACCESS_SUBJECT_DATA"
                }
            },
            "description":"A right associated with a role. Contains the unique identifier and name of the right.",
            "example":{
                "id":"A8C7B83378261E99F4A6823F43A6063B",
                "rightName":"ACCESS_SUBJECT_DATA"
            }
        },
        "id":{
            "type":"string",
            "description":"The unique identifier for the role.",
            "format":"uuid"
        },
        "roleName":{
            "type":"string",
            "description":"Name of the role.",
            "example":"Rule Designer"
        },
        "roleCategory":{
            "type":"string",
            "description":"Category to which the role belongs.",
            "example":"STUDY_SPECIFIC"
        },
        "roleSubCategory":{
            "type":"string",
            "description":"Sub-category for this role.",
            "example":"LEAD"
        },
        "unblinded":{
            "type":"string",
            "description":"Whether the role is unblinded ('YES' or 'NO').",
            "example":"YES"
        }
    },
    "description":"Represents a role with associated rights and additional attributes.",
    "example":{
        "id":"D2FEB81D0E364B22B2EE172CD220A1D1",
        "roleName":"Rule Designer",
        "roleCategory":"STUDY_SPECIFIC",
        "roleSubCategory":"LEAD",
        "unblinded":"YES",
        "objectVersionNumber":3,
        "selected":true,
        "rights":[
            {
                "id":"A8C7B83378261E99F4A6823F43A6063B",
                "rightName":"ACCESS_SUBJECT_DATA"
            }
        ]
    }
}

Example:

{
    "id":"D2FEB81D0E364B22B2EE172CD220A1D1",
    "roleName":"Rule Designer",
    "roleCategory":"STUDY_SPECIFIC",
    "roleSubCategory":"LEAD",
    "unblinded":"YES",
    "objectVersionNumber":3,
    "selected":true,
    "rights":[
        {
            "id":"A8C7B83378261E99F4A6823F43A6063B",
            "rightName":"ACCESS_SUBJECT_DATA"
        }
    ]
}

Nested Schema : rights

Type: object

A right associated with a role. Contains the unique identifier and name of the right.

Show Source

id(required): string (uuid)

The unique identifier for the right.
rightName(required): string

The name of the right.

Example: ACCESS_SUBJECT_DATA

{
    "required":[
        "id",
        "rightName"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the right.",
            "format":"uuid"
        },
        "rightName":{
            "type":"string",
            "description":"The name of the right.",
            "example":"ACCESS_SUBJECT_DATA"
        }
    },
    "description":"A right associated with a role. Contains the unique identifier and name of the right.",
    "example":{
        "id":"A8C7B83378261E99F4A6823F43A6063B",
        "rightName":"ACCESS_SUBJECT_DATA"
    }
}

Example:

{
    "id":"A8C7B83378261E99F4A6823F43A6063B",
    "rightName":"ACCESS_SUBJECT_DATA"
}

Examples

400 Response

Invalid role ID, study ID, or study role type.

Root Schema : AuthResponse

Type: object

Generic 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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Structure 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@3565a0f5