{"_id":"59d840ed341fa5001c3c4c7a","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c7e975c50cf30010d712a0","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-24T17:20:53.835Z","from_sync":false,"order":17,"slug":"zones-api","title":"Zones API"},"user":"58cc41f21751ce2f003be3b7","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-07T02:50:21.310Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a85c5502c545000f08a7a5","auth":"required","params":[{"_id":"59d840ed341fa5001c3c4c7d","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59d840ed341fa5001c3c4c7c","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"selector"},{"_id":"59d840ed341fa5001c3c4c7b","ref":"","in":"query","required":false,"desc":"","default":"","type":"boolean","name":"refresh"}],"url":"/:id/services/:selector"},"isReference":false,"order":11,"body":"# Details\n\nList the given service selector property from devices in a zone.\n\nIf the property is not implemented on a device within a zone, that device is skipped.\n\nAn account token, server token, or user token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- id (required): The ID of a [zone](https://docs.droplit.io/docs/containers#section-zones).\n- selector (required): The fully qualified name of the [service](https://docs.droplit.io/docs/service-class), as “SERVICE-NAME.PROPERTY.”\n\n## query\n\n- refresh (optional): Refresh the value of a [service class](https://docs.droplit.io/docs/service-class) property, rather than getting its cached value. Default is false.\n\n# Responses\n\n## 200\n\n```\n{\n    \"id\": \"ZONE-ID\",\n    \"service\": \"SERVICE-NAME\",\n    \"index\": \"SERVICE-INDEX\",\n    \"property\": \"SERVICE-PROPERTY-NAME\",\n    \"value\": \"SERVICE-PROPERTY-VALUE\",\n    \"ecosystemId\": \"ECOSYSTEM-ID\",\n    \"modifiedAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\"\n}\n```\n\n## 400\n\n- __Zone Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the ID given for a zone was not valid.\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n- __Service Property Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid selector. In this context, it means that the service property given does not exist in the specified service.\n\n## 404\n\n- __Zone Not Found:__ This error means that a zone with the given ID was not found, although it existed at some point.\n- __Service Not Found:__ This error means that a service by the given name and/or format was not found.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/zones/ZONE-ID/services/SERVICE-SELECTOR HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit zone get ZONE-ID PROPERTY-NAME\n```","excerpt":"","slug":"zones-services-info-list","type":"endpoint","title":"List the given service selector property from devices in a zone."}

getList the given service selector property from devices in a zone.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
selector:
required
string

Query Params

refresh:
boolean

Documentation

# Details List the given service selector property from devices in a zone. If the property is not implemented on a device within a zone, that device is skipped. An account token, server token, or user token may be used to run this endpoint. # Parameters ## path - id (required): The ID of a [zone](https://docs.droplit.io/docs/containers#section-zones). - selector (required): The fully qualified name of the [service](https://docs.droplit.io/docs/service-class), as “SERVICE-NAME.PROPERTY.” ## query - refresh (optional): Refresh the value of a [service class](https://docs.droplit.io/docs/service-class) property, rather than getting its cached value. Default is false. # Responses ## 200 ``` { "id": "ZONE-ID", "service": "SERVICE-NAME", "index": "SERVICE-INDEX", "property": "SERVICE-PROPERTY-NAME", "value": "SERVICE-PROPERTY-VALUE", "ecosystemId": "ECOSYSTEM-ID", "modifiedAt": "YYYY-MM-DD HH:MM:SS ENCODED" } ``` ## 400 - __Zone Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the ID given for a zone was not valid. - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. - __Service Property Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid selector. In this context, it means that the service property given does not exist in the specified service. ## 404 - __Zone Not Found:__ This error means that a zone with the given ID was not found, although it existed at some point. - __Service Not Found:__ This error means that a service by the given name and/or format was not found. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/zones/ZONE-ID/services/SERVICE-SELECTOR HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit zone get ZONE-ID PROPERTY-NAME ```

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