Group REST Reference

/group

Methods
GET

Gets the list of Groups

NOTE: Only viewable shared objects will be returned. If a group retrieved contains to object shares the session user does not have permissions to view, the shares will not be returned.

Fields Parameter
Expand

NOTE: Currently, all fields come back on GET all, but the ** indicates fields which will be listed in a future release

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
createdTime
modifiedTime
lces
repositories
definingAssets
userCount
users

Session User has ShareObjects Permission
assets
policies
queries
credentials
dashboardTabs
arcs
auditFiles

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "0",
			"name" : "Full Access",
			"description" : "Full Access group"
		},
		{
			"id" : "2",
			"name" : "Group A",
			"description" : ""
		},
		{
			"id" : "3",
			"name" : "Group B",
			"description" : ""
		},
		{
			"id" : "4",
			"name" : "grunt",
			"description" : ""
		},
		{
			"id" : "5",
			"name" : "Full Access Group 2",
			"description" : ""
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1445894598
}