{"_id":"5ab25cda63b5010012c31685","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"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","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f"],"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":21,"slug":"environments-api","title":"Environments API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":12,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-21T13:23:38.271Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"59a75f6e757d030019b85f83","results":{"codes":[{"name":"","code":"{\n    \"transactionId\": \"51b26657ec5af1bc2929cac4\"\n}","language":"json","status":200},{"name":"Environment Invalid","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}","language":"json","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"contains fields that are not allowed: [ query ]\",\n            \"path\": \"additional parameters\"\n        }\n    ]\n}","language":"json","name":"No Query String Allowed","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"message\": \"field is required\",\n            \"path\": \"properties\"\n        }\n    ]\n}","language":"text","name":"Body Parameters Missing","status":400},{"code":"Environment with id E59eb8eae278b6bf402e39d21 does not exist.","language":"text","name":"Environment Not Found","status":404}]},"examples":{"codes":[{"code":"PUT https://ioe.droplit.io/api/environments/E5b2a161cef0f54dce4af2fa7/services HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"properties\": {\n  \t\"BinarySwitch.switch\": \"on\",\n    \"LightColor.brightness\": 100\n  }\n}","language":"http"},{"code":"droplit.environments.setMultiCommand(\"E5b2a161cef0f54dce4af2fa7\", [ { \"name\" : \"BinarySwitch.switch\", \"value\" : \"on\" }, { \"name\" : \"LightColor.brightness\", \"value\" : 100 } ]);","language":"javascript","name":"Droplit SDK"}]},"method":"put","auth":"required","params":[{"_id":"59c32759190c90003cb0d067","ref":"","in":"path","required":true,"desc":"The ID of the environment","default":"","type":"string","name":"id"},{"_id":"59c32953185f99001034d946","ref":"","in":"body","required":true,"desc":"List of service properties and their desired values","default":"","type":"string","name":"properties"},{"_id":"5ab264e332b3f000537d6439","ref":"","in":"header","required":true,"desc":"The user's authorization token","default":"","type":"string","name":"authorization"},{"_id":"5ab264e332b3f000537d6438","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object","default":"","type":"string","name":"content-type"}],"url":"/:id/services"},"isReference":false,"order":9,"body":"Alter the service properties of devices in an environment.\n\nThis endpoint alters the properties of all devices in an environment which implement the service selector to the value given.\n\nAn account token, server token, or user token may be used to run this endpoint.","excerpt":"","slug":"environments-services-alter","type":"endpoint","title":"Update Multiple Service Properties"}

putUpdate Multiple Service Properties


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the environment

Body Params

properties:
required
string
List of service properties and their desired values

Headers

authorization:
required
string
The user's authorization token
content-type:
required
string
Specify that the sent data will be a JSON object

Examples


Result Format


Documentation

Alter the service properties of devices in an environment. This endpoint alters the properties of all devices in an environment which implement the service selector to the value given. An account token, server token, or user token may be used to run this endpoint.

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