Get assigned roles

get/roles
Internal-Use Only

Returns the roles assigned at the context. Authorization: Requires read access on the context.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/clinicalRepository/roles?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=100",
7      "uri": "/clinicalRepository/roles?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=100",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.clinical.role+json"
10    },
11    {
12      "method": "GET",
13      "rel": "collection",
14      "href": "/clinicalRepository/roles",
15      "uri": "/clinicalRepository/roles",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.clinical.role+json"
18    }
19  ],
20  "name": "roles",
21  "accept": "application/vnd.sas.clinical.role+json",
22  "start": 0,
23  "count": 2,
24  "items": [
25    {
26      "version": 1,
27      "createdBy": "sastest1",
28      "creationTimeStamp": "2023-09-13T13:35:54.593000Z",
29      "modifiedBy": "sastest1",
30      "modifiedTimeStamp": "2023-09-13T13:35:54.593000Z",
31      "id": "1d629863-ec6f-4c9c-9f60-147695d73849",
32      "typeId": "roleassignment",
33      "createdByDisplayName": "SAS Test User 1 (sastest1)",
34      "modifiedByDisplayName": "SAS Test User 1 (sastest1)",
35      "name": "buTestRole",
36      "displayName": "buTestRole (Business Unit)",
37      "assignedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",
38      "assignedContextTypeId": "therapeuticarea",
39      "definedContextId": "cac68a83-2f9b-4e45-859f-1163581edf1e",
40      "definedContextTypeId": "businessunit",
41      "inherited": true
42    },
43    {
44      "version": 1,
45      "createdBy": "sastest1",
46      "creationTimeStamp": "2023-09-26T15:46:09.962000Z",
47      "modifiedBy": "sastest1",
48      "modifiedTimeStamp": "2023-09-26T15:46:09.962000Z",
49      "id": "c39cf904-5dc5-4dab-b17e-f7960182feb0",
50      "typeId": "roleassignment",
51      "createdByDisplayName": "SAS Test User 1 (sastest1)",
52      "modifiedByDisplayName": "SAS Test User 1 (sastest1)",
53      "name": "taAdminRole",
54      "displayName": "taAdminRole",
55      "description": "Role for the therapeutic area administrator.",
56      "assignedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",
57      "assignedContextTypeId": "therapeuticarea",
58      "definedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",
59      "definedContextTypeId": "therapeuticarea",
60      "inherited": false
61    }
62  ],
63  "limit": 100,
64  "version": 2
65}

Query Parameters

NameTypeRequiredDescription
contextId
string
true

The ID of the context for which to get the assigned roles.

filter
string<filter-criteria>
false

Filter criteria for items. The following fields are not supported in filter criteria: typeId. See Filtering in REST APIs.

Example:
"in(name,'group1','group2')"
limit
integer
false

The maximum number of items to return. Defaults to 10. The maximum cannot exceed 500.

Examples:
10
sortBy
string<sort-criteria>
false

Sorts the returned items. The following fields are not supported for sort: typeId. See Sorting in REST APIs.

Example:
"name:ascending:primary"
start
integer
false

0-based offset of the first type to return. Defaults to 0.

Examples:
10

Responses

StatusMeaningDescription
200OKOKSchema