Jump to

• Request
• Response

Get list of roles for a study

get

/ec-auth-svc/rest/v3.0/authroles/{studyId}

Retrieves all roles available for a specific study and role type, with each role object containing category, subcategory, unblinded, version, and all related properties.

Request

Path Parameters

• studyId(required): string(uuid)
  Unique identifier for the study.

  Example:

  C2C3C8E63B6040D9ADC56D63803B6BC8

Query Parameters

• studyRoleType(required): string
  Role type for which to retrieve roles.

  Example:

  Design

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 RespDisplayRoleDto

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

Nested Schema : RespDisplayRoleDto

Type: object

Show Source

• id(required): string (uuid)
• objectVersionNumber(required): number
• roleCategory(required): string
• roleCategoryLabel(required): string
• roleName(required): string
• roleNameLabel(required): string
• roleSubCategory: string
• roleSubCategoryLabel(required): string
• roleType(required): string
• unblinded: string

{
    "required":[
        "id",
        "objectVersionNumber",
        "roleCategory",
        "roleCategoryLabel",
        "roleName",
        "roleNameLabel",
        "roleSubCategoryLabel",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "roleType":{
            "type":"string"
        },
        "roleCategory":{
            "type":"string"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "unblinded":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "roleNameLabel":{
            "type":"string"
        },
        "roleCategoryLabel":{
            "type":"string"
        },
        "roleSubCategoryLabel":{
            "type":"string"
        }
    }
}

Examples

Select an example List of roles for a study (v3)

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