{"_id":"59c32759190c90003cb0d065","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":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-20T23:34:24.298Z","from_sync":false,"order":12,"slug":"environments-api","title":"Environments API"},"user":"58cc41f21751ce2f003be3b7","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-21T02:43:37.691Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a75f6e757d030019b85f83","auth":"required","params":[{"_id":"59c32759190c90003cb0d067","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59c32759190c90003cb0d066","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"selector"}],"url":"/:id/services/:selector"},"isReference":false,"order":8,"body":"# Details\n\nList specific service properties of devices in an environment.\n\nThis endpoint retrieves the specified service selector property from all devices in the environment on which the property is defined. All properties of a specific service class can be retrieved, by using the name of the service class as the path selector, or a specific property can be retrieved, by using the name of the service class followed by the property name. When specific property names are used, only one property can be retrieved at a time.\n\nFor example, use “LightColor” to retrieve all properties of the LightColor service class, among all devices that implement that class. Use “LightColor.hue” to retrieve all values of LightColor.hue among the devices which implement it.\nEach property retrieved is contained in its own JSON object within the response array.\n\nIf desired, the “refresh” parameter can be used to make sure that service selectors are specified properly. If this parameter is specified, the endpoint will explicitly reject service selectors that do not exist. By default, the endpoint ignores malformed service selectors, and in those cases returns an empty array of property information.\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 the [environment](https://docs.droplit.io/docs/containers#section-environments).\n- selector (required): The fully qualified name of the service, as “SERVICE-NAME.PROPERTY.”\n\n## query\n\n- refresh (optional): Refresh the value of a service property, rather than getting its cached value. Default is false.\n\n# Responses\n\n## 200\n\n```\n{\n    \"items\": [\n        {\n            \"ecosystemId\": \"ECOSYSTEM-ID\",\n            \"id\": \"ENVIRONMENT-ID\",\n            \"index\": \"SERVICE-INDEX\",\n            \"modifiedAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\",\n            \"property\": \"SERVICE-PROPERTY-NAME\",\n            \"service\": \"SERVICE-NAME\",\n            \"value\": \"SERVICE-PROPERTY-VALUE\"\n        }\n    ]\n}\n```\n\n## 400\n\n- __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment 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- __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does.\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/environments/ENVIRONMENT-ID/services/SERVICE-SELECTOR HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit environment get ENVIRONMENT-ID SERVICE-PROPERTY\n```","excerpt":"","slug":"environments-services-list","type":"endpoint","title":"List specific service properties of devices in an environment."}

getList specific service properties of devices in an environment.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
selector:
required
string

Documentation

# Details List specific service properties of devices in an environment. This endpoint retrieves the specified service selector property from all devices in the environment on which the property is defined. All properties of a specific service class can be retrieved, by using the name of the service class as the path selector, or a specific property can be retrieved, by using the name of the service class followed by the property name. When specific property names are used, only one property can be retrieved at a time. For example, use “LightColor” to retrieve all properties of the LightColor service class, among all devices that implement that class. Use “LightColor.hue” to retrieve all values of LightColor.hue among the devices which implement it. Each property retrieved is contained in its own JSON object within the response array. If desired, the “refresh” parameter can be used to make sure that service selectors are specified properly. If this parameter is specified, the endpoint will explicitly reject service selectors that do not exist. By default, the endpoint ignores malformed service selectors, and in those cases returns an empty array of property information. An account token, server token, or user token may be used to run this endpoint. # Parameters ## path - id (required): The ID of the [environment](https://docs.droplit.io/docs/containers#section-environments). - selector (required): The fully qualified name of the service, as “SERVICE-NAME.PROPERTY.” ## query - refresh (optional): Refresh the value of a service property, rather than getting its cached value. Default is false. # Responses ## 200 ``` { "items": [ { "ecosystemId": "ECOSYSTEM-ID", "id": "ENVIRONMENT-ID", "index": "SERVICE-INDEX", "modifiedAt": "YYYY-MM-DD HH:MM:SS ENCODED", "property": "SERVICE-PROPERTY-NAME", "service": "SERVICE-NAME", "value": "SERVICE-PROPERTY-VALUE" } ] } ``` ## 400 - __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment 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 - __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does. - __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/environments/ENVIRONMENT-ID/services/SERVICE-SELECTOR HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit environment get ENVIRONMENT-ID SERVICE-PROPERTY ```

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