{"_id":"5a8f1b3d9ed37a0025df14b2","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":23,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T01:00:48.384Z","from_sync":false,"order":11,"slug":"devices-api","title":"Devices API"},"user":"5a6a26281895510045b2cd40","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-22T19:34:21.439Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a750fbd61777001b6c47ed","results":{"codes":[{"name":"without 'expand'","code":"{\n    \"items\": [\n        {\n            \"id\": \"D5a22e634e44f8cd804132f27\",\n            \"ecosystemId\": \"C59eb8eae278b6bf402e39d25\",\n            \"environmentId\": \"E598b82ae288b6ff4a2e89d22\",\n            \"type\": \"virtual\",\n            \"alias\": \"Light\",\n            \"meta\": {\n                \"$label\": \"Light\"\n            },\n            \"label\": \"Light\",\n            \"services\": [\n                \"BinarySwitch\"\n            ],\n            \"createdAt\": \"2017-12-02T17:43:16.262Z\"\n        }\n    ]\n}","language":"json","status":200},{"name":"with 'expand'","code":"{\n    \"items\": [\n        {\n            \"id\": \"D5a22e634e44f8cd804132f27\",\n            \"ecosystemId\": \"C59eb8eae278b6bf402e39d25\",\n            \"environmentId\": \"E598b82ae288b6ff4a2e89d22\",\n            \"type\": \"virtual\",\n            \"alias\": \"Light\",\n            \"meta\": {\n                \"$label\": \"Light\"\n            },\n            \"label\": \"Light\",\n            \"services\": [\n                \"BinarySwitch\"\n            ],\n            \"serviceProperties\": {\n                \"BinarySwitch\": {\n                    \"0\": {\n                        \"switch\": \"on\"\n                    }\n                }\n            },\n            \"createdAt\": \"2017-12-02T17:43:16.262Z\"\n        }\n    ]\n}","language":"json","status":200},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"field is required\",\n            \"path\": \"environmentId\"\n        }\n    ] \n}","language":"json","status":400,"name":"Environment Missing"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"field must be one of the following values: ServiceProperties\",\n            \"path\": \"expand\"\n        }\n    ]\n}","language":"json","status":400,"name":"Bad Device Flag"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"invalid environment id\",\n            \"path\": \"environmentId\"\n        }\n    ]\n}","language":"json","status":400,"name":"Environment Invalid"},{"code":"Environment with id E491baeae978bfbf4e2e79d22 does not exist.","language":"text","status":404,"name":"Environment Not Found"}]},"examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/devices?environmentId=E598b82ae288b6ff4a2e89d22 HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http","name":"without 'expand'"},{"code":"GET https://ioe.droplit.io/api/devices?environmentId=E598b82ae288b6ff4a2e89d22&expand=ServiceProperties HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http","name":"with 'expand'"},{"code":"droplit device list --environmentId E598b82ae288b6ff4a2e89d22","language":"text","name":"Droplit Console"}]},"method":"get","auth":"required","params":[{"_id":"59c07ac26466f9001050945c","ref":"","in":"query","required":true,"desc":"The ID of the environment","default":"","type":"string","name":"environmentId"},{"_id":"59c07ac26466f9001050945b","ref":"","in":"query","required":false,"desc":"Show a detailed description of the devices' service properties by setting it to \"ServiceProperties\"","default":"","type":"string","name":"expand"}],"url":"/"},"isReference":false,"order":1,"body":"List devices in an environment.\n\nAn account token, server token, or user token may be used to run this endpoint.","excerpt":"","slug":"devices-list","type":"endpoint","title":"List devices in an environment."}

getList devices in an environment.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

environmentId:
required
string
The ID of the environment
expand:
string
Show a detailed description of the devices' service properties by setting it to "ServiceProperties"

Examples


Result Format


Documentation

List devices in an environment. An account token, server token, or user token may be used to run this endpoint.

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 }}