Groups Endpoint

GET /groups

curl -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ http://api.visualvault.com/api/v1/{customeralias}/{databasealias}/groups?q={opt:query}&fields={opt:fields}&expand={opt:expandField}
{
  "meta": {}
}
Returns a list of Groups
Parameters
Key Type Description
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
expandField string (optional) The name of the field you want to expand to show all possible child fields. Use 'data' to expand the entire result set
fields string (optional) A comma delimited list of fields based on the returned datatype
id guid Some ID
query string (optional) The query you want to run

POST /groups/

curl -X POST \ \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ -d '{ "name": "Group Name", "description": "Group Description" }' \ http://api.visualvault.com/api/v1/{customeralias}/{databasealias}/groups/
{
  "meta": {}
}
Creates a new Group
Parameters
Key Type Description
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
id guid description

GET /groups/{id}

curl -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ http://api.visualvault.com/api/v1/{customeralias}/{databasealias}/groups/{id}?q={opt:query}&fields={opt:fields}&expand={opt:expandField}
{
  "meta": {}
}
Gets a group by id
Parameters
Key Type Description
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
expandField string (optional) The name of the field you want to expand to show all possible child fields. Use 'data' to expand the entire result set
fields string (optional) A comma delimited list of fields based on the returned datatype
id guid Some ID
query string (optional) The query you want to run

PUT /groups/{id}

curl -X PUT \ \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ -d '{ "name": "New Group Name", "description": "New Group Description" }' \ http://api.visualvault.com/api/v1/{customeralias}/{databasealias}/groups/{id}
{
  "meta": {}
}
Updates a group
Parameters
Key Type Description
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
id guid Some ID

POST /groups/{id}/users

curl -X POST \ \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ -d '{ "id": "User Id (guid)" }' \ http://api.visualvault.com/api/v1/{customeralias}/{databasealias}/groups/{id}/users
{
  "meta": {}
}
Adds a user to a group
Parameters
Key Type Description
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
id guid Some ID

GET /groups/{id}/users/{childid}

curl -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ http://api.visualvault.com/api/v1/{customeralias}/{databasealias}/groups/{id}/users/{childid}?q={opt:query}&fields={opt:fields}&expand={opt:expandField}
{
  "meta": {}
}
Gets a user from a group
Parameters
Key Type Description
childid guid ID of the Group member
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
expandField string (optional) The name of the field you want to expand to show all possible child fields. Use 'data' to expand the entire result set
fields string (optional) A comma delimited list of fields based on the returned datatype
id guid Some ID
query string (optional) The query you want to run