{"_id":"5b5793a7605ff60003a686e5","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":33,"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","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5"],"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":14,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-24T21:01:27.126Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"processId\": \"inuAl88jh\"\n}","language":"json","status":200},{"name":"Zone Invalid","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}","language":"json","status":400},{"code":"Zone with id Zcbe071cefab84b43ac8510b1 does not exist.","language":"text","name":"Zone Not Found","status":404},{"code":"Behavior with id invalid does not exist.","language":"text","status":404,"name":"Behavior Not Found"},{"code":"Behavior with id invalid does not exist.","language":"text","name":"Action Not Found","status":404}]},"settings":"59a85c5502c545000f08a7a5","examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/zones/Z5b924aa62cf841b0612958ba/behaviors/Z5b924aa62cf841b0612958ba;zone_sample/actions/animation/start HTTP/1.1\nauthorization: AUTH_TOKEN\n\n{\n\t\"parameters\" : {\n  \t\":::at:::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":"5b5794570c8f760003f2fcb8","ref":"","in":"path","required":true,"desc":"The ID of the zone.","default":"","type":"string","name":"id"},{"_id":"5b5794570c8f760003f2fcb7","ref":"","in":"path","required":true,"desc":"The ID of the behavior.","default":"","type":"string","name":"behaviorId"},{"_id":"5b5794570c8f760003f2fcb6","ref":"","in":"path","required":true,"desc":"The name of the action to start.","default":"","type":"string","name":"actionName"},{"_id":"5b579499605ff60003a686ed","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b5b6d38faf2c40003dbcf03","ref":"","in":"body","required":false,"desc":"Custom parameters for a particular action within a behavior. The values of these parameters override the values established when the behavior was enabled.","default":"","type":"object","name":"parameters"}],"url":"/:id/behaviors/:behaviorId/actions/:actionName/start"},"isReference":false,"order":31,"body":"","excerpt":"Invoke a particular action within a behavior.","slug":"start-a-behavior-action","type":"endpoint","title":"Start an action."}

postStart an action.

Invoke a particular action within a behavior.

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.
actionName:
required
string
The name of the action to start.

Body Params

parameters:
object
Custom parameters for a particular action within a behavior. The values of these parameters override the values established when the behavior was enabled.

Headers

authorization:
required
string
The user's authorization token.

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