REST API for Clinical One Cloud Service

v1.0

get

/ec-auth-svc/rest/v1.0/authstudies/{studyId}/userroles

Retrieves the user roles that are present in a study.

Request

Path Parameters

studyId(required): string(uuid)
Unique study identifier. Must be a 32-character uppercase hexadecimal UUID.
Example:
```
C45F17A90D1F4F6981F131AFFF55BC77
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

User roles by category, with each role fully expanded, as per schema and including all fields.

Root Schema : schema

Type: array

Show Source

Array of: object DisplayStudyUserRolesDto

Describes user roles within a study, indicating the type/category and a list of role objects assigned (typically study role details).

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

Nested Schema : DisplayStudyUserRolesDto

Type: object

Describes user roles within a study, indicating the type/category and a list of role objects assigned (typically study role details).

Show Source

roles: array roles

List of role objects (actual schema depends on the use context, typically a DTO representing role details).
roleType: string

Type or category of the role for the user within a study (such as INVESTIGATOR, VIEWER, etc).

Example: design

{
    "type":"object",
    "properties":{
        "roleType":{
            "type":"string",
            "description":"Type or category of the role for the user within a study (such as INVESTIGATOR, VIEWER, etc).",
            "example":"design"
        },
        "roles":{
            "type":"array",
            "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
            "example":[
                {
                    "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
                    "roleName":"Assign Site to a Study"
                },
                {
                    "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
                    "roleName":"View Library Objects"
                }
            ],
            "items":{
                "type":"object",
                "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
                "example":[
                    {
                        "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
                        "roleName":"Assign Site to a Study"
                    },
                    {
                        "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
                        "roleName":"View Library Objects"
                    }
                ]
            }
        }
    },
    "description":"Describes user roles within a study, indicating the type/category and a list of role objects assigned (typically study role details).",
    "example":"{\n  \"roleType\": \"design\",\n  \"roles\": [\n    {\n      \"roleId\": \"D0F183DC273340CEA7AFDCB93A5B3D4B\",\n      \"roleName\": \"Assign Site to a Study\",\n    },\n    {\n      \"roleId\": \"9ED1AE19B0B04188B8A70A8D8374F315\",\n      \"roleName\": \"View Library Objects\",\n    }\n  ]\n}"
}

Example:

{
  "roleType": "design",
  "roles": [
    {
      "roleId": "D0F183DC273340CEA7AFDCB93A5B3D4B",
      "roleName": "Assign Site to a Study",
    },
    {
      "roleId": "9ED1AE19B0B04188B8A70A8D8374F315",
      "roleName": "View Library Objects",
    }
  ]
}

Nested Schema : roles

Type: array

List of role objects (actual schema depends on the use context, typically a DTO representing role details).

Show Source

Array of: object items

List of role objects (actual schema depends on the use context, typically a DTO representing role details).

{
    "type":"array",
    "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
    "example":[
        {
            "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
            "roleName":"Assign Site to a Study"
        },
        {
            "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
            "roleName":"View Library Objects"
        }
    ],
    "items":{
        "type":"object",
        "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
        "example":[
            {
                "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
                "roleName":"Assign Site to a Study"
            },
            {
                "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
                "roleName":"View Library Objects"
            }
        ]
    }
}

Example:

[
    {
        "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
        "roleName":"Assign Site to a Study"
    },
    {
        "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
        "roleName":"View Library Objects"
    }
]

Nested Schema : items

Type: object

List of role objects (actual schema depends on the use context, typically a DTO representing role details).

Example:

[
    {
        "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
        "roleName":"Assign Site to a Study"
    },
    {
        "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
        "roleName":"View Library Objects"
    }
]

Examples

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

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.