{"_id":"59c17f19bc639a0032f7753b","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":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T01:00:48.384Z","from_sync":false,"order":10,"slug":"devices-api","title":"Devices API"},"user":"58cc41f21751ce2f003be3b7","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-19T20:33:29.243Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a750fbd61777001b6c47ed","auth":"required","params":[{"_id":"59c17f19bc639a0032f7753e","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59c17f19bc639a0032f7753d","ref":"","in":"query","required":false,"desc":"","default":"","type":"boolean","name":"verify"},{"_id":"59c17f19bc639a0032f7753c","ref":"","in":"body","required":true,"desc":"","default":"","type":"object","name":"properties"}],"url":"/:id/services"},"isReference":false,"order":7,"body":"# Details\n\nAlter the service properties of a device.\n\nThis endpoint can set or unset multiple properties on multiple devices, using the “properties” body object parameter. Each property must be explicitly identified by its service class name (such as “LightColor.brightness.” Properties can be unset by setting their value to “null.”\n\nThe “verify” handles how the user receives a response when setting parameters. When true, the response will wait for the whole property set round trip (from IOE to Edge and back again) and return results for the set parameter (e.g., did Edge accept the command). Otherwise, the response will return success immediately after issuing the request. This parameter is useful because the full round trip may take some time, and not all users may want to wait. By default, verify is false.\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 [device](https://docs.droplit.io/docs/containers#section-devices).\n\n## query\n\n- verify (optional): Defaults to false. When true, wait to return results until the service property set command is completed.\n\n## body\n\n- properties (required): The object that sets service class properties.\n\n# Responses\n\n## 200\n\n- No content returned, only the status code. See the REST API [Standard Responses](https://docs.droplit.io/docs/rest-api-standard-responses) page.\n\n## 400\n\n- __Device Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the ID given for a client is invalid.\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- __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.”\n\n## 404\n\n- __Device Not Found:__ This error means that a device with the given ID was not found. This is distinct from an invalid device ID being specified; this means that the device ID once existed, but no longer does.\n\n# Examples\n\n## HTTP\n\n```\nPUT https://ioe.droplit.io/api/devices/DEVICE-ID/services HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/jaon\n{\n    \"LightColor.hue\": 38047,\n    \"LightColor.saturation\": 57671,\n    \"LightColor.brightness\": 100\n}\n```\n\n## Droplit Console\n\n```\nset property: droplit device set DEVICE-ID PROPERTY-NAME PROPERTY-VALUE\nclear property: droplit device clear DEVICE-ID PROPERTY-NAME\n```","excerpt":"","slug":"devices-services-alter","type":"endpoint","title":"Alter the service properties of a device."}

putAlter the service properties of a device.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

Query Params

verify:
boolean

Body Params

properties:
required
object

Documentation

# Details Alter the service properties of a device. This endpoint can set or unset multiple properties on multiple devices, using the “properties” body object parameter. Each property must be explicitly identified by its service class name (such as “LightColor.brightness.” Properties can be unset by setting their value to “null.” The “verify” handles how the user receives a response when setting parameters. When true, the response will wait for the whole property set round trip (from IOE to Edge and back again) and return results for the set parameter (e.g., did Edge accept the command). Otherwise, the response will return success immediately after issuing the request. This parameter is useful because the full round trip may take some time, and not all users may want to wait. By default, verify is false. An account token, server token, or user token may be used to run this endpoint. # Parameters ## path - id (required): The ID of the [device](https://docs.droplit.io/docs/containers#section-devices). ## query - verify (optional): Defaults to false. When true, wait to return results until the service property set command is completed. ## body - properties (required): The object that sets service class properties. # Responses ## 200 - No content returned, only the status code. See the REST API [Standard Responses](https://docs.droplit.io/docs/rest-api-standard-responses) page. ## 400 - __Device Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the ID given for a client is invalid. - __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. - __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.” ## 404 - __Device Not Found:__ This error means that a device with the given ID was not found. This is distinct from an invalid device ID being specified; this means that the device ID once existed, but no longer does. # Examples ## HTTP ``` PUT https://ioe.droplit.io/api/devices/DEVICE-ID/services HTTP/1.1 authorization: TOKEN content-type: application/jaon { "LightColor.hue": 38047, "LightColor.saturation": 57671, "LightColor.brightness": 100 } ``` ## Droplit Console ``` set property: droplit device set DEVICE-ID PROPERTY-NAME PROPERTY-VALUE clear property: droplit device clear DEVICE-ID PROPERTY-NAME ```

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}