{"_id":"59c07e176466f9001050950a","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":29,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T01:00:48.384Z","from_sync":false,"order":18,"slug":"devices-api","title":"Devices API"},"user":"58cc41f21751ce2f003be3b7","__v":7,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-19T02:16:55.237Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/devices HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"environmentId\" : \"E5a870afa39ab8f8c2286aa97\",\n\t\"alias\" : \"newDevice\",\n\t\"services\" : [\n\t\t\"Thermostat\",\n\t\t\"Temperature\"\n\t],\n\t\"localId\" : \"231155978771\",\n\t\"conduitActivationId\" : \"5ba5377f4c29b8b95af79773\"\n}","language":"http"},{"code":"droplit device create --environmentId E5a870afa39ab8f8c2286aa97","language":"text","name":"Console"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": \"D5b963e3e4a782a30bb227301\",\n    \"ecosystemId\": \"C5751a3f3f3d9f27e3e61b131\",\n    \"environmentId\": \"E5a870afa39ab8f8c2286aa97\",\n    \"type\": \"physical\",\n    \"localId\": \"231155978771\",\n    \"meta\": {},\n    \"conduitType\": \"droplit-ecobee-ems\",\n    \"conduitId\": \"5bc53e5d8f33048a9a80b286\",\n    \"conduitActivationId\": \"5ba5377f4c29b8b95af79773\",\n    \"services\": [\n        \"Thermostat\",\n        \"Temperature\"\n    ],\n    \"createdAt\": \"2018-07-11T17:07:09.777Z\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"required properties are missing: environmentId\"\n        }\n    ]\n}","name":"Missing Required Body Parameter"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        }\n    ]\n}","language":"text","name":"Invalid Body Parameter","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/environmentId\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}","language":"json","name":"Invalid Environment","status":400},{"code":"Environment with id E5a770afa99ac8f8c21865a91 does not exist.","language":"text","name":"Environment Not Found","status":404}]},"settings":"59a750fbd61777001b6c47ed","auth":"required","params":[{"_id":"59c07e176466f9001050950e","ref":"","in":"body","required":true,"desc":"The ID of the environment to which the device will be provisioned.","default":"","type":"string","name":"environmentId"},{"_id":"59c07e176466f9001050950c","ref":"","in":"body","required":false,"desc":"A user-defined, human-readable name for the device.","default":"","type":"string","name":"alias"},{"_id":"59c07e176466f9001050950d","ref":"","in":"body","required":false,"desc":"Any metadata to be associated with the device.","default":"","type":"object","name":"meta"},{"_id":"59c07e176466f9001050950b","ref":"","in":"body","required":false,"desc":"The names of the service classes the device is to implement.","default":"","type":"array_string","name":"services"},{"_id":"5b463aae7a339100038909b1","ref":"","in":"body","required":false,"desc":"The conduit-provided ID of a physical local device.","default":"","type":"string","name":"localId"},{"_id":"5b463aae7a339100038909b0","ref":"","in":"body","required":false,"desc":"The ID of the conduit activation to which a physical local device is to be attached.","default":"","type":"string","name":"conduitActivationId"},{"_id":"5b463aae7a339100038909af","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"59c07e176466f9001050950f","ref":"","in":"header","required":false,"desc":"May be set to a custom metadata prefix.","default":"$","type":"string","name":"x-system-metadata-prefix"}],"url":"/"},"isReference":false,"order":1,"body":"An account token, server token, or user token may be used to run this endpoint.","excerpt":"","slug":"devices-create","type":"endpoint","title":"Create a device."}

postCreate a device.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

environmentId:
required
string
The ID of the environment to which the device will be provisioned.
alias:
string
A user-defined, human-readable name for the device.
meta:
object
Any metadata to be associated with the device.
services:
array of strings
The names of the service classes the device is to implement.
localId:
string
The conduit-provided ID of a physical local device.
conduitActivationId:
string
The ID of the conduit activation to which a physical local device is to be attached.

Headers

authorization:
required
string
The user's authorization token.
x-system-metadata-prefix:
string$
May be set to a custom metadata prefix.

Examples


Result Format


Documentation

An account token, server token, or user token may be used to run this endpoint.

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