{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id/conduit-activations/:activationId/local-devices","auth":"required","results":{"codes":[{"name":"With 'expand'","code":"{\n    \"items\": [\n        {\n            \"localId\": \"218151977773\",\n            \"customName\": \"Droplit EMS\",\n            \"localData\": {\n              \"redacted for brevity\" : true\n            },\n            \"isProvisioned\": false,\n            \"environments\": []\n        }\n    ]\n}","language":"json","status":200},{"name":"Without 'expand'","code":"{\n    \"items\": [\n        {\n            \"localId\": \"211152974770\",\n            \"customName\": \"Droplit EMS\",\n            \"isProvisioned\": false,\n            \"environments\": []\n        }\n    ]\n}","language":"json","status":200},{"status":400,"name":"Conduit Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"},{"status":400,"name":"Activation Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"activationId\",\n            \"message\": \"invalid activation id\"\n        }\n    ]\n}"},{"name":"Query Parameter Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"#\",\n            \"message\": \"property query is used for a schema that does not allow additional properties\"\n        }\n    ]\n}","status":400},{"name":"'expand' Value Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"expand/0\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}","status":400},{"name":"Conduit Not Found","language":"text","code":"Conduit with id 5b953b5d9f3a047a92805282 does not exist.","status":404},{"name":"Activation Not Found","language":"text","code":"Conduit Activation with id 5b953b7f8c21b8895af74771 does not exist.","status":404}]},"settings":"59f773da3624640026dc9e8e","params":[{"name":"id","type":"string","default":"","desc":"The ID of the conduit.","required":true,"in":"path","ref":"","_id":"5b464e2e3dcb6a0003c6dcbf"},{"name":"activationId","type":"string","default":"","desc":"The ID of the conduit activation whose devices are to be listed.","required":true,"in":"path","ref":"","_id":"5b464e2e3dcb6a0003c6dcbe"},{"name":"pageSize","type":"int","default":"1000","desc":"The number of devices to be returned per request. The minimum is 1, and the maximum is 1000.","required":false,"in":"query","ref":"","_id":"5b464e2e3dcb6a0003c6dcbd"},{"name":"continuationToken","type":"string","default":"","desc":"Used in a subsequent request to obtain the next page of devices. See [Pagination](doc:pagination) for more details.","required":false,"in":"query","ref":"","_id":"5b464e2e3dcb6a0003c6dcbc"},{"name":"expand","type":"string","default":"","desc":"If set to `LocalData`, will display each device's plethora of local data.","required":false,"in":"query","ref":"","_id":"5b46574a82b06a000332bb7f"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b46585b82b06a000332bb95"}],"examples":{"codes":[{"name":"With 'expand'","language":"http","code":"GET https://ioe.droplit.io/api/conduits/5b953e5d3f3a049a9380828b/conduit-activations/5b953b7f7c24b8a959f77773/local-devices?pageSize=100&expand=LocalData HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"Without 'expand'","language":"http","code":"GET https://dev-ioe.droplit.io/api/conduits/5b953e5d3f3a049a9380828b/conduit-activations/5b953b7f7c24b8a959f77773/local-devices?pageSize=100 HTTP/1.1\nauthorization: AUTH_TOKEN"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List local devices.","type":"endpoint","slug":"list-local-devices","excerpt":"Get all of the local devices operating through a conduit activation.","body":"","updates":[],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b4644eb8f31a5000308f918","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Conduits API","slug":"conduits-api","order":17,"from_sync":false,"reference":false,"_id":"59f76fef8581dc0010593e6f","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-10-30T18:31:11.732Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-07-11T17:56:59.207Z","githubsync":"","__v":10,"parentDoc":null}

getList local devices.

Get all of the local devices operating through a conduit activation.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the conduit.
activationId:
required
string
The ID of the conduit activation whose devices are to be listed.

Query Params

pageSize:
integer1000
The number of devices to be returned per request. The minimum is 1, and the maximum is 1000.
continuationToken:
string
Used in a subsequent request to obtain the next page of devices. See [Pagination](doc:pagination) for more details.
expand:
string
If set to `LocalData`, will display each device's plethora of local data.

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


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