{"_id":"5b57753ca599780003538ce7","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":"59c7e975c50cf30010d712a0","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-24T17:20:53.835Z","from_sync":false,"order":27,"slug":"zones-api","title":"Zones API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":13,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-24T18:51:40.307Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": \"Z5b687a5a9c4c75202c9e8bad;zone_sample2;Z5b687a5a9c4c75202c9e8bad\",\n    \"name\": \"zone_sample2\",\n    \"ecosystemId\": \"C5b50b80d5bc07b172c2b83cc\",\n    \"behaviorId\": \"Z5b687a5a9c4c75202c9e8bad;zone_sample2\",\n    \"scopeId\": \"5b687a5a9c4c75202c9e8bad\",\n    \"scopeType\": \"Zone\",\n    \"targetId\": \"Z5b687a5a9c4c75202c9e8bad\",\n    \"targetType\": \"Zone\",\n    \"createdAt\": \"2018-08-06T23:40:37.287Z\",\n    \"parameters\" : {\n  \t\t\":::at:::device\" : \"D5b99ebf892b2fef169b8c2e7\",\n    \t\"@group\" : [\n    \t\t\"D5b195b08a2922e816cb872e1\",\n      \t\"D5b1853075589c66a89e7cbe3\"\n    \t],\n    \t\"@value\" : {\n    \t\t\"number\" : 50,\n     \t \t\"boolean\" : true\n    \t}\n    },\n    \"environmentId\": \"E5b53915869845322c88efbe8\",\n    \"zoneId\": \"Z5b687a5a9c4c75202c9e8bad\"\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":"Zone Invalid"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        }\n    ]\n}","language":"json","name":"Parameters Invalid","status":400},{"code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"behaviorId\",\n            \"message\": \"A record with this behaviorId already exists\"\n        }\n    ]\n}","language":"json","name":"Behavior Already Enabled","status":400},{"code":"Zone with id Zcbe071cefab84b43ac8510b1 does not exist.","language":"text","name":"Zone Not Found","status":404},{"code":"behaviorId with id Zcbe071cefab84b43ac8510b1;invalid does not exist.","language":"text","name":"Behavior Not Found","status":404}]},"settings":"59a85c5502c545000f08a7a5","examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/zones/Z5b924aa62cf841b0612958ba/behaviors/Z5b924aa62cf841b0612958ba;zone_sample/enable HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"parameters\" : {\n  \t\"@device\" : \"D5b99ebf892b2fef169b8c2e7\",\n    \"@group\" : [\n    \t\"D5b195b08a2922e816cb872e1\",\n      \"D5b1853075589c66a89e7cbe3\"\n    ],\n    \"@value\" : {\n    \t\"number\" : 50,\n      \"boolean\" : true\n    }\n  }\n}","language":"http"}]},"method":"post","auth":"required","params":[{"_id":"5b5776d6a599780003538cf8","ref":"","in":"path","required":true,"desc":"The ID of the zone.","default":"","type":"string","name":"id"},{"_id":"5b5776d6a599780003538cf7","ref":"","in":"path","required":true,"desc":"The ID of the behavior to be enabled.","default":"","type":"string","name":"behaviorId"},{"_id":"5b577ccfe6febb00033f483d","ref":"","in":"body","required":false,"desc":"The parameters, a JSON object, to be passed to the behavior upon enablement.","default":"","type":"object","name":"parameters"},{"_id":"5b577ccfe6febb00033f483c","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b59f10ba7e53200034135bb","ref":"","in":"header","required":false,"desc":"The MIME type of the passed parameters object.","default":"","type":"string","name":"content-type"}],"url":"/:id/behaviors/:behaviorId/enable"},"isReference":false,"order":27,"body":"","excerpt":"Allow a behavior within a zone to be run.","slug":"enable-a-behavior","type":"endpoint","title":"Enable a behavior."}

postEnable a behavior.

Allow a behavior within a zone to be run.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the zone.
behaviorId:
required
string
The ID of the behavior to be enabled.

Body Params

parameters:
object
The parameters, a JSON object, to be passed to the behavior upon enablement.

Headers

authorization:
required
string
The user's authorization token.
content-type:
string
The MIME type of the passed parameters object.

Examples


Result Format


User Information

Try It Out

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