Get All Groups
get
/rest/v16/groups
This endpoint retrieves a list of all groups.
Request
Query Parameters
-
excludeLinks: string
Exclude given link types from response. Supported only with produces type application/json.Allowed Values:
[ "self", "child", "parent", "canonical", "next", "prev", "related" ]
-
expand: string
Allows expansion of relationships.Allowed Values:
[ "users" ]
-
fields: string
Group fields to be returned in response.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of fields to order the response by.
-
q: string
Criteria to filter the groups. By default no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
List of groups.
Root Schema : group-collection
Type:
Show Source
object
-
items:
array List of Groups
Title:
List of Groups
List of groups.
Nested Schema : List of Groups
Type:
array
Title:
List of Groups
List of groups.
Show Source
-
Array of:
object Group
Title:
Group
User group information
Nested Schema : Group
Type:
object
Title:
Group
User group information
Show Source
-
label:
string
Title:
Group Name
Group name -
type:
string
Title:
Group Type
Type of the group -
variableName:
string
Title:
Group Variable Name
Variable name of the group
Examples
The following example retrieves a list of all groups by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/groups?limit=2 amp;totalResults=true
Response Body Sample
{ "items": [{ "label": "100k Parts", "variableName": "a100kparts", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 0, "displayValue": "Sales" }, "readOnly": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/a100kparts" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/a100kparts/users" } ] }, { "label": "No Longer Used 07", "variableName": "excludeMDBParts", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 0, "displayValue": "Sales" }, "readOnly": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/excludeMDBParts" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/excludeMDBParts/users" } ] } ], "offset": 0, "limit": 2, "count": 2, "totalResults": 101, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/groups" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/groups?offset=0&limit=2&totalResults=true" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v16/groups?offset=2&limit=2&totalResults=true" } ] }