REST API for Clinical One Platform

Bulk user sites update

put

/ec-auth-svc/rest/v1.0/authusers/studies/{StudyID}/users/sites

Bulk update sites for a list of users or users matching search criteria in the specified study.

Request

Path Parameters

StudyID(required): string(uuid)
Unique identifier for the study.
Example:
```
85EFD8B9FF11437F8D0DA3F314A9D123
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Request payload for performing bulk site associations or updates for a set of users in a study. Selection may be made by explicit userIds, allUsers, or via the userSearchSpecs filter. Site associations can be provided explicitly (associatedSites) or set globally via allSites.

Show Source

allSites: boolean

If true, associate all current/future sites with users; if false, uses provided associatedSites.

Example: false
allUsers: boolean

Flag stating if all users found by userSearchSpecs should be included. If true, applies to all; if false, applies to userIds only.

Example: false
associatedSites: array associatedSites

List of site UUIDs to be associated with users.
modeName(required): string

Name of the study mode (e.g., active, design, etc) for which site association is applied.

Example: active
userIds: array userIds

List of user IDs to update sites for.
userSearchSpecs: object UsersSearchSpecificationsDto

Search/filter specifications for selecting users during bulk role/effective/site updates.

{
    "required":[
        "modeName"
    ],
    "type":"object",
    "properties":{
        "modeName":{
            "type":"string",
            "description":"Name of the study mode (e.g., active, design, etc) for which site association is applied.",
            "example":"active"
        },
        "userIds":{
            "type":"array",
            "description":"List of user IDs to update sites for.",
            "example":[
                "54B6FD8C920E4D19A259C4A9C7033A85",
                "BC2A5EEDA88F4791A4B5B7F83D1F8317"
            ],
            "items":{
                "type":"string",
                "description":"List of user IDs to update sites for.",
                "format":"uuid"
            }
        },
        "allUsers":{
            "type":"boolean",
            "description":"Flag stating if all users found by userSearchSpecs should be included. If true, applies to all; if false, applies to userIds only.",
            "example":false
        },
        "userSearchSpecs":{
            "$ref":"#/components/schemas/UsersSearchSpecificationsDto"
        },
        "allSites":{
            "type":"boolean",
            "description":"If true, associate all current/future sites with users; if false, uses provided associatedSites.",
            "example":false
        },
        "associatedSites":{
            "type":"array",
            "description":"List of site UUIDs to be associated with users.",
            "format":"uuid",
            "example":[
                "764620086A994885B67EDD158E3EA3D1",
                "3F786850E387550FDAB836ED7E6DC881"
            ],
            "items":{
                "type":"string",
                "description":"List of site UUIDs to be associated with users.",
                "format":"uuid"
            }
        }
    },
    "description":"Request payload for performing bulk site associations or updates for a set of users in a study. Selection may be made by explicit userIds, allUsers, or via the userSearchSpecs filter. Site associations can be provided explicitly (associatedSites) or set globally via allSites."
}

Nested Schema : associatedSites

Type: array

List of site UUIDs to be associated with users.

Show Source

Array of: string(uuid)

List of site UUIDs to be associated with users.

{
    "type":"array",
    "description":"List of site UUIDs to be associated with users.",
    "format":"uuid",
    "example":[
        "764620086A994885B67EDD158E3EA3D1",
        "3F786850E387550FDAB836ED7E6DC881"
    ],
    "items":{
        "type":"string",
        "description":"List of site UUIDs to be associated with users.",
        "format":"uuid"
    }
}

Example:

[
    "764620086A994885B67EDD158E3EA3D1",
    "3F786850E387550FDAB836ED7E6DC881"
]

Nested Schema : userIds

Type: array

List of user IDs to update sites for.

Show Source

Array of: string(uuid)

List of user IDs to update sites for.

{
    "type":"array",
    "description":"List of user IDs to update sites for.",
    "example":[
        "54B6FD8C920E4D19A259C4A9C7033A85",
        "BC2A5EEDA88F4791A4B5B7F83D1F8317"
    ],
    "items":{
        "type":"string",
        "description":"List of user IDs to update sites for.",
        "format":"uuid"
    }
}

Example:

[
    "54B6FD8C920E4D19A259C4A9C7033A85",
    "BC2A5EEDA88F4791A4B5B7F83D1F8317"
]

Nested Schema : UsersSearchSpecificationsDto

Type: object

Search/filter specifications for selecting users during bulk role/effective/site updates.

Show Source

depots: object depots

Depots data to filter the users
mode: string

Study mode for the search

Example: active
searchString: string

Free text to search/filter users

Example: site, US
sites: object sites

Sites data to filter the users
sortBy: string

Result sort column

Example: lastName
sortOrder: string

Sort order, ascending/descending

Example: asc
studyRoles: array studyRoles

List of study role UUIDs
studyRoleTypes: array studyRoleTypes

List of study role types
userStatus: string

User status for filtering

Example: Inactive

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"Study mode for the search",
            "example":"active"
        },
        "sites":{
            "$ref":"#/components/schemas/sites"
        },
        "depots":{
            "$ref":"#/components/schemas/depots"
        },
        "userStatus":{
            "type":"string",
            "description":"User status for filtering",
            "example":"Inactive"
        },
        "studyRoles":{
            "type":"array",
            "description":"List of study role UUIDs",
            "example":[
                "AF73A2EEA90B4E9394CE6CB40B5BC66E"
            ],
            "items":{
                "type":"string",
                "description":"List of study role UUIDs",
                "format":"uuid"
            }
        },
        "studyRoleTypes":{
            "type":"array",
            "description":"List of study role types",
            "example":[
                "PrincipalInvestigator"
            ],
            "items":{
                "type":"string",
                "description":"List of study role types",
                "example":"[\"PrincipalInvestigator\"]"
            }
        },
        "searchString":{
            "type":"string",
            "description":"Free text to search/filter users",
            "example":"site, US"
        },
        "sortBy":{
            "type":"string",
            "description":"Result sort column",
            "example":"lastName"
        },
        "sortOrder":{
            "type":"string",
            "description":"Sort order, ascending/descending",
            "example":"asc"
        }
    },
    "description":"Search/filter specifications for selecting users during bulk role/effective/site updates."
}

Nested Schema : depots

Type: object

Depots data to filter the users

Show Source

allDepots: boolean
depotIds: array depotIds

{
    "type":"object",
    "properties":{
        "allDepots":{
            "type":"boolean"
        },
        "depotIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Depots data to filter the users",
    "example":{
        "names":[
            "DepotA"
        ]
    }
}

Example:

{
    "names":[
        "DepotA"
    ]
}

Nested Schema : sites

Type: object

Sites data to filter the users

Show Source

allSites: boolean
siteIds: array siteIds

{
    "type":"object",
    "properties":{
        "allSites":{
            "type":"boolean"
        },
        "siteIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Sites data to filter the users",
    "example":{
        "ids":[
            "123F0B1426C11EE90C31234567890AAA"
        ]
    }
}

Example:

{
    "ids":[
        "123F0B1426C11EE90C31234567890AAA"
    ]
}

Nested Schema : studyRoles

Type: array

List of study role UUIDs

Show Source

Array of: string(uuid)

List of study role UUIDs

{
    "type":"array",
    "description":"List of study role UUIDs",
    "example":[
        "AF73A2EEA90B4E9394CE6CB40B5BC66E"
    ],
    "items":{
        "type":"string",
        "description":"List of study role UUIDs",
        "format":"uuid"
    }
}

Example:

[
    "AF73A2EEA90B4E9394CE6CB40B5BC66E"
]

Nested Schema : studyRoleTypes

Type: array

List of study role types

Show Source

Array of: string

List of study role types

Example: ["PrincipalInvestigator"]

{
    "type":"array",
    "description":"List of study role types",
    "example":[
        "PrincipalInvestigator"
    ],
    "items":{
        "type":"string",
        "description":"List of study role types",
        "example":"[\"PrincipalInvestigator\"]"
    }
}

Example:

[
    "PrincipalInvestigator"
]

Nested Schema : depotIds

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : siteIds

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Response

Supported Media Types

application/json

204 Response

Success

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

500 Response

Error

Root 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."
}