Did you find this summary helpful?
Thank you for your feedback
GET /groups
Returns a list of groups.
Query Parameters
| Parameter | Type | Description |
|---|
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction.- asc: Ascending order
- desc: Descending order
|
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
POST /groups
Create a new group.
Body Parameters
| Parameter | Type | Description |
|---|
| siteId* | Guid | ID of the site to associate the group. |
| name* | String | The group name. |
| description | String | The group description. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
GET /groups/{id}
Get group properties by ID.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
Query Parameters
| Parameter | Type | Description |
|---|
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
PUT /groups/{id}
Update group properties by ID.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
Body Parameters
| Parameter | Type | Description |
|---|
| name | String | The name of the group. |
| description | String | The group description. |
GET /groups/{id}/users
Get a list of groups members by group ID.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
Query Parameters
| Parameter | Type | Description |
|---|
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
PUT /groups/{id}/users/{childId}
Add a user to an existing group.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
| childId* | Guid | The user id. |
Response Codes
| Code | Description |
|---|
| 201 | Created |
PUT /groups/{id}/users
Add multiple users to a group.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
Body Parameters
| Parameter | Type | Description |
|---|
| userIds | String | List of users to add to the group. |
Response Codes
| Code | Description |
|---|
| 201 | Created |
DELETE /groups/{id}/users/{childId}
Remove a user from a group.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
| childId* | Guid | The user id. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
DELETE /groups/{id}/users
Remove multiple users from a group.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
Query Parameters
| Parameter | Type | Description |
|---|
| userName | String | Name of the user to remove from the group. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
GET /groups/{id}/users/{childId}
Get the user information of a user from a group.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The group id. |
| childId* | Guid | The user id. |
Response Codes
| Code | Description |
|---|
| 404 | Not Found |
Was this article helpful?
Thank you for your feedback! Our team will get back to you
