Generic REST Server

introduction the generic rest server export module provides a rest service via http and https using the generic iot data model docid\ kecs0ojeas7l0o5gxzaof this is a "single service" module, so only one export instance can be created configuration the module can be activated via the "iot export" area in the web configuration or the bsc remote and the "x api key" can be stored access the service is provided at the following url https //\<ip>/iot/export/generic/things api protection when activating the module, an "x api key" can be configured this is filled with a random string by default if an empty string is stored, access is not protected otherwise the key stored there must be sent with every request in the header field "x api key" endpoints the entry point is the /things end point there all devices are listed with detailed information the other endpoints are used to read out specific information from a device or to make a value change { "name" "retrieve all devices", "method" "get", "url" "https //\<ip>/iot/export/generic/things", "description" "get a list of all available devices objects", "tab" "examples", "examples" { "languages" \[ { "id" "doiebkf85lvp4hs4sllqz", "language" "curl", "code" "curl location request get 'https //\<ip>/iot/export/generic/things' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "2bdu5qpimenxigupfbsmz", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "qwwvgrnpfie4ym20wgvtx", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "mhsliekuiidswpm5yv7a ", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "swjlopag2 h0ldaoh4xbr", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "doiebkf85lvp4hs4sllqz" }, "results" { "languages" \[ { "id" "nnookt2ob3o htd39cscn", "language" "200", "customlabel" "", "code" "\[{\n \\"id\\" \\"b9f09ef8 3c3f 459e 841f 66bdaedff183\\",\n \\"name\\" \\"fsb14\\",\n \\"channelgroups\\" \[{\n \\"channelgroupid\\" \\"sensor group\\",\n \\"channeldescriptiondata\\" null,\n \\"channels\\" \[{\n \\"channelid\\" \\"jalousie\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"shading\\",\n \\"label\\" {\n \\"de de\\" \\"jalousie\\",\n \\"en us\\" \\"shutters\\"\n }\n },\n \\"value\\" \\"0 0\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"number double\\",\n \\"unit\\" \\"%\\",\n \\"min\\" 0 0,\n \\"max\\" 100 0,\n \\"stepping\\" 1 0,\n \\"decimalpartdigits\\" 1,\n \\"possiblevalues\\" null\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousie\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"jalousie\\",\n \\"tsystems >type\\" \\"value\\"\n }\n }, {\n \\"channelid\\" \\"jalousiestate\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"shading\\",\n \\"label\\" {\n \\"de de\\" \\"jalousie\\",\n \\"en us\\" \\"shutters\\"\n }\n },\n \\"value\\" \\"unknown\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"up\\" {\n \\"de de\\" \\"herauf\\",\n \\"en us\\" \\"up\\"\n },\n \\"down\\" {\n \\"de de\\" \\"herunter\\",\n \\"en us\\" \\"down\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousiestate\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"false\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"direction\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }, {\n \\"channelid\\" \\"priority\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"switch\\",\n \\"label\\" {\n \\"de de\\" \\"priorität\\",\n \\"en us\\" \\"priority\\"\n }\n },\n \\"value\\" \\"off\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"on\\" {\n \\"de de\\" \\"an\\",\n \\"en us\\" \\"on\\"\n },\n \\"off\\" {\n \\"de de\\" \\"aus\\",\n \\"en us\\" \\"off\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#priority\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"priority\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }, {\n \\"channelid\\" \\"jalousieslat\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"shading\\",\n \\"label\\" {\n \\"de de\\" \\"jalousie (lamellen)\\",\n \\"en us\\" \\"shutters (slats)\\"\n }\n },\n \\"value\\" \\"unknown\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"up\\" {\n \\"de de\\" \\"herauf\\",\n \\"en us\\" \\"up\\"\n },\n \\"down\\" {\n \\"de de\\" \\"herunter\\",\n \\"en us\\" \\"down\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousieslat\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"jalousieslat\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }]\n }],\n \\"state\\" \\"online\\",\n \\"parametergroups\\" null,\n \\"metainfos\\" {\n \\"alexa >alexa live updates\\" \\"false\\",\n \\"monitoring >monitorable\\" \\"true\\",\n \\"teachin >group displayname\\" \\"test\\",\n \\"bsc >short info\\" \\"fsb14\\",\n \\"metainfo >id\\" \\"adevice#b9f09ef8 3c3f 459e 841f 66bdaedff183\\",\n \\"teachin >reference id\\" \\"enocean eltako fsb14\\",\n \\"eoap >activated\\" \\"true\\",\n \\"teachin >transmission id\\" \\"default=4291820288\\",\n \\"lastmodified\\" \\"1636489756075\\",\n \\"eoap >alarm\\" \\"false\\"\n }\n}, {\n \\"id\\" \\"97229120 d93b 41c6 9bf3 5a41cfcadb38\\",\n \\"name\\" \\"fsr\\",\n \\"channelgroups\\" \[{\n \\"channelgroupid\\" \\"sensor group\\",\n \\"channeldescriptiondata\\" null,\n \\"channels\\" \[{\n \\"channelid\\" \\"switch\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"switch\\",\n \\"label\\" {\n \\"de de\\" \\"schalter\\",\n \\"en us\\" \\"switch\\"\n }\n },\n \\"value\\" \\"unknown\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"on\\" {\n \\"de de\\" \\"an\\",\n \\"en us\\" \\"on\\"\n },\n \\"off\\" {\n \\"de de\\" \\"aus\\",\n \\"en us\\" \\"off\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#97229120 d93b 41c6 9bf3 5a41cfcadb38#switch\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"on\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }, {\n \\"channelid\\" \\"priority\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"switch\\",\n \\"label\\" {\n \\"de de\\" \\"priorität\\",\n \\"en us\\" \\"priority\\"\n }\n },\n \\"value\\" \\"off\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"on\\" {\n \\"de de\\" \\"an\\",\n \\"en us\\" \\"on\\"\n },\n \\"off\\" {\n \\"de de\\" \\"aus\\",\n \\"en us\\" \\"off\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#97229120 d93b 41c6 9bf3 5a41cfcadb38#priority\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"priority\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }]\n }],\n \\"state\\" \\"online\\",\n \\"parametergroups\\" null,\n \\"metainfos\\" {\n \\"alexa >alexa live updates\\" \\"false\\",\n \\"monitoring >monitorable\\" \\"true\\",\n \\"teachin >group displayname\\" \\"test2\\",\n \\"bsc >short info\\" \\"fsr\\",\n \\"metainfo >id\\" \\"adevice#97229120 d93b 41c6 9bf3 5a41cfcadb38\\",\n \\"teachin >reference id\\" \\"enocean eltako fsr14\\",\n \\"eoap >activated\\" \\"true\\",\n \\"teachin >transmission id\\" \\"default=4291820289\\",\n \\"lastmodified\\" \\"1636489753561\\",\n \\"eoap >alarm\\" \\"false\\"\n }\n}]" }, { "id" "wjdwa8qfkxiv07hlx7o4n", "language" "401", "customlabel" "", "code" "" } ], "selectedlanguageid" "wjdwa8qfkxiv07hlx7o4n" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "parameter name", "kind" "optional", "type" "string", "description" "", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "retrieve a single device", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}", "description" "retrieve a single device object by its id ", "tab" "examples", "examples" { "languages" \[ { "id" "snc4z vwek5mftctjg cf", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "f8aqeryndeu3pazr8p w2", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "qi5lxbmcwxxstq4znc5xj", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "dsa0w v4fx2t8mxzhvhw ", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "jlmrs2edna7mrlemttygt", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "snc4z vwek5mftctjg cf" }, "results" { "languages" \[ { "id" "fwfxoc7hmuoqd9ps3l3or", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"b9f09ef8 3c3f 459e 841f 66bdaedff183\\",\n \\"name\\" \\"fsb14\\",\n \\"channelgroups\\" \[{\n \\"channelgroupid\\" \\"sensor group\\",\n \\"channeldescriptiondata\\" null,\n \\"channels\\" \[{\n \\"channelid\\" \\"jalousie\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"shading\\",\n \\"label\\" {\n \\"de de\\" \\"jalousie\\",\n \\"en us\\" \\"shutters\\"\n }\n },\n \\"value\\" \\"0 0\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"number double\\",\n \\"unit\\" \\"%\\",\n \\"min\\" 0 0,\n \\"max\\" 100 0,\n \\"stepping\\" 1 0,\n \\"decimalpartdigits\\" 1,\n \\"possiblevalues\\" null\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousie\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"jalousie\\",\n \\"tsystems >type\\" \\"value\\"\n }\n }, {\n \\"channelid\\" \\"jalousiestate\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"shading\\",\n \\"label\\" {\n \\"de de\\" \\"jalousie\\",\n \\"en us\\" \\"shutters\\"\n }\n },\n \\"value\\" \\"unknown\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"up\\" {\n \\"de de\\" \\"herauf\\",\n \\"en us\\" \\"up\\"\n },\n \\"down\\" {\n \\"de de\\" \\"herunter\\",\n \\"en us\\" \\"down\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousiestate\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"false\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"direction\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }, {\n \\"channelid\\" \\"priority\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"switch\\",\n \\"label\\" {\n \\"de de\\" \\"priorität\\",\n \\"en us\\" \\"priority\\"\n }\n },\n \\"value\\" \\"off\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"on\\" {\n \\"de de\\" \\"an\\",\n \\"en us\\" \\"on\\"\n },\n \\"off\\" {\n \\"de de\\" \\"aus\\",\n \\"en us\\" \\"off\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#priority\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"priority\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }, {\n \\"channelid\\" \\"jalousieslat\\",\n \\"channeldescriptiondata\\" {\n \\"channeltypeenum\\" \\"shading\\",\n \\"label\\" {\n \\"de de\\" \\"jalousie (lamellen)\\",\n \\"en us\\" \\"shutters (slats)\\"\n }\n },\n \\"value\\" \\"unknown\\",\n \\"valuedescriptiondata\\" {\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"up\\" {\n \\"de de\\" \\"herauf\\",\n \\"en us\\" \\"up\\"\n },\n \\"down\\" {\n \\"de de\\" \\"herunter\\",\n \\"en us\\" \\"down\\"\n }\n }\n },\n \\"writeable\\" false,\n \\"metainfos\\" {\n \\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousieslat\\",\n \\"message >count\\" \\"0\\",\n \\"eoap >changeable\\" \\"true\\",\n \\"message >enabled\\" \\"false\\",\n \\"sensor name\\" \\"jalousieslat\\",\n \\"tsystems >type\\" \\"state\\"\n }\n }]\n }],\n \\"state\\" \\"online\\",\n \\"parametergroups\\" null,\n \\"metainfos\\" {\n \\"alexa >alexa live updates\\" \\"false\\",\n \\"monitoring >monitorable\\" \\"true\\",\n \\"teachin >group displayname\\" \\"test\\",\n \\"bsc >short info\\" \\"fsb14\\",\n \\"metainfo >id\\" \\"adevice#b9f09ef8 3c3f 459e 841f 66bdaedff183\\",\n \\"teachin >reference id\\" \\"enocean eltako fsb14\\",\n \\"eoap >activated\\" \\"true\\",\n \\"teachin >transmission id\\" \\"default=4291820288\\",\n \\"lastmodified\\" \\"1636489756075\\",\n \\"eoap >alarm\\" \\"false\\"\n }\n}" }, { "id" "kum7cwwpgg mzsszi43lc", "language" "401", "customlabel" "", "code" "" }, { "id" "r5os z tod0iysk khxg", "language" "404", "code" "", "customlabel" "" } ], "selectedlanguageid" "kum7cwwpgg mzsszi43lc" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query device status", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/state", "description" "retrieving the current connection status by means of a device id", "tab" "examples", "examples" { "languages" \[ { "id" "m4cclvqaiblhql3owmi r", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/state' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "wmgazailagbzwuqg9vi4m", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/state',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "yqg8gx7usea5iuof2i3hq", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/state\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ji yp0dv9a6titvrgyyld", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/state}\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "fqxmcvvjonbk a8edjwae", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/state\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "m4cclvqaiblhql3owmi r" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n \\"state\\" \\"online\\"\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query meta information", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/metainfos", "description" "retrieve the meta information of a device by its id", "tab" "examples", "examples" { "languages" \[ { "id" "m4cclvqaiblhql3owmi r", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/metainfos' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "wmgazailagbzwuqg9vi4m", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/metainfos',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "yqg8gx7usea5iuof2i3hq", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/metainfos\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ji yp0dv9a6titvrgyyld", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/metainfos}\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "fqxmcvvjonbk a8edjwae", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/metainfos\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "m4cclvqaiblhql3owmi r" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n \\"alexa >alexa live updates\\" \\"false\\",\n \\"monitoring >monitorable\\" \\"true\\",\n \\"teachin >group displayname\\" \\"test\\",\n \\"bsc >short info\\" \\"fsb14\\",\n \\"metainfo >id\\" \\"adevice#b9f09ef8 3c3f 459e 841f 66bdaedff183\\",\n \\"teachin >reference id\\" \\"enocean eltako fsb14\\",\n \\"eoap >activated\\" \\"true\\",\n \\"teachin >transmission id\\" \\"default=4291820288\\",\n \\"lastmodified\\" \\"1636489756075\\",\n \\"eoap >alarm\\" \\"false\\"\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query data object of a channel", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}", "description" "retrieving the channel object by means of the device and channel id", "tab" "examples", "examples" { "languages" \[ { "id" "iofpoegteso f7xn7q9vt", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "qacmfjwjsspbic6jxwm3q", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x mlznjhbhuxvrpi7vgwt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5jgd7kfyspybc8xqtutcu", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lflhxmubcticud9f7b6us", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "iofpoegteso f7xn7q9vt" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n\t\\"channelid\\" \\"jalousie\\",\n\t\\"channeldescriptiondata\\" {\n\t\t\\"channeltypeenum\\" \\"shading\\",\n\t\t\\"label\\" {\n\t\t\t\\"de de\\" \\"jalousie\\",\n\t\t\t\\"en us\\" \\"shutters\\"\n\t\t}\n\t},\n\t\\"value\\" \\"0 0\\",\n\t\\"valuedescriptiondata\\" {\n\t\t\\"valuetype\\" \\"number double\\",\n\t\t\\"unit\\" \\"%\\",\n\t\t\\"min\\" 0 0,\n\t\t\\"max\\" 100 0,\n\t\t\\"stepping\\" 1 0,\n\t\t\\"decimalpartdigits\\" 1,\n\t\t\\"possiblevalues\\" null\n\t},\n\t\\"writeable\\" false,\n\t\\"metainfos\\" {\n\t\t\\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousie\\",\n\t\t\\"message >count\\" \\"0\\",\n\t\t\\"eoap >changeable\\" \\"true\\",\n\t\t\\"message >enabled\\" \\"false\\",\n\t\t\\"sensor name\\" \\"jalousie\\",\n\t\t\\"tsystems >type\\" \\"value\\"\n\t}\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "1db7 1hp2zmxgbxaxut1c" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query current value of a channel", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value", "description" "retrieve the current channel value based on the device and channel id", "tab" "examples", "examples" { "languages" \[ { "id" "iofpoegteso f7xn7q9vt", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "qacmfjwjsspbic6jxwm3q", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x mlznjhbhuxvrpi7vgwt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5jgd7kfyspybc8xqtutcu", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lflhxmubcticud9f7b6us", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "lflhxmubcticud9f7b6us" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n \\"value\\" \\"0 0\\"\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "set current value of a channel", "method" "post", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value/set", "description" "sets the value of the channel specified via the devices and channel id ", "tab" "examples", "examples" { "languages" \[ { "id" "wqdcbpmdxkow953yobec1", "language" "curl", "code" "curl location g request post 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value/set' \\\\\n header 'accept application/json' \\\\\n data raw '{newvalue}'", "customlabel" "" }, { "id" "w0r6gajfn jsbc5adqgk ", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value/set',\n 'headers' {\n 'accept' 'application/json'\n },\n body '{newvalue}'\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x29c1yjao521y5paewehc", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar raw = \\"{newvalue}\\";\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value/set\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "nb3ezmt6eclukzuun3 uw", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value/set\\"\n\npayload = \\"{newvalue}\\"\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "naluodirp3yaz9bgcwrg ", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/value/set\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest body = \\"{newvalue}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "naluodirp3yaz9bgcwrg " }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "204", "customlabel" "", "code" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "400", "customlabel" "", "code" "" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "newvalue", "kind" "required", "type" "string", "description" "the new value", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } the new value is written as (raw) string directly (without json formatting) into the body of the request! { "name" "query the meta information of a channel", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/metainfos", "description" "retrieving the meta information of a channel by means of the device and channel id", "tab" "examples", "examples" { "languages" \[ { "id" "iofpoegteso f7xn7q9vt", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/metainfos' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "qacmfjwjsspbic6jxwm3q", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/metainfos',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x mlznjhbhuxvrpi7vgwt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/metainfos\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5jgd7kfyspybc8xqtutcu", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/metainfos\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lflhxmubcticud9f7b6us", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/metainfos\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "iofpoegteso f7xn7q9vt" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n\t\\"metainfo >id\\" \\"asensor#b9f09ef8 3c3f 459e 841f 66bdaedff183#jalousie\\",\n\t\\"message >count\\" \\"0\\",\n\t\\"eoap >changeable\\" \\"true\\",\n\t\\"message >enabled\\" \\"false\\",\n\t\\"sensor name\\" \\"jalousie\\",\n\t\\"tsystems >type\\" \\"value\\"\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query the values description of a channel", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/valuedescriptiondata", "description" "retrieving the values description of a channel by means of the devices and channel id", "tab" "examples", "examples" { "languages" \[ { "id" "iofpoegteso f7xn7q9vt", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/valuedescriptiondata' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "qacmfjwjsspbic6jxwm3q", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/valuedescriptiondata',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x mlznjhbhuxvrpi7vgwt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/valuedescriptiondata\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5jgd7kfyspybc8xqtutcu", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/valuedescriptiondata\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lflhxmubcticud9f7b6us", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/valuedescriptiondata\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "iofpoegteso f7xn7q9vt" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "// value\n{\n \\"valuetype\\" \\"number double\\",\n \\"unit\\" \\"%\\",\n \\"min\\" 0 0,\n \\"max\\" 100 0,\n \\"stepping\\" 1 0,\n \\"decimalpartdigits\\" 1,\n \\"possiblevalues\\" null\n}\n\n// state\n{\n \\"valuetype\\" \\"state\\",\n \\"unit\\" null,\n \\"min\\" null,\n \\"max\\" null,\n \\"stepping\\" null,\n \\"decimalpartdigits\\" null,\n \\"possiblevalues\\" {\n \\"unknown\\" {\n \\"de de\\" \\"unbekannt\\",\n \\"en us\\" \\"unknown\\"\n },\n \\"on\\" {\n \\"de de\\" \\"an\\",\n \\"en us\\" \\"on\\"\n },\n \\"off\\" {\n \\"de de\\" \\"aus\\",\n \\"en us\\" \\"off\\"\n }\n }\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query a channel description", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/channeldescriptiondata", "description" "retrieving the channel description by means of the devices and channel id", "tab" "examples", "examples" { "languages" \[ { "id" "iofpoegteso f7xn7q9vt", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/channeldescriptiondata' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "qacmfjwjsspbic6jxwm3q", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/channeldescriptiondata',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x mlznjhbhuxvrpi7vgwt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/channeldescriptiondata\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5jgd7kfyspybc8xqtutcu", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/channeldescriptiondata\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lflhxmubcticud9f7b6us", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/channeldescriptiondata\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "iofpoegteso f7xn7q9vt" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n\t\\"channeltypeenum\\" \\"shading\\",\n\t\\"label\\" {\n\t\t\\"de de\\" \\"jalousie\\",\n\t\t\\"en us\\" \\"shutters\\"\n\t}\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "query whether a channel is writable", "method" "get", "url" "https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/writable", "description" "query whether the value of a channel can be changed", "tab" "examples", "examples" { "languages" \[ { "id" "iofpoegteso f7xn7q9vt", "language" "curl", "code" "curl location g request get 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/writable' \\\\\n header 'accept application/json'", "customlabel" "" }, { "id" "qacmfjwjsspbic6jxwm3q", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/writable',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "x mlznjhbhuxvrpi7vgwt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/writable\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5jgd7kfyspybc8xqtutcu", "language" "python", "code" "import requests\n\nurl = \\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/writable\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lflhxmubcticud9f7b6us", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //\<ip>/iot/export/generic/things/{thingid}/{channelid}/writable\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "iofpoegteso f7xn7q9vt" }, "results" { "languages" \[ { "id" "wol7eltmxwzidokutzo l", "language" "200", "customlabel" "", "code" "{\n\t\\"writable\\" false\n}" }, { "id" "1db7 1hp2zmxgbxaxut1c", "language" "401", "code" "", "customlabel" "" }, { "id" "0lhhld78vvaijzsmn udc", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "wol7eltmxwzidokutzo l" }, "request" { "pathparameters" \[ { "name" "thingid", "kind" "required", "type" "string", "description" "the id of the device", "children" \[] }, { "name" "channelid", "kind" "required", "type" "string", "description" "the id of the device channel", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } }