{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/groups/create.json","auth":"required","settings":"559288b86bf22f170075b794","examples":{"codes":[]},"method":"post","params":[{"name":"groupName","type":"string","default":"","desc":"The name of the group","required":true,"in":"body","ref":"","_id":"5593de970e82e81700334e2d"},{"name":"adminEmails","type":"string","default":"","desc":"The email address of the group administrator","required":true,"in":"body","ref":"","_id":"5593de970e82e81700334e2c"},{"name":"configName","type":"string","default":"","desc":"The configuration name for the group","required":true,"in":"body","ref":"","_id":"5593de970e82e81700334e2b"},{"name":"parentGroupName","type":"string","default":"","desc":"The name of the parent group","required":true,"in":"body","ref":"","_id":"5593de970e82e81700334e2a"},{"name":"description","type":"string","default":"","desc":"Additional description about the group","required":false,"in":"body","ref":"","_id":"5593de970e82e81700334e29"},{"name":"bgColor","type":"string","default":"","desc":"The background color of the group","required":false,"in":"body","ref":"","_id":"559431520c33bd0d0005959e"},{"name":"textColor","type":"string","default":"","desc":"The text color of the group","required":false,"in":"body","ref":"","_id":"559431520c33bd0d0005959d"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\"restResponseVO\":\n  { \n    \"code\":200\n        \"message\":\"Success\"\n        \"reason\":\"\"\n        \"generatedAt\":\"Dec-07-2015, 09:08 AM UTC\"\n        \"currentPage\":null\n        \"totalPages\":null\n   }\n}","name":""}]}},"next":{"description":"","pages":[]},"title":"Create","type":"endpoint","slug":"create-groups","excerpt":"Use this API to create groups that can be used to manage your fleet. Different groups have different configurations and each group has an administrator. Nesting of groups is also possible. Default Group is considered as the parent of all groups.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/groups/create.json\",\n  \"title\": \"Sample Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"groupName\\\":\\\"West Coast\\\",\\n   \\\"adminEmails\\\":\\\"danielmayers:::at:::azuga.com\\\",\\n   \\\"configName\\\":\\\"Default Configuration\\\",\\n   \\\"parentGroupName\\\":\\\"Scott\\\",\\n   \\\"description\\\":\\\"Audi A-6\\\",\\n   \\\"bgColor\\\":\\\"#ffffff\\\",\\n   \\\"textColor\\\":\\\"#000000\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Sample Payload\"\n    }\n  ]\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\": \"The reason for failure\",\n    \"1-0\": \"message\",\n    \"2-0\": \"generatedAt\",\n    \"3-0\": \"reason\",\n    \"4-0\": \"currentPage\",\n    \"4-1\": \"The current page\",\n    \"5-0\": \"totalPages\",\n    \"5-1\": \"The total number of pages in the result\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5593de970e82e81700334e28","editedParams":true,"githubsync":"","user":"55926c39cf9cdb2100b57022","__v":2,"parentDoc":null,"project":"55926c913735880d005f7c65","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"},"createdAt":"2015-07-01T12:35:35.741Z","editedParams2":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"}}

postCreate

Use this API to create groups that can be used to manage your fleet. Different groups have different configurations and each group has an administrator. Nesting of groups is also possible. Default Group is considered as the parent of all groups.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

groupName:
required
string
The name of the group
adminEmails:
required
string
The email address of the group administrator
configName:
required
string
The configuration name for the group
parentGroupName:
required
string
The name of the parent group
description:
string
Additional description about the group
bgColor:
string
The background color of the group
textColor:
string
The text color of the group

Result Format


Documentation

[block:callout] { "type": "info", "body": "https://api.azuga.com/azuga-ws/v1/groups/create.json", "title": "Sample Request" } [/block] [block:code] { "codes": [ { "code": "{ \n \"groupName\":\"West Coast\",\n \"adminEmails\":\"[email protected]\",\n \"configName\":\"Default Configuration\",\n \"parentGroupName\":\"Scott\",\n \"description\":\"Audi A-6\",\n \"bgColor\":\"#ffffff\",\n \"textColor\":\"#000000\"\n}", "language": "json", "name": "Sample Payload" } ] } [/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": "The reason for failure", "1-0": "message", "2-0": "generatedAt", "3-0": "reason", "4-0": "currentPage", "4-1": "The current page", "5-0": "totalPages", "5-1": "The total number of pages in the result" }, "cols": 2, "rows": 6 } [/block]

User Information

Try It Out

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