Table of Contents
- GET /{groupId}
- GET /
- POST /{groupId}/members
- POST /
- DELETE /{groupId}
- DELETE /{groupId}/members/{memberId}
- PUT /{groupId}
Read methods
| Method / Path: | GET /{groupId} |
|---|---|
| Description: | Returns a single group. |
| Path params: | groupId: The group id |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, The group is returned. 404: Not Found, The specified group does not exist. |
| Testing: |
Sample:
/{groupId}
Testing form (click to reveal)
|
| Method / Path: | GET / |
|---|---|
| Description: | Returns a list of groups. |
| Path params: | NONE |
| Optional (query) params: |
filter:
A comma seperated list of filters to limit the results with. A filter is the filter's name followed by a colon ":" and then the value to filter with so it is the form [Filter Name]:[Value to Filter With]. sort: Sort the results based upon a list of comma seperated sorting criteria. In the comma seperated list each type of sorting is specified as a pair such as: limit(Default value=0): The maximum number of results to return for a single request. offset(Default value=0): The index of the first result to return. |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: | 200: OK, A (potentially empty) list of groups. |
| Testing: |
Sample:
/?filter={filter}&sort={sort}&limit=0&offset=0
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST /{groupId}/members |
|---|---|
| Description: | Adds a member to a group. |
| Path params: | groupId: The group id |
| Required (form) params: | member: Member Name |
| Optional (form) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, The member was already member of the group. 204: No Content, The member has been added. 404: Not Found, The specified group does not exist. |
| Testing: |
Sample:
/{groupId}/members
Testing form (click to reveal)
|
| Method / Path: | POST / |
|---|---|
| Description: | Creates a group. |
| Path params: | NONE |
| Required (form) params: | name: Group Name |
| Optional (form) params: |
description:
Group Description roles: Comma-separated list of roles members: Comma-separated list of members |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
201: Created, A new group is created. 400: Bad Request, The request is invalid or inconsistent. |
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | DELETE /{groupId} |
|---|---|
| Description: | Deletes a group. |
| Path params: | groupId: The group id |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
204: No Content, The group has been deleted. 404: Not Found, The specified group does not exist. |
| Testing: |
Sample:
/{groupId}
Testing form (click to reveal)
|
| Method / Path: | DELETE /{groupId}/members/{memberId} |
|---|---|
| Description: | Removes a member from a group |
| Path params: |
groupId:
The group id memberId: The member id |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
204: No Content, The member has been removed. 404: Not Found, The specified group or member does not exist. |
| Testing: |
Sample:
/{groupId}/members/{memberId}
Testing form (click to reveal)
|
| Method / Path: | PUT /{groupId} |
|---|---|
| Description: | Updates a group. |
| Path params: | groupId: The group id |
| Optional (form) params: |
name:
Group Name description: Group Description roles: Comma-separated list of roles members: Comma-separated list of members |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
201: Created, The group has been updated. 400: Bad Request, The specified group does not exist. |
| Testing: |
Sample:
/{groupId}
Testing form (click to reveal)
|