{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id/services","auth":"required","settings":"59a75f6e757d030019b85f83","results":{"codes":[{"status":200,"language":"json","code":"{\n \"transactionId\": \"51b26657ec5af1bc2929cac4\"\n}","name":""},{"status":400,"language":"json","code":"{\n \"errorType\": \"InvalidParams\",\n \"errors\": [\n {\n \"in\": \"path\",\n \"message\": \"invalid id\",\n \"path\": \"id\"\n }\n ]\n}","name":"Environment Invalid"},{"status":400,"name":"No Query String Allowed","language":"json","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}"},{"status":400,"name":"Body Parameters Missing","language":"text","code":"{\n \"errorType\": \"InvalidParams\",\n \"errors\": [\n {\n \"in\": \"body\",\n \"message\": \"field is required\",\n \"path\": \"properties\"\n }\n ]\n}"},{"status":404,"name":"Environment Not Found","language":"text","code":"Environment with id E59eb8eae278b6bf402e39d21 does not exist."}]},"examples":{"codes":[{"language":"http","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}"},{"name":"Droplit SDK","language":"javascript","code":"droplit.environments.setMultiCommand(\"E5b2a161cef0f54dce4af2fa7\", [ { \"name\" : \"BinarySwitch.switch\", \"value\" : \"on\" }, { \"name\" : \"LightColor.brightness\", \"value\" : 100 } ]);"}]},"method":"put","params":[{"name":"id","type":"string","default":"","desc":"The ID of the environment","required":true,"in":"path","ref":"","_id":"59c32759190c90003cb0d067"},{"name":"properties","type":"string","default":"","desc":"List of service properties and their desired values","required":true,"in":"body","ref":"","_id":"59c32953185f99001034d946"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token","required":true,"in":"header","ref":"","_id":"5ab264e332b3f000537d6439"},{"name":"content-type","type":"string","default":"","desc":"Specify that the sent data will be a JSON object","required":true,"in":"header","ref":"","_id":"5ab264e332b3f000537d6438"}]},"next":{"description":"","pages":[]},"title":"Update Multiple Service Properties","type":"endpoint","slug":"environments-services-alter","excerpt":"","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.","updates":[],"order":9,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ab25cda63b5010012c31685","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Environments API","slug":"environments-api","order":21,"from_sync":false,"reference":false,"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-20T23:34:24.298Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-03-21T13:23:38.271Z","githubsync":"","__v":12,"parentDoc":null}
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