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.
selector (required): The fully qualified name of the service, as “SERVICE-NAME.PROPERTY.”

query

refresh (optional): Refresh the value of a 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

Droplit SDK

droplit.zones.getServiceProperty("ZONE-ID", "SERVICE-SELECTOR");