GroupResource

The following resources are part of this group:

/groups

Mount Point: /api/rest/groups

POST

Creates a new group.
This method requires admin privileges.

Status codes:

Request Body

element: groups
media types: application/xml
application/json

the group to be created

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

GET

Returns all groups.
This method requires admin privileges.

Status codes:

Parameters

name description type default
start the start value for paging query 0
limit the limit value for paging query -1
sortby sort parameter query
desc sort direction desc or aesc query false

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

/groups/{id}

Mount Point: /api/rest/groups/{id}

The following operations are supported on this resource:

DELETE

Deletes a group.
This method requires admin privileges.

Status codes:

Parameters

name description type default
id the name of the group to delete. path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

PUT

Modifies the given group.
This method requires admin privileges.

Status codes:

Parameters

name description type default
id name of the group to be modified path

Request Body

element: groups
media types: application/xml
application/json

group object to modify

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

GET

Returns a group.
This method requires admin privileges.

Status codes:

Parameters

name description type default
id the id/name of the group path

Response Body

element: groups
media types: application/xml
application/json

the Group with the specified id