Get groups
get/groups
Returns the groups assigned to the context.
1{2 "links": [3 {4 "method": "GET",5 "rel": "self",6 "href": "/clinicalRepository/groups?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=10",7 "uri": "/clinicalRepository/groups?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=10",8 "type": "application/vnd.sas.collection",9 "itemType": "application/vnd.sas.clinical.group+json"10 },11 {12 "method": "GET",13 "rel": "collection",14 "href": "/clinicalRepository/groups",15 "uri": "/clinicalRepository/groups",16 "type": "application/vnd.sas.collection",17 "itemType": "application/vnd.sas.clinical.group+json"18 }19 ],20 "name": "groups",21 "accept": "application/vnd.sas.clinical.group+json",22 "start": 0,23 "count": 2,24 "items": [25 {26 "version": 1,27 "createdBy": "sastest1",28 "creationTimeStamp": "2023-09-28T04:16:51.079000Z",29 "modifiedBy": "sastest1",30 "modifiedTimeStamp": "2023-09-28T04:16:51.079000Z",31 "id": "89f8713d-682e-449a-903c-896bc35ef3aa",32 "typeId": "group",33 "createdByDisplayName": "SAS Test User 1 (sastest1)",34 "modifiedByDisplayName": "SAS Test User 1 (sastest1)",35 "name": "Test Group 1",36 "description": "Remote Test Group",37 "contextId": "35f9a2ed-88ab-4f11-95cd-70a262df31e5",38 "contextTypeId": "organization"39 },40 {41 "version": 1,42 "createdBy": "sastest1",43 "creationTimeStamp": "2023-09-28T04:16:56.029000Z",44 "modifiedBy": "sastest1",45 "modifiedTimeStamp": "2023-09-28T04:16:56.029000Z",46 "id": "f519a642-cc50-4abc-a85c-b147e4dd715e",47 "typeId": "group",48 "createdByDisplayName": "SAS Test User 1 (sastest1)",49 "modifiedByDisplayName": "SAS Test User 1 (sastest1)",50 "name": "Test Group 2",51 "contextId": "35f9a2ed-88ab-4f11-95cd-70a262df31e5",52 "contextTypeId": "organization"53 }54 ],55 "limit": 10,56 "version": 257}
| Name | Type | Required | Description |
|---|---|---|---|
contextId | string | true | The ID of the context for which to get the groups. |
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 |