REST API for Clinical One Platform

~~[Deprecated]: Get the list of study roles for a study ID~~

get

/ec-auth-svc/rest/v2.0/studyroles/{StudyID}

Deprecated: Retrieves the list of study roles for given Study ID.

Request

Path Parameters

StudyID(required): string(uuid)
UUID for the study. Example: "37F6B1958D4B4C42A1F5D3B148651073"
Example:
```
37F6B1958D4B4C42A1F5D3B148651073
```

Query Parameters

includeRemoved: string
Flag to include removed roles (Y/N).

Default Value: N
Example:
```
N
```
localize: boolean

Default Value: false
searchString(required): string
String to search in role data.
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:
```
Runtime
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List of study role parameters for the specified study

Root Schema : schema

Type: array

Show Source

Array of: object StudyRoleDtoParamsV2

V2: Parameters for a study role, reflecting all entity and version metadata for audit and tracking.

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

Nested Schema : StudyRoleDtoParamsV2

Type: object

V2: Parameters for a study role, reflecting all entity and version metadata for audit and tracking.

Show Source

comment: string

Additional comments relevant to this change.

Example: Role was updated by system admin.
id: string (uuid)

Unique identifier for this entity.
objectVersionNumber: number

Version of the role object.

Example: 9
operationType: string

The operation that caused this change (CREATE, UPDATE, DELETE).

Example: UPDATE
reason: string

Reason for the change.

Example: Role name changed due to protocol amendment.
roleId: string (uuid)

Related role UUID, if available.
softwareVersionNumber: number

Version of the Clinical One software.

Example: 4
StudyID: string (uuid)

UUID of the study this relates to.
studyRoleCreationType(required): string

Role creation method (e.g., MANUAL, AUTO).

Example: AUTO
studyRoleDesc: string

Optional description for this study role.

Example: Monitor role grants viewing and edit capabilities.
StudyRoleID(required): string (uuid)

UUID for the study role.
studyRoleName(required): string

Name of the study role.

Example: MONITOR
studyRoleStatus(required): string

Status string for this role (ACTIVE, INACTIVE, etc).

Example: ACTIVE
studyRoleType(required): string

Type (e.g., SITE, STUDY) for this study role.

Example: SITE
studyRoleVersion: string

Version string for this study role entity.

Example: v2.2
userId: string (uuid)

UUID of the user responsible for this change.
versionEnd: string (date-time)

Date/time this version was replaced (ISO 8601).

Example: 2023-12-31T23:59:59Z
versionStart: string (date-time)

Date/time of this version's start (ISO 8601).

Example: 2021-01-01T00:00:00Z

{
    "required":[
        "studyRoleCreationType",
        "StudyRoleID",
        "studyRoleName",
        "studyRoleStatus",
        "studyRoleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for this entity.",
            "format":"uuid"
        },
        "StudyRoleID":{
            "type":"string",
            "description":"UUID for the study role.",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string",
            "description":"Name of the study role.",
            "example":"MONITOR"
        },
        "studyRoleDesc":{
            "type":"string",
            "description":"Optional description for this study role.",
            "example":"Monitor role grants viewing and edit capabilities."
        },
        "studyRoleType":{
            "type":"string",
            "description":"Type (e.g., SITE, STUDY) for this study role.",
            "example":"SITE"
        },
        "studyRoleStatus":{
            "type":"string",
            "description":"Status string for this role (ACTIVE, INACTIVE, etc).",
            "example":"ACTIVE"
        },
        "studyRoleCreationType":{
            "type":"string",
            "description":"Role creation method (e.g., MANUAL, AUTO).",
            "example":"AUTO"
        },
        "StudyID":{
            "type":"string",
            "description":"UUID of the study this relates to.",
            "format":"uuid"
        },
        "roleId":{
            "type":"string",
            "description":"Related role UUID, if available.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Date/time of this version's start (ISO 8601).",
            "format":"date-time",
            "example":"2021-01-01T00:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Date/time this version was replaced (ISO 8601).",
            "format":"date-time",
            "example":"2023-12-31T23:59:59Z"
        },
        "operationType":{
            "type":"string",
            "description":"The operation that caused this change (CREATE, UPDATE, DELETE).",
            "example":"UPDATE"
        },
        "userId":{
            "type":"string",
            "description":"UUID of the user responsible for this change.",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Version of the role object.",
            "example":9
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Version of the Clinical One software.",
            "example":4
        },
        "reason":{
            "type":"string",
            "description":"Reason for the change.",
            "example":"Role name changed due to protocol amendment."
        },
        "comment":{
            "type":"string",
            "description":"Additional comments relevant to this change.",
            "example":"Role was updated by system admin."
        },
        "studyRoleVersion":{
            "type":"string",
            "description":"Version string for this study role entity.",
            "example":"v2.2"
        }
    },
    "description":"V2: Parameters for a study role, reflecting all entity and version metadata for audit and tracking.",
    "example":{
        "id":"648C2FC0EA7E4F5B925F7A4FABCFFF04",
        "StudyRoleID":"B931A89223C2425EAF9574EBA59455CF",
        "studyRoleName":"MONITOR",
        "studyRoleDesc":"Monitor role grants viewing and edit capabilities.",
        "studyRoleType":"SITE",
        "studyRoleStatus":"ACTIVE",
        "studyRoleCreationType":"AUTO",
        "StudyID":"37F6B1958D4B4C42A1F5D3B148651073",
        "roleId":"E622F2E99B2740C785A927B16A5BDA1A",
        "versionStart":"2021-01-01T00:00:00.000Z",
        "versionEnd":"2023-12-31T23:59:59.000Z",
        "operationType":"UPDATE",
        "userId":"C2C1C99E3EF74650B989F2C53177B29E",
        "objectVersionNumber":9,
        "softwareVersionNumber":4,
        "reason":"Role name changed due to protocol amendment.",
        "comment":"Role was updated by system admin.",
        "studyRoleVersion":"v2.2"
    }
}

Example:

{
    "id":"648C2FC0EA7E4F5B925F7A4FABCFFF04",
    "StudyRoleID":"B931A89223C2425EAF9574EBA59455CF",
    "studyRoleName":"MONITOR",
    "studyRoleDesc":"Monitor role grants viewing and edit capabilities.",
    "studyRoleType":"SITE",
    "studyRoleStatus":"ACTIVE",
    "studyRoleCreationType":"AUTO",
    "StudyID":"37F6B1958D4B4C42A1F5D3B148651073",
    "roleId":"E622F2E99B2740C785A927B16A5BDA1A",
    "versionStart":"2021-01-01T00:00:00.000Z",
    "versionEnd":"2023-12-31T23:59:59.000Z",
    "operationType":"UPDATE",
    "userId":"C2C1C99E3EF74650B989F2C53177B29E",
    "objectVersionNumber":9,
    "softwareVersionNumber":4,
    "reason":"Role name changed due to protocol amendment.",
    "comment":"Role was updated by system admin.",
    "studyRoleVersion":"v2.2"
}

Examples

400 Response

Bad request / invalid query.

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: string

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
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":"string",
            "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@3565a0f5