1-800-833-1132 : 1-303-449-6400

Get Groups

Description

Get information about all groups. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/group​[?built_in=TRUE|FALSE]​[&last_page]​[&name={string}]​​[&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}]​​[&page_start_marker={string}]

Request Parameters 

Parameter	Description	Required
built_in	Whether the group is a standard group automatically available on the BlackPearl system.	no
last_page	If included, only the last page of results is returned.	no
name	The name of the group.	no
page_length	The maximum number of groups to list. Default: all items after page_offset.	no
page_offset	The starting point for the first group to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no

Responses

Response Elements

<Data>
   <Group>
      <BuiltIn>TRUE|FALSE</BuiltIn>
      <Id>{string}</Id>
      <Name>{string}</Name>
   </Group>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Group	The container for information about one group.
BuiltIn	Whether the group is a standard group automatically available on the BlackPearl system.
Id	The UUID for the group.
Name	The name of the group.

Example

Sample Request

This request gets information about all groups on the BlackPearl system.

GET http://blackpearl-hostname/_rest_/group/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Group>
      <BuiltIn>TRUE</BuiltIn>
      <Id>50993790-d245-41cf-bbde-f3aa5d9f717c</Id>
      <Name>Administrators</Name>
   </Group>
   <Group>
      <BuiltIn>FALSE</BuiltIn>
      <Id>dd73394b-fae6-4a35-b1f3-cfe8fd71ee2d</Id>
      <Name>group1</Name>
   </Group>
</Data>