Get candidate members for role

get/roles/{roleId}/members/candidates

Returns the users and groups that can be assigned to the role.

Request Samples

1

Response Samples

1{
2 "value": {
3 "links": [
4 {
5 "method": "GET",
6 "rel": "self",
7 "href": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members/candidates?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=10",
8 "uri": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members/candidates?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=10",
9 "type": "application/vnd.sas.collection",
10 "itemType": "application/vnd.sas.clinical.principal+json"
11 },
12 {
13 "method": "GET",
14 "rel": "collection",
15 "href": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members/candidates",
16 "uri": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members/candidates",
17 "type": "application/vnd.sas.collection",
18 "itemType": "application/vnd.sas.clinical.principal+json"
19 }
20 ],
21 "name": "members",
22 "accept": "application/vnd.sas.clinical.principal+json",
23 "start": 0,
24 "count": 4,
25 "items": [
26 {
27 "version": 1,
28 "id": "7f091359-36f4-4c7c-bb47-bd1f59d5af88",
29 "typeId": "group",
30 "name": "group A",
31 "displayName": "group A (Organization)",
32 "contextId": "8b10535a-2515-441f-a69c-00b62c6a45b2",
33 "contextTypeId": "organization"
34 },
35 {
36 "version": 1,
37 "id": "48a278d6-5984-45b9-9ff3-5e8cd631d772",
38 "typeId": "group",
39 "name": "group B",
40 "displayName": "group B (Organization)",
41 "contextId": "8b10535a-2515-441f-a69c-00b62c6a45b2",
42 "contextTypeId": "organization"
43 },
44 {
45 "version": 1,
46 "id": "sastest1",
47 "typeId": "user",
48 "name": "SAS Test User 1",
49 "displayName": "SAS Test User 1 (sastest1)"
50 },
51 {
52 "version": 1,
53 "id": "sastest2",
54 "typeId": "user",
55 "name": "SAS Test User 2",
56 "displayName": "SAS Test User 2 (sastest2)"
57 }
58 ],
59 "limit": 100,
60 "version": 2
61 }
62}

Path Parameters

NameTypeRequiredDescription
roleId
string
true

The unique identifier for the role.

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

Filter criteria for items. The following fields are not supported in filter criteria: typeId, displayName, contextId, and contextTypeId. 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, displayName, contextId, and contextTypeId. See Sorting in REST APIs.

start
integer
false

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

Responses

StatusMeaningDescription
200OK

The request succeeded and the specified role candidate members are returned.

Schema