{"_id":"582789acbe5c080f00a5a851","parentDoc":null,"project":"568bdc1483d2061900d86cdc","user":"568bdbc4fe6fcc0d006dc970","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"__v":0,"category":{"_id":"582789abbe5c080f00a5a803","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-05T15:14:04.838Z","from_sync":false,"order":9,"slug":"something","title":"Devices"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-20T08:34:56.726Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/devices/D573bc694ae9ac9419f028b61/services/BinarySwitch.switch?refresh=true HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"},{"code":"droplit device get D573bc694ae9ac9419f028b61 BinarySwitch.switch --refresh=true","language":"text","name":"droplit console"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"items\": [\n    {\n      \"service\": \"BinarySwitch\",\n      \"index\": \"0\",\n      \"property\": \"switch\",\n      \"value\": \"off\",\n      \"status\": \"Accepted\"\n    }\n  ]\n}","name":""},{"code":"","language":"text","status":401},{"code":"","language":"text","status":403},{"code":"Device with id D573bc694ae9ac9419f028b62 does not exist.","language":"text","status":404}]},"settings":"572c39957c8eff0e00aaa18b","auth":"required","params":[{"_id":"573ecc30edc85919005a8741","ref":"","in":"path","required":true,"desc":"[device](doc:devices) id or [alias](doc:aliases)","default":"","type":"string","name":"id"},{"_id":"573ecc79a233380e005db125","ref":"","in":"path","required":true,"desc":"[property selector](doc:service-selectors)","default":"","type":"string","name":"selector"},{"_id":"573ecd02edc85919005a8746","ref":"","in":"query","required":false,"desc":"forces a refresh of the property value","default":"false","type":"boolean","name":"refresh"}],"url":"/devices/:id/services/:selector"},"isReference":true,"order":7,"body":"You can read the cached state of a device using this endpoint. Droplit.io will respond with the last known state of the service property.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameter notes\"\n}\n[/block]\n## refresh\nSetting `refresh` to true will get the state of the device by querying the device directly rather than returning the cached value. On getting the value, this will also update the cached value. As the device is directly queried, the process may take more time to execute.","excerpt":"Get a single property value","slug":"get-device-property","type":"endpoint","title":"Get Property"}

getGet Property

Get a single property value

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
[device](doc:devices) id or [alias](doc:aliases)
selector:
required
string
[property selector](doc:service-selectors)

Query Params

refresh:
booleanfalse
forces a refresh of the property value

Examples


Result Format


Documentation

You can read the cached state of a device using this endpoint. Droplit.io will respond with the last known state of the service property. [block:api-header] { "type": "basic", "title": "Parameter notes" } [/block] ## refresh Setting `refresh` to true will get the state of the device by querying the device directly rather than returning the cached value. On getting the value, this will also update the cached value. As the device is directly queried, the process may take more time to execute.

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