{"_id":"5b413038b6294d00037317c4","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":"59c1a5852cabe5002641a3e7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T23:17:25.014Z","from_sync":false,"order":20,"slug":"ecosystems-a","title":"Ecosystems API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":17,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-07T21:27:20.211Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": \"5b913b874449e3c30ae6432a;newFactor\",\n    \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n    \"name\": \"newFactor\",\n    \"type\": \"serviceEvent\",\n    \"description\": \"new factor\",\n    \"enabled\": true\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        },\n        {\n            \"path\": \"#\",\n            \"message\": \"required properties are missing: name\"\n        }\n    ]\n}","name":"Invalid Body Parameter"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"path\": \"#/type\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}","language":"json","name":"Invalid Type","status":400},{"code":"Ecosystem with id C5a169caef579967db1da459a does not exist.","language":"text","name":"Ecosystem Not Found","status":404}]},"settings":"59a75ffc4836990031f5ec2f","examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/presence/factors HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"name\" : \"newFactor\",\n\t\"description\" : \"new factor\",\n\t\"type\" : \"serviceEvent\",\n\t\"enabled\" : true\n}","language":"http"}]},"method":"post","auth":"required","params":[{"_id":"5b4131123f0f7c00036b2d8a","ref":"","in":"path","required":true,"desc":"The ID of the ecosystem.","default":"","type":"string","name":"id"},{"_id":"5b413287fefeca000362c711","ref":"","in":"body","required":true,"desc":"The name of the new factor. NOTE: This name cannot be changed.","default":"","type":"string","name":"name"},{"_id":"5b413287fefeca000362c710","ref":"","in":"body","required":false,"desc":"A brief description of what the factor is and how it determines presence.","default":"","type":"string","name":"description"},{"_id":"5b413287fefeca000362c70f","ref":"","in":"body","required":false,"desc":"The detection type of the factor.","default":"manual","type":"string","name":"type"},{"_id":"5b413287fefeca000362c70e","ref":"","in":"body","required":false,"desc":"Whether or not the factor is enabled.","default":"false","type":"boolean","name":"enabled"},{"_id":"5b413368fefeca000362c714","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b4f5f5431267e00036ffe25","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object.","default":"","type":"string","name":"content-type"}],"url":"/id:/presence/factors"},"isReference":false,"order":13,"body":"A factor may be one of three detection types:\n\n* `manual`: the factor must be manually triggered\n* `serviceEvent`: the factor will be triggered by the occurrence of a service event\n* `serviceProperty`: the factor will be triggered by an updated service property","excerpt":"Add a presence factor to an ecosystem.","slug":"create-presence-factor","type":"endpoint","title":"Create a presence factor."}

postCreate a presence factor.

Add a presence factor to an ecosystem.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the ecosystem.

Body Params

name:
required
string
The name of the new factor. NOTE: This name cannot be changed.
description:
string
A brief description of what the factor is and how it determines presence.
type:
stringmanual
The detection type of the factor.
enabled:
booleanfalse
Whether or not the factor is enabled.

Headers

authorization:
required
string
The user's authorization token.
content-type:
required
string
Specify that the sent data will be a JSON object.

Examples


Result Format


Documentation

A factor may be one of three detection types: * `manual`: the factor must be manually triggered * `serviceEvent`: the factor will be triggered by the occurrence of a service event * `serviceProperty`: the factor will be triggered by an updated service property

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