{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id/behaviors/:behaviorId/enable","auth":"required","results":{"codes":[{"name":"","code":"{\n    \"id\": \"E5b53915869845322c88efbe8;env_sample;E5b53915869845322c88efbe8\",\n    \"name\": \"env_sample\",\n    \"ecosystemId\": \"C5b50b80d5bc07b172c2b83cc\",\n    \"behaviorId\": \"E5b53915869845322c88efbe8;env_sample\",\n    \"scopeId\": \"5b53915869845322c88efbe8\",\n    \"scopeType\": \"Environment\",\n    \"targetId\": \"E5b53915869845322c88efbe8\",\n    \"targetType\": \"Environment\",\n    \"createdAt\": \"2018-08-07T14:13:27.223Z\",\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\"boolean\" : true\n    \t}\n  \t},\n    \"environmentId\": \"E5b53915869845322c88efbe8\"\n}","language":"json","status":200},{"name":"Environment 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":"Environment with id E5b93965bbcd224901acd7694 does not exist.","language":"text","name":"Environment Not Found","status":404},{"code":"behaviorId with id E5b93965bbcd224901acd7694;invalid does not exist.","language":"text","name":"Behavior Not Found","status":404}]},"settings":"59a75f6e757d030019b85f83","params":[{"name":"id","type":"string","default":"","desc":"The ID of the environment.","required":true,"in":"path","ref":"","_id":"5b57d1f02c92e400034b7b29"},{"name":"behaviorId","type":"string","default":"","desc":"The ID of the behavior to be enabled.","required":true,"in":"path","ref":"","_id":"5b57d1f02c92e400034b7b28"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b57d2622c92e400034b7b2f"},{"name":"parameters","type":"object","default":"","desc":"The parameters, a JSON object, to be passed to the behavior upon enablement.","required":false,"in":"body","ref":"","_id":"5b57d2622c92e400034b7b2e"},{"name":"content-type","type":"string","default":"","desc":"The MIME type of the passed parameters object.","required":false,"in":"header","ref":"","_id":"5b59ec064e878f0003fd46c0"}],"examples":{"codes":[{"language":"http","code":"POST https://ioe.droplit.io/api/environments/E5ba39b58e9835392c38e7be1/behaviors/E5ba39b58e9835392c38e7be1;env_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}"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Enable a behavior.","type":"endpoint","slug":"enable-a-behavior-1","excerpt":"Allow a behavior to be run within an environment.","body":"","updates":[],"order":18,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b57d14ee0537300036b4640","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-07-25T01:24:30.915Z","githubsync":"","__v":11,"parentDoc":null}

postEnable a behavior.

Allow a behavior to be run within an environment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the environment.
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 }}