REST API for Clinical One Platform

Get all active users for a study with study roles and email address

post

/ec-auth-svc/rest/v1.0/authstudies/{StudyID}/{mode}/users/studyroles

Retrieves all the active users that belong to a study.

Request

Path Parameters

StudyID(required): string
Study ID
Example:
```
ABE31741A0E945F6B827048B279F2F19
```
mode(required): string
Mode of the study. Accepts active, test, or training
Example:
```
design
```

Supported Media Types

Root Schema : schema

Type: object

Payload listing StudyRoleIDs and siteIds for which users are to be queried/filtered.

Show Source

siteIds: array siteIds

Optional list of site IDs to further restrict or filter the results.
StudyRoleIDs(required): array StudyRoleIDs

List of study role IDs for which users are to be fetched.

{
    "required":[
        "StudyRoleIDs"
    ],
    "type":"object",
    "properties":{
        "siteIds":{
            "type":"array",
            "description":"Optional list of site IDs to further restrict or filter the results.",
            "example":[
                "F3183B73D07340CAB883B592E27C8E56",
                "ECBDC5486B63400E9F1DE56E470C7U8F"
            ],
            "items":{
                "type":"string",
                "description":"Optional list of site IDs to further restrict or filter the results.",
                "example":"[\"F3183B73D07340CAB883B592E27C8E56\",\"ECBDC5486B63400E9F1DE56E470C7U8F\"]"
            }
        },
        "StudyRoleIDs":{
            "type":"array",
            "description":"List of study role IDs for which users are to be fetched.",
            "format":"uuid",
            "example":[
                "F3183B73D07340CAB883B592E27C8E58",
                "ECBDC5486B63400E9F1DE56E470C7B8F"
            ],
            "items":{
                "type":"string",
                "description":"List of study role IDs for which users are to be fetched.",
                "format":"uuid"
            }
        }
    },
    "description":"Payload listing StudyRoleIDs and siteIds for which users are to be queried/filtered.",
    "example":{
        "StudyRoleIDs":[
            "F3183B73D07340CAB883B592E27C8E58",
            "ECBDC5486B63400E9F1DE56E470C7B8F"
        ],
        "siteIds":[
            "SiteA",
            "SiteB"
        ]
    }
}

Example:

{
    "StudyRoleIDs":[
        "F3183B73D07340CAB883B592E27C8E58",
        "ECBDC5486B63400E9F1DE56E470C7B8F"
    ],
    "siteIds":[
        "SiteA",
        "SiteB"
    ]
}

Nested Schema : siteIds

Type: array

Optional list of site IDs to further restrict or filter the results.

Show Source

Array of: string

Optional list of site IDs to further restrict or filter the results.

Example: ["F3183B73D07340CAB883B592E27C8E56","ECBDC5486B63400E9F1DE56E470C7U8F"]

{
    "type":"array",
    "description":"Optional list of site IDs to further restrict or filter the results.",
    "example":[
        "F3183B73D07340CAB883B592E27C8E56",
        "ECBDC5486B63400E9F1DE56E470C7U8F"
    ],
    "items":{
        "type":"string",
        "description":"Optional list of site IDs to further restrict or filter the results.",
        "example":"[\"F3183B73D07340CAB883B592E27C8E56\",\"ECBDC5486B63400E9F1DE56E470C7U8F\"]"
    }
}

Example:

[
    "F3183B73D07340CAB883B592E27C8E56",
    "ECBDC5486B63400E9F1DE56E470C7U8F"
]

Nested Schema : StudyRoleIDs

Type: array

List of study role IDs for which users are to be fetched.

Show Source

Array of: string(uuid)

List of study role IDs for which users are to be fetched.

{
    "type":"array",
    "description":"List of study role IDs for which users are to be fetched.",
    "format":"uuid",
    "example":[
        "F3183B73D07340CAB883B592E27C8E58",
        "ECBDC5486B63400E9F1DE56E470C7B8F"
    ],
    "items":{
        "type":"string",
        "description":"List of study role IDs for which users are to be fetched.",
        "format":"uuid"
    }
}

Example:

[
    "F3183B73D07340CAB883B592E27C8E58",
    "ECBDC5486B63400E9F1DE56E470C7B8F"
]

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : DisplayStudyUserStudyRolesListDto

Type: object

Show Source

users: array users
usersFound: integer (int32)

{
    "type":"object",
    "properties":{
        "usersFound":{
            "type":"integer",
            "format":"int32"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DisplayStudyUserStudyRolesDto"
            }
        }
    }
}

Nested Schema : users

Type: array

Show Source

Array of: object DisplayStudyUserStudyRolesDto v1.0

Title: DisplayStudyUserStudyRolesDto v1.0

Authorized User Info

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

Nested Schema : DisplayStudyUserStudyRolesDto v1.0

Type: object

Title: DisplayStudyUserStudyRolesDto v1.0

Authorized User Info

Show Source

email: string
firstName: string
id: string (uuid)
lastName: string
studyRole: array studyRole
userName: string

{
    "title":"DisplayStudyUserStudyRolesDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "studyRole":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DisplayStudyRoleDtoV2"
            }
        }
    },
    "description":"Authorized User Info"
}

Nested Schema : studyRole

Type: array

Show Source

Array of: object DisplayStudyRoleDtoV2

Single study role assignment in a mode. Includes primary ID, display label, and version validity dates (inherited from DisplayAuthBaseDto).

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

Nested Schema : DisplayStudyRoleDtoV2

Type: object

Single study role assignment in a mode. Includes primary ID, display label, and version validity dates (inherited from DisplayAuthBaseDto).

Show Source

id: string (uuid)

Unique study role ID (32-character uppercase hexadecimal UUID).
roleName: string
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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique study role ID (32-character uppercase hexadecimal UUID).",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "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"
        }
    },
    "description":"Single study role assignment in a mode. Includes primary ID, display label, and version validity dates (inherited from DisplayAuthBaseDto).",
    "example":[
        {
            "id":"1A9CF1A460CD440CA62B6F9EA258F968",
            "studyRoleName":"Investigator",
            "versionStart":"2021-07-01T00:00:00.000Z",
            "versionEnd":"2024-01-31T23:59:59.000Z"
        }
    ]
}

Example:

[
    {
        "id":"1A9CF1A460CD440CA62B6F9EA258F968",
        "studyRoleName":"Investigator",
        "versionStart":"2021-07-01T00:00:00.000Z",
        "versionEnd":"2024-01-31T23:59:59.000Z"
    }
]

400 Response

Bad request

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