{"_id":"5b57e8da58555d0003a9e6ae","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":"59c1a5852cabe5002641a3e7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T23:17:25.014Z","from_sync":false,"order":20,"slug":"ecosystems-a","title":"Ecosystems API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":12,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-25T03:04:58.270Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"code":"PUT https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/behaviors/C5aebfea1278b9bfe02639d21;eco_sample HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n    \"name\": \"eco_sample\",\n    \"engine\": \"1.0\",\n    \"description\": \"new, different description\",\n    \"main\": \"\",\n    \"parameters\": {\n        \":::at:::device1\": {\n            \"type\": \"device\",\n            \"required\": true\n        },\n        \"@device2\": {\n            \"type\": \"device\",\n            \"required\": true\n        },\n        \"@group\": {\n            \"type\": \"group\",\n            \"required\": false\n        },\n        \"@sonos\": {\n            \"type\": \"device\",\n            \"required\": true\n        }\n    },\n    \"constants\": {\n        \"$brightness\": 100,\n        \"$onFull\": {\n            \"BinarySwitch.switch\": \"on\",\n            \"DimmableSwitch.brightness\": \"$brightness\"\n        },\n        \"$off\": {\n            \"BinarySwitch.switch\": \"off\"\n        }\n    },\n    \"schedules\": {\n        \"schedule1\": {\n            \"enabled\": false,\n            \"startOffset\": 0,\n            \"startTime\": \"2018-04-04T00:32:54.813Z\",\n            \"reoccurence\": {\n                \"secondly\": {\n                    \"interval\": 2\n                }\n            }\n        }\n    },\n    \"actions\": {\n        \"turnOn\": {\n            \"sequence\": {\n                \"@device1\": \"$onFull\",\n                \"@device2\": \"$onFull\"\n            }\n        },\n        \"turnOff\": {\n            \"sequence\": {\n                \"@device1\": \"$off\",\n                \"@device2\": \"$off\"\n            }\n        },\n        \"groupOn\": {\n            \"sequence\": [\n                {\n                    \"@group\": \"$onFull\"\n                }\n            ]\n        },\n        \"animation\": {\n            \"timeline\": {\n                \"repeat\": {\n                    \"period\": 4,\n                    \"iterations\": 7\n                },\n                \"0\": {\n                    \"/invoke\": \"turnOff\"\n                },\n                \"0:01\": {\n                    \"@device1\": \"$onFull\"\n                },\n                \"0:02\": [\n                    {\n                        \"@device2\": \"$onFull\"\n                    }\n                ]\n            }\n        },\n        \"animation2\": {\n            \"schedules\": \"schedule1\",\n            \"timeline\": {\n                \"0:0\": {\n                    \"/invoke\": \"turnOff\"\n                },\n                \"0:01\": {\n                    \"@device1\": \"$onFull\",\n                    \"@device2\": \"$onFull\"\n                }\n            }\n        },\n        \"triggerd\": {\n            \"triggers\": {\n                \"hooks\": {\n                    \"@sonos\": {\n                        \"BinarySwitch.switch\": {\"/changed.to\": \"on\"}\n                    }\n                }\n            },\n            \"sequence\": {\"/invoke\": \"animation2\"}\n        }\n    }\n}","language":"http"}]},"settings":"59a75ffc4836990031f5ec2f","results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": \"C5aebfea1278b9bfe02639d21;eco_sample\",\n    \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n    \"name\": \"eco_sample\",\n    \"version\": 1,\n    \"file\": \"{\\\"name\\\":\\\"eco_sample\\\",\\\"engine\\\":\\\"1.0\\\",\\\"description\\\":\\\"new, sample description\\\",\\\"main\\\":\\\"\\\",\\\"parameters\\\":{\\\"@device1\\\":{\\\"type\\\":\\\"device\\\",\\\"required\\\":true},\\\"@device2\\\":{\\\"type\\\":\\\"device\\\",\\\"required\\\":true},\\\"@group\\\":{\\\"type\\\":\\\"group\\\",\\\"required\\\":false},\\\"@sonos\\\":{\\\"type\\\":\\\"device\\\",\\\"required\\\":true}},\\\"constants\\\":{\\\"$brightness\\\":100,\\\"$onFull\\\":{\\\"BinarySwitch.switch\\\":\\\"on\\\",\\\"DimmableSwitch.brightness\\\":\\\"$brightness\\\"},\\\"$off\\\":{\\\"BinarySwitch.switch\\\":\\\"off\\\"}},\\\"schedules\\\":{\\\"schedule1\\\":{\\\"enabled\\\":false,\\\"startOffset\\\":0,\\\"startTime\\\":\\\"2018-04-04T00:32:54.813Z\\\",\\\"reoccurence\\\":{\\\"secondly\\\":{\\\"interval\\\":2}}}},\\\"actions\\\":{\\\"turnOn\\\":{\\\"sequence\\\":{\\\"@device1\\\":\\\"$onFull\\\",\\\"@device2\\\":\\\"$onFull\\\"}},\\\"turnOff\\\":{\\\"sequence\\\":{\\\"@device1\\\":\\\"$off\\\",\\\"@device2\\\":\\\"$off\\\"}},\\\"groupOn\\\":{\\\"sequence\\\":[{\\\"@group\\\":\\\"$onFull\\\"}]},\\\"animation\\\":{\\\"timeline\\\":{\\\"0\\\":{\\\"/invoke\\\":\\\"turnOff\\\"},\\\"repeat\\\":{\\\"period\\\":4,\\\"iterations\\\":7},\\\"0:01\\\":{\\\"@device1\\\":\\\"$onFull\\\"},\\\"0:02\\\":[{\\\"@device2\\\":\\\"$onFull\\\"}]}},\\\"animation2\\\":{\\\"schedules\\\":\\\"schedule1\\\",\\\"timeline\\\":{\\\"0:0\\\":{\\\"/invoke\\\":\\\"turnOff\\\"},\\\"0:01\\\":{\\\"@device1\\\":\\\"$onFull\\\",\\\"@device2\\\":\\\"$onFull\\\"}}},\\\"triggerd\\\":{\\\"triggers\\\":{\\\"hooks\\\":{\\\"@sonos\\\":{\\\"BinarySwitch.switch\\\":{\\\"/changed.to\\\":\\\"on\\\"}}}},\\\"sequence\\\":{\\\"/invoke\\\":\\\"animation2\\\"}}}}\",\n    \"createdAt\": \"2018-08-06T16:31:44.361Z\",\n    \"scopeType\": \"Ecosystem\",\n    \"scopeId\": \"C5aebfea1278b9bfe02639d21\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}","name":"Ecosystem Invalid"},{"status":400,"name":"Behavior File Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"instance.parameters.@device1\",\n            \"message\": \"is not exactly one from <#/definitions/deviceParameter>,<#/definitions/groupParameter>,<#/definitions/valueParameter>\"\n        }\n    ]\n}"},{"status":400,"name":"Behavior File Missing Required Parameter","language":"json","code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"instance\",\n            \"message\": \"requires property \\\"engine\\\"\"\n        }\n    ]\n}"},{"code":"Ecosystem with id C59c342ae8cabfb58277aa196 does not exist.","language":"text","name":"Ecosystem Not Found","status":404}]},"auth":"required","params":[{"_id":"5b57e8372c92e400034b7bfa","ref":"","in":"path","required":true,"desc":"The ID of the ecosystem.","default":"","type":"string","name":"id"},{"_id":"5b57e8372c92e400034b7bf9","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b57f10358555d0003a9e753","ref":"","in":"path","required":true,"desc":"The ID of the behavior to be updated.","default":"","type":"string","name":"behaviorId"},{"_id":"5b57f10358555d0003a9e752","ref":"","in":"body","required":true,"desc":"The new behavior file containing the updated behavior configuration. It need not necessarily be a JSON file.","default":"","type":"file","name":"Behavior File"},{"_id":"5b57f10358555d0003a9e751","ref":"","in":"header","required":true,"desc":"The MIME type of the attached behavior file. Possible types are `application/json`, `application/octet-stream`, and `application/json5`.","default":"","type":"string","name":"content-type"}],"url":"/:id/behaviors/:behaviorId"},"isReference":false,"order":20,"body":"","excerpt":"Alter the properties of a behavior within an ecosystem.","slug":"update-a-behavior-2","type":"endpoint","title":"Update a behavior."}

putUpdate a behavior.

Alter the properties of a behavior within an ecosystem.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the ecosystem.
behaviorId:
required
string
The ID of the behavior to be updated.

Body Params

Behavior:
required
file
The new behavior file containing the updated behavior configuration. It need not necessarily be a JSON file.

Headers

authorization:
required
string
The user's authorization token.
content-type:
required
string
The MIME type of the attached behavior file. Possible types are `application/json`, `application/octet-stream`, and `application/json5`.

Examples


Result Format


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