Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/studyroles/{studyroleid}/rightsgroups

Retrieves the groups of permissions associated with a study role for a given study.

Request

Path Parameters

• studyroleid(required): string(uuid)
  UUID of the study role at tenant level. Example: "A093D777F34748E8A03A5D6EDC7E6DA2"

  Example:

  A093D777F34748E8A03A5D6EDC7E6DA2

Query Parameters

• studyRoleType(required): string
  Type of the study role (e.g., STUDY_SPECIFIC, SITE_SPECIFIC). Example: "SITE_SPECIFIC"

  Example:

  SITE_SPECIFIC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of rights groups for the tenant study role.

Body ()

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

Select an example Response Example

400 Response

Invalid role ID or role type.

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@65719c12

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top