{"_id":"5b57697fa599780003538bc9","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":16,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-24T18:01:35.337Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"items\": [\n        {\n            \"id\": \"C5aebfea1278b9bfe02639d21;eco_sample\",\n            \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n            \"name\": \"eco_sample\",\n            \"version\": 1,\n            \"createdAt\": \"2018-08-06T16:31:44.361Z\",\n            \"scopeType\": \"Ecosystem\",\n            \"scopeId\": \"C5aebfea1278b9bfe02639d21\",\n            \"enabled\": false\n        },\n        {\n            \"id\": \"E5ba39b58e9835392c38e7be1;env_sample\",\n            \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n            \"name\": \"env_sample\",\n            \"version\": 1,\n            \"createdAt\": \"2018-08-06T16:38:44.157Z\",\n            \"scopeType\": \"Environment\",\n            \"scopeId\": \"E5ba39b58e9835392c38e7be1\",\n            \"environmentId\": \"E5ba39b58e9835392c38e7be1\",\n            \"enabled\": false\n        },\n        {\n            \"id\": \"Z5b924aa62cf841b0612958ba;zone_sample\",\n            \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n            \"name\": \"zone_sample\",\n            \"version\": 1,\n            \"createdAt\": \"2018-08-06T16:45:53.919Z\",\n            \"scopeType\": \"Zone\",\n            \"scopeId\": \"Z5b924aa62cf841b0612958ba\",\n            \"environmentId\": \"E5b53915869845322c88efbe8\",\n            \"zoneId\": \"Z5b924aa62cf841b0612958ba\",\n            \"enabled\": false\n        }\n    ]\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":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"scopeTypes/0\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}","language":"json","name":"scopeTypes Invalid","status":400},{"code":"Zone with id Zcbe071cefab84b43ac8510b1 does not exist.","language":"text","name":"Zone Not Found","status":404}]},"settings":"59a85c5502c545000f08a7a5","examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/zones/Z5b924aa62cf841b0612958ba/behaviors?scopeTypes=Ecosystem,Environment,Local HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"5b5769c5a599780003538bce","ref":"","in":"path","required":true,"desc":"The ID of the zone.","default":"","type":"string","name":"id"},{"_id":"5b5769e5c6af890003de645e","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b577272e6febb00033f4779","ref":"","in":"query","required":false,"desc":"Optionally filter the displayed behaviors by the containers in which they were created. Possible values are `Local`, `Environment`, and `Ecosystem`.","default":"","type":"string","name":"scopeType"},{"_id":"5b68dfcf9ccdd300039cd79c","ref":"","in":"query","required":false,"desc":"When set to `true`, will only list enabled devices.","default":"false","type":"boolean","name":"enabled"}],"url":"/:id/behaviors"},"isReference":false,"order":21,"body":"# Scope Types\n\nThe scope type of a behavior refers to the container in which it was created. A behavior created within a zone will only be accessible by that zone, and, therefore, has the scope type of `Zone`. \n\nAll children containers have access to their parent's behaviors. A behavior with a scope type of  `Environment` will be accessible by all of the zones within that environment. \n\nScope types may be used to filter the behaviors displayed by a listing request. The following scope types are available:\n* `Local`: (default) Only display the behaviors created within the zone.\n* `Environment`: Only display the behaviors created within the parent environment, not any that belong to the zone.\n* `Ecosystem`: Display only the behaviors created within the ecosystem.\n\nMultiple scope types may be set at a time to refine results. For a zone, if `scopeTypes` is set to `Ecosystem`, `Environment`, and `Local`, all of the behaviors available to the zone will be listed; the behaviors of the zone and its parent containers.","excerpt":"List the behaviors accessible to a zone.","slug":"list-behaviors-1","type":"endpoint","title":"List behaviors."}

getList behaviors.

List the behaviors accessible to a zone.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the zone.

Query Params

scopeType:
string
Optionally filter the displayed behaviors by the containers in which they were created. Possible values are `Local`, `Environment`, and `Ecosystem`.
enabled:
booleanfalse
When set to `true`, will only list enabled devices.

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


Documentation

# Scope Types The scope type of a behavior refers to the container in which it was created. A behavior created within a zone will only be accessible by that zone, and, therefore, has the scope type of `Zone`. All children containers have access to their parent's behaviors. A behavior with a scope type of `Environment` will be accessible by all of the zones within that environment. Scope types may be used to filter the behaviors displayed by a listing request. The following scope types are available: * `Local`: (default) Only display the behaviors created within the zone. * `Environment`: Only display the behaviors created within the parent environment, not any that belong to the zone. * `Ecosystem`: Display only the behaviors created within the ecosystem. Multiple scope types may be set at a time to refine results. For a zone, if `scopeTypes` is set to `Ecosystem`, `Environment`, and `Local`, all of the behaviors available to the zone will be listed; the behaviors of the zone and its parent containers.

User Information

Try It Out

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