This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong. ==== group ==== Retrieve status of a group, group tree and optionally the assigned controllers. === Description === <code>https://api.eze.io/v1/group/{mode}/["systems"]</code> The API key used will determine the starting group. === Parameters === | ''mode'' | The mode of the request. See below. | | ''"systems"'' | If given, the command will return all the ezeio controllers in each group. | Possible modes are: ''one'' : The root group of the API key.\\ ''tree'' : The whole tree of groups, starting with the root group of the API key.\\ ''flat'' : Like ''tree'' but as a flat array.\\ ''{groupno}'' : If a group id number is given, return data on this group only. === Example usage === Fetch data for the API key's group, and the controllers therein: <code>https://api.eze.io/v1/group/one/systems</code> Fetch data for a specific group (id=56): <code>https://api.eze.io/v1/group/56</code> Fetch data for all groups and all controllers: <code>https://api.eze.io/v1/group/tree/systems</code> === Return value === JSON formatted data //(below examples have whitespaces added for readability)// This shows data from a call requesting hierarchical data including controllers: <code javascript> { "reqtime":"2019-06-16T21:27:12Z", "groups":[ { "id":"2", "name":"ACME Inc", "description":"ACME IoT System", "is_account":"1", "systems":[ { "ezeid":"XYZ001", "name":"West monitor", "note":null }, { "ezeid":"XYZ002", "name":"East monitor", "note":"No special note" } ], "children":[ { "id":"55", "name":"Client A", "description":"", "is_account":"0", "systems":[ { "ezeid":"XYZ101", "name":"Client A demo unit", "note":null } ] }, { "id":"56", "name":"Client C", "description":"", "is_account":"0", "systems":[ { "ezeid":"XYZ103", "name":"Home office", "note":null } ] } ] } ], "status":"OK", "exec_time":0.029423952102661133 } </code> ezeio2/apiref/group.txt Last modified: 2019-09-02 18:42by 127.0.0.1 Log In