{"_id":"5b538e274ea24f00033c7271","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":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-20T23:34:24.298Z","from_sync":false,"order":21,"slug":"environments-api","title":"Environments API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":28,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-21T19:48:55.266Z","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}","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},{"status":400,"name":"Scopes Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"scopes/0\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}"},{"status":404,"name":"Environment Not Found","language":"text","code":"Environment with id E5b93965bbcd224901acd7694 does not exist."}]},"settings":"59a75f6e757d030019b85f83","examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/environments/E5ba39b58e9835392c38e7be1/behaviors?scopeTypes=Ecosystem,Local HTTP/1.1\nauthorization: AUTH_TOKEN"}]},"method":"get","auth":"required","params":[{"_id":"5b5394d54cf9d80003197899","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b5395334ea24f00033c72a3","ref":"","in":"path","required":true,"desc":"The ID of the environment to be queried.","default":"","type":"string","name":"id"},{"_id":"5b5741ab60a07d0003786ce9","ref":"","in":"query","required":false,"desc":"Optionally filter the displayed behaviors by the containers in which they were created. Possible values are `Local` and `Ecosystem`.","default":"","type":"string","name":"scopeTypes"},{"_id":"5b68e21b03860d0003d906eb","ref":"","in":"query","required":false,"desc":"List only enabled or only disabled behaviors.","default":"","type":"boolean","name":"enabled"}],"url":"/:id/behaviors"},"isReference":false,"order":12,"body":"# Scope Types\n\nThe scope type of a behavior refers to the container in which it was created. A behavior created within an environment will be accessible by that environment and be of scope type `Environment`. \n\nAll children containers have access to their parent's behaviors. A behavior of scope type `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 behaviors created within the environment.\n* `Ecosystem`: Display only the behaviors created within the parent ecosystem.\n\nMultiple scope types may be requested at a time to refine results. For an environment, if `scopeTypes` is set to both `Ecosystem` and `Local`, all of the behaviors available to the environment will be listed; the behaviors of both the environment and its parent container.","excerpt":"List all the behaviors in an environment.","slug":"list-behaviors","type":"endpoint","title":"List behaviors."}

getList behaviors.

List all the behaviors in an environment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the environment to be queried.

Query Params

scopeTypes:
string
Optionally filter the displayed behaviors by the containers in which they were created. Possible values are `Local` and `Ecosystem`.
enabled:
boolean
List only enabled or only disabled behaviors.

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 an environment will be accessible by that environment and be of scope type `Environment`. All children containers have access to their parent's behaviors. A behavior of scope type `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 behaviors created within the environment. * `Ecosystem`: Display only the behaviors created within the parent ecosystem. Multiple scope types may be requested at a time to refine results. For an environment, if `scopeTypes` is set to both `Ecosystem` and `Local`, all of the behaviors available to the environment will be listed; the behaviors of both the environment and its parent container.

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