Jump to

• Request
• Response

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 ID

  Example:

  ABE31741A0E945F6B827048B279F2F19

Query Parameters

• excludeTemplateRoles: boolean
  Result should exclude the template role

  Example:

  true

• rightToFilter:

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DisplayStudyRoleRightsDto
  Represents a study role with rights details for display.

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

Nested Schema : DisplayStudyRoleRightsDto

Type: object

Represents 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 role

  Example: Runtime

{
    "required":[
        "activeStatus",
        "rights",
        "roleCategory",
        "roleId",
        "roleName",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "roleId":{
            "type":"string",
            "description":"Unique identifier for the study role.",
            "example":"B748C913E61B4B18A9B5D80F349BC8FD"
        },
        "roleName":{
            "type":"string",
            "description":"Name of the study role.",
            "example":"Site User"
        },
        "roleCategory":{
            "type":"string",
            "description":"Category of the study role (e.g., SITE_SPECIFIC, STUDY_SPECIFIC).",
            "example":"Site"
        },
        "activeStatus":{
            "type":"string",
            "description":"Active status of the study role.",
            "example":"Active"
        },
        "roleType":{
            "type":"string",
            "description":"Type of the role",
            "example":"Runtime"
        },
        "rights":{
            "required":[
                "displayName",
                "rightName"
            ],
            "type":"object",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"Human-readable name for this right.",
                    "example":"Create shipments to DDF"
                },
                "rightName":{
                    "type":"string",
                    "description":"Right name identifier.",
                    "example":"OrsSiteShipmentPost"
                }
            },
            "description":"DTO for right display information including human-readable name and identifier.",
            "example":[
                {
                    "displayName":"Create shipments to DDF",
                    "rightName":"OrsSiteShipmentPost"
                }
            ]
        }
    },
    "description":"Represents a study role with rights details for display."
}

Nested Schema : rights

Type: object

DTO 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

{
    "required":[
        "displayName",
        "rightName"
    ],
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Human-readable name for this right.",
            "example":"Create shipments to DDF"
        },
        "rightName":{
            "type":"string",
            "description":"Right name identifier.",
            "example":"OrsSiteShipmentPost"
        }
    },
    "description":"DTO for right display information including human-readable name and identifier.",
    "example":[
        {
            "displayName":"Create shipments to DDF",
            "rightName":"OrsSiteShipmentPost"
        }
    ]
}

Example:

[
    {
        "displayName":"Create shipments to DDF",
        "rightName":"OrsSiteShipmentPost"
    }
]

Examples

Select an example DisplayStudyRoleRightsDto

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

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

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Back to Top