Jump to

• Request
• Response

[Deprecated]: v1.0

get

/ec-auth-svc/rest/v1.0/studyroles

Deprecated: This endpoint for querying tenant study roles is deprecated. Use '/v3.0/studyroles/' in AuthStudyRolesResourceV3 for improved filtering, parameter names, and response payload that includes enhanced details and field mappings. The new API returns the same information but supports additional query parameters for advanced searches.

Request

Query Parameters

• searchString(required): string
  String to search for in role attributes.

  Example:

  site

• studyRoleName(required): string
  Name filter for study role.

  Example:

  MONITOR

• studyRoleStatus(required): string
  Status filter for study role.

  Example:

  ACTIVE

• studyRoleType(required): string
  Type filter for study role.

  Example:

  Design

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyRoleDtoParams
  Title: StudyRoleDtoParams

  Parameters for a study role, including inherited version validity.

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

Nested Schema : StudyRoleDtoParams

Type: object

Title: StudyRoleDtoParams

Parameters for a study role, including inherited version validity.

Show Source

• roleId: string (uuid)
  Role identifier, if relevant.
• studyId: string (uuid)
  Study identifier, if applicable.
• studyRoleCreationType(required): string
  Method used to create the study role (e.g., MANUAL, AUTO).

  Example: AUTO
• studyRoleDesc(required): string
  Description of the study role.

  Example: Monitor role grants viewing and edit capabilities.
• studyRoleId(required): string (uuid)
  Unique identifier for the study role.
• studyRoleName(required): string
  Name of the study role.

  Example: MONITOR
• studyRoleStatus(required): string
  Current status of the study role (e.g., ACTIVE, INACTIVE).

  Example: ACTIVE
• studyRoleType(required): string
  Type of the study role (e.g., SITE, STUDY).

  Example: SITE
• versionEnd: string (date-time)
  End date for the object's version validity. ISO 8601 format.

  Example: 2025-06-17T10:15:30Z
• versionStart: string (date-time)
  Start date for the object's version validity. ISO 8601 format.

  Example: 2020-06-17T10:15:30Z

{
    "title":"StudyRoleDtoParams",
    "required":[
        "studyRoleCreationType",
        "studyRoleDesc",
        "studyRoleId",
        "studyRoleName",
        "studyRoleStatus",
        "studyRoleType"
    ],
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Start date for the object's version validity. ISO 8601 format.",
            "format":"date-time",
            "example":"2020-06-17T10:15:30Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"End date for the object's version validity. ISO 8601 format.",
            "format":"date-time",
            "example":"2025-06-17T10:15:30Z"
        },
        "studyRoleId":{
            "type":"string",
            "description":"Unique identifier for the study role.",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string",
            "description":"Name of the study role.",
            "example":"MONITOR"
        },
        "studyRoleDesc":{
            "type":"string",
            "description":"Description of the study role.",
            "example":"Monitor role grants viewing and edit capabilities."
        },
        "studyRoleType":{
            "type":"string",
            "description":"Type of the study role (e.g., SITE, STUDY).",
            "example":"SITE"
        },
        "studyRoleStatus":{
            "type":"string",
            "description":"Current status of the study role (e.g., ACTIVE, INACTIVE).",
            "example":"ACTIVE"
        },
        "studyRoleCreationType":{
            "type":"string",
            "description":"Method used to create the study role (e.g., MANUAL, AUTO).",
            "example":"AUTO"
        },
        "studyId":{
            "type":"string",
            "description":"Study identifier, if applicable.",
            "format":"uuid"
        },
        "roleId":{
            "type":"string",
            "description":"Role identifier, if relevant.",
            "format":"uuid"
        }
    },
    "description":"Parameters for a study role, including inherited version validity."
}

Examples

Select an example Response Example

400 Response

Bad request. Invalid query parameters.

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