Jump to

• Request
• Response

Get the list of study roles for a study ID

get

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

Retrieves the list of study roles for a study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID

Query Parameters

• searchString(required): string
  Search string based on studyRole name
• studyRoleName(required): string
  Study role name
• studyRoleStatus(required): string
  A study role's status
• studyRoleType(required): string
  Study role type

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 RespStudyRoleDtoParams

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

Nested Schema : RespStudyRoleDtoParams

Type: object

Show Source

• authorizedUserId: string (uuid)
• comment: string
• effectiveEnd: string (date-time)
• effectiveStart: string (date-time)
• modeId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• roleId: string (uuid)
• roles: array roles
• softwareVersionNumber: number
• studyId: string (uuid)
• studyRoleCreationType(required): string
• studyRoleDesc(required): string
• studyRoleDescLabel(required): string
• studyRoleId(required): string (uuid)
• studyRoleName(required): string
• studyRoleNameLabel(required): string
• studyRoleStatus(required): string
• studyRoleType(required): string
• studyRoleTypeLabel(required): string
• studyRoleVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "studyRoleCreationType",
        "studyRoleDesc",
        "studyRoleDescLabel",
        "studyRoleId",
        "studyRoleName",
        "studyRoleNameLabel",
        "studyRoleStatus",
        "studyRoleType",
        "studyRoleTypeLabel"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "authorizedUserId":{
            "type":"string",
            "format":"uuid"
        },
        "modeId":{
            "type":"string",
            "format":"uuid"
        },
        "studyRoleId":{
            "type":"string",
            "format":"uuid"
        },
        "roleId":{
            "type":"string",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string"
        },
        "studyRoleDesc":{
            "type":"string"
        },
        "studyRoleType":{
            "type":"string"
        },
        "studyRoleStatus":{
            "type":"string"
        },
        "studyRoleNameLabel":{
            "type":"string"
        },
        "studyRoleDescLabel":{
            "type":"string"
        },
        "studyRoleTypeLabel":{
            "type":"string"
        },
        "studyRoleCreationType":{
            "type":"string"
        },
        "effectiveStart":{
            "type":"string",
            "format":"date-time"
        },
        "effectiveEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "studyRoleVersion":{
            "type":"string"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RoleDtoParams"
            }
        }
    }
}

Nested Schema : roles

Type: array

Show Source

• Array of: object RoleDtoParams

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

Nested Schema : RoleDtoParams

Type: object

Show Source

• authorizedUserId: string (uuid)
• comment: string
• effectiveEnd: string (date-time)
• effectiveStart: string (date-time)
• modeId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• rightId: string (uuid)
• roleCategory(required): string
• roleCategoryLabel(required): string
• roleId(required): string (uuid)
• roleName(required): string
• roleNameLabel(required): string
• roleSeq: number
• roleSubCategory: string
• roleSubCategoryLabel: string
• roleType(required): string
• roleTypeLabel(required): string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyRoleId: string (uuid)
• unblinded: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "roleCategory",
        "roleCategoryLabel",
        "roleId",
        "roleName",
        "roleNameLabel",
        "roleType",
        "roleTypeLabel"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "authorizedUserId":{
            "type":"string",
            "format":"uuid"
        },
        "modeId":{
            "type":"string",
            "format":"uuid"
        },
        "studyRoleId":{
            "type":"string",
            "format":"uuid"
        },
        "roleId":{
            "type":"string",
            "format":"uuid"
        },
        "rightId":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "roleType":{
            "type":"string"
        },
        "roleCategory":{
            "type":"string"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "roleNameLabel":{
            "type":"string"
        },
        "roleTypeLabel":{
            "type":"string"
        },
        "roleCategoryLabel":{
            "type":"string"
        },
        "roleSubCategoryLabel":{
            "type":"string"
        },
        "unblinded":{
            "type":"string"
        },
        "roleSeq":{
            "type":"number"
        },
        "effectiveStart":{
            "type":"string",
            "format":"date-time"
        },
        "effectiveEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        }
    }
}

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
  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: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• 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":"object",
            "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@76f8fc0a

Nested Schema : details

Type: object

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

Back to Top