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