{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/groups/view.json","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"groupResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Nov-03-2016, 10:09 AM UTC\",\n      \"currentPage\":null,\n      \"totalPages\":null,\n      \"groups\":[  \n         {  \n            \"groupId\":\"b0642c82-528d-11e6-9e4a-335572b83ffa\",\n            \"groupName\":\"West Coast\",\n            \"newGroupName\":null,\n            \"adminEmail\":\"markjane:::at:::azuga.com\",\n            \"configName\":\"Custom-Config\",\n            \"parentGroupName\":\"Default Group\",\n            \"description\":\"\",\n            \"bgColor\":\"#000000\",\n            \"textColor\":\"#ffffff\"\n         }\n      ]\n   }\n}","name":""}]},"settings":"559288b86bf22f170075b794","examples":{"codes":[{"language":"json","code":"","name":""}]},"method":"get","params":[{"name":"groupName","type":"string","default":"","desc":"Name of the group. Either the groupName or groupId is required","required":false,"in":"query","ref":"","_id":"5593de970e82e81700334e2d"},{"name":"groupId","type":"string","default":"","desc":"Unique identifier representing the group. Either the groupName or groupId is required","required":false,"in":"query","ref":"","_id":"58296584286d1f0f00510491"}]},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-groups","excerpt":"This API provides you with information about all groups present in your account.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/groups/view.json?groupName=WestCoast&groupId=d3200100-101b-11e6-8863-a5656842f582\",\n  \"title\": \"Sample Request\"\n}\n[/block]\n##API Response Explanation\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"code\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-1\": \"Reason for failure\",\n    \"1-0\": \"message\",\n    \"2-0\": \"generatedAt\",\n    \"3-0\": \"reason\",\n    \"4-0\": \"currentPage\",\n    \"4-1\": \"Current page of the paginated result\",\n    \"5-0\": \"totalPages\",\n    \"5-1\": \"Total number of pages in the paginated result\",\n    \"7-0\": \"groupName\",\n    \"7-1\": \"Name of the group\",\n    \"9-0\": \"adminEmail\",\n    \"9-1\": \"Email address of the group administrator\",\n    \"10-0\": \"configName\",\n    \"10-1\": \"Configuration assigned to the group\",\n    \"11-0\": \"parentGroupName\",\n    \"11-1\": \"Name of the parent group\",\n    \"12-0\": \"description\",\n    \"12-1\": \"Short text describing the group\",\n    \"13-1\": \"Background color of the label used to identify the group. Accepts color codes in hexadecimal format\",\n    \"13-0\": \"bgColor\",\n    \"14-0\": \"textColor\",\n    \"14-1\": \"Text color of the label used to identify the group. Accepts color codes in hexadecimal format\",\n    \"8-0\": \"newGroupName\",\n    \"8-1\": \"Updated name of the group\",\n    \"6-0\": \"groupId\",\n    \"6-1\": \"Unique identifier representing the group\"\n  },\n  \"cols\": 2,\n  \"rows\": 15\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"559432b45c9eaa2300a862c0","createdAt":"2015-07-01T18:34:28.803Z","project":"55926c913735880d005f7c65","user":"55926c39cf9cdb2100b57022","editedParams":true,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":["5593de970e82e81700334e28","559432b45c9eaa2300a862c0","559433965c9eaa2300a862c4","559433d75c9eaa2300a862c6","559435a85c9eaa2300a862cb"],"title":"GROUPS","slug":"groups","order":7,"from_sync":false,"reference":true,"_id":"5593dcaf0e82e81700334e25","version":"559286c6c39c4b2d00127a71","project":"55926c913735880d005f7c65","__v":5,"createdAt":"2015-07-01T12:27:27.124Z"},"editedParams2":true,"__v":2,"githubsync":""}

getView

This API provides you with information about all groups present in your account.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

groupName:
string
Name of the group. Either the groupName or groupId is required
groupId:
string
Unique identifier representing the group. Either the groupName or groupId is required

Result Format


Documentation

[block:callout] { "type": "info", "body": "https://api.azuga.com/azuga-ws/v1/groups/view.json?groupName=WestCoast&groupId=d3200100-101b-11e6-8863-a5656842f582", "title": "Sample Request" } [/block] ##API Response Explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "0-1": "API Status Code", "1-1": "API Message", "2-1": "API generation timestamp in UTC", "3-1": "Reason for failure", "1-0": "message", "2-0": "generatedAt", "3-0": "reason", "4-0": "currentPage", "4-1": "Current page of the paginated result", "5-0": "totalPages", "5-1": "Total number of pages in the paginated result", "7-0": "groupName", "7-1": "Name of the group", "9-0": "adminEmail", "9-1": "Email address of the group administrator", "10-0": "configName", "10-1": "Configuration assigned to the group", "11-0": "parentGroupName", "11-1": "Name of the parent group", "12-0": "description", "12-1": "Short text describing the group", "13-1": "Background color of the label used to identify the group. Accepts color codes in hexadecimal format", "13-0": "bgColor", "14-0": "textColor", "14-1": "Text color of the label used to identify the group. Accepts color codes in hexadecimal format", "8-0": "newGroupName", "8-1": "Updated name of the group", "6-0": "groupId", "6-1": "Unique identifier representing the group" }, "cols": 2, "rows": 15 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}