{"_id":"5b59f187bb94660003b2008c","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c0243b1b2d07001a9d2b76","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-18T19:53:31.813Z","from_sync":false,"order":8,"slug":"tutorial","title":"Tutorial"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T16:06:31.426Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"# Get the environment created by an Edge hub.\n\nWhen a new Edge hub is initialized, an associated environment is created into which all connected devices will be placed. In order to get this environment via the API, the Edge ID of the hub must be known; the ID is generally the hub's MAC address. The Edge ID is added as a query parameter to the normal [environment listing](doc:environments-list) endpoint.\n\nTo list the environment associated with the Edge hub:\n```\nGET https://ioe.droplit.io/api/environments/?ecosystemId=C9ba0b90d2bcc7b87272bb3c2&edgeId=b6:2e:e2:59:0c:21 HTTP/1.1\nauthorization: AUTH_TOKEN\n```\n\n# Get the devices connected to an Edge hub.\n\nWhen a device connects to an Edge hub, the device is added to the environment associated with that hub. When querying the environment's devices for those connected to the hub, a [filter](doc:filters) containing the Edge ID of the hub, generally the hub's MAC address, may be used. This filter is applied as a query parameter to the normal [device listing](doc:devices-list) endpoint in addition to the required environment ID parameter.\n\nTo list the devices connected to an Edge hub:\n```\nGET https://ioe.droplit.io/api/devices/?environmentId=E59e347bc2a0c6199651d6da1&filter=eq(edgeId, \"b6:2e:e2:59:0c:21\") HTTP/1.1\nauthorization: AUTH_TOKEN\n```","excerpt":"A brief tutorial on how to use the API to perform some frequently needed tasks.","slug":"common-api-use-cases","type":"basic","title":"Common API Use Cases"}

Common API Use Cases

A brief tutorial on how to use the API to perform some frequently needed tasks.

# Get the environment created by an Edge hub. When a new Edge hub is initialized, an associated environment is created into which all connected devices will be placed. In order to get this environment via the API, the Edge ID of the hub must be known; the ID is generally the hub's MAC address. The Edge ID is added as a query parameter to the normal [environment listing](doc:environments-list) endpoint. To list the environment associated with the Edge hub: ``` GET https://ioe.droplit.io/api/environments/?ecosystemId=C9ba0b90d2bcc7b87272bb3c2&edgeId=b6:2e:e2:59:0c:21 HTTP/1.1 authorization: AUTH_TOKEN ``` # Get the devices connected to an Edge hub. When a device connects to an Edge hub, the device is added to the environment associated with that hub. When querying the environment's devices for those connected to the hub, a [filter](doc:filters) containing the Edge ID of the hub, generally the hub's MAC address, may be used. This filter is applied as a query parameter to the normal [device listing](doc:devices-list) endpoint in addition to the required environment ID parameter. To list the devices connected to an Edge hub: ``` GET https://ioe.droplit.io/api/devices/?environmentId=E59e347bc2a0c6199651d6da1&filter=eq(edgeId, "b6:2e:e2:59:0c:21") HTTP/1.1 authorization: AUTH_TOKEN ```