Groups
  • 23 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Groups

  • Dark
    Light

Article summary


 GET   /groups


Returns a list of groups.

Query Parameters
ParameterTypeDescription
offsetStringSets an offset to the start of the search.
limitIntSets a limit to the number of values returned.
sortStringThe name of a data column to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
qStringA VisualVault REST API Data Query.
Response Codes
CodeDescription
400Bad Request


 POST   /groups


Create a new group.

Body Parameters
ParameterTypeDescription
siteId*GuidID of the site to associate the group.
name*StringThe group name.
descriptionStringThe group description.
Response Codes
CodeDescription
400Bad Request


 GET   /groups/{id}


Get group properties by ID.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
Query Parameters
ParameterTypeDescription
offsetStringSets an offset to the start of the search.
limitIntSets a limit to the number of values returned.


 PUT   /groups/{id}


Update group properties by ID.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
Body Parameters
ParameterTypeDescription
nameStringThe name of the group.
descriptionStringThe group description.


 GET   /groups/{id}/users


Get a list of groups members by group ID.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.
Response Codes
CodeDescription
400Bad Request


 PUT   /groups/{id}/users/{childId}


Add a user to an existing group.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
childId*GuidThe user id.
Response Codes
CodeDescription
201Created


 PUT   /groups/{id}/users


Add multiple users to a group.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
Body Parameters
ParameterTypeDescription
userIdsStringList of users to add to the group.
Response Codes
CodeDescription
201Created


 DELETE   /groups/{id}/users/{childId}


Remove a user from a group.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
childId*GuidThe user id.
Response Codes
CodeDescription
400Bad Request


 DELETE   /groups/{id}/users


Remove multiple users from a group.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
Query Parameters
ParameterTypeDescription
userNameStringName of the user to remove from the group.
Response Codes
CodeDescription
400Bad Request


 GET   /groups/{id}/users/{childId}


Get the user information of a user from a group.

Route Parameters
ParameterTypeDescription
id*GuidThe group id.
childId*GuidThe user id.
Response Codes
CodeDescription
404Not Found

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence