Get assigned roles

get/roles

Returns the roles assigned at the context.

Authorization: Requires read access on the context.

Request Samples

1

Response Samples

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

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.

limit
integer
false

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

sortBy
string<sort-criteria>
false

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

start
integer
false

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

Responses

StatusMeaningDescription
200OK

OK

Schema