Get Device Variables

{ "tab" "examples", "url" "/api/v4/get device variables", "name" "/api/v4/get device variables", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "product", "type" "string", "children" \[], "description" "product short code" }, { "kind" "required", "name" "hardware id", "type" "string", "children" \[], "description" "unique hardware id generated for the client device" }, { "name" "license key", "kind" "optional", "type" "string", "description" "required if product is key based (see section below)", "children" \[] }, { "name" "username", "kind" "optional", "type" "string", "description" "required if product is user based (see section below)", "children" \[] }, { "name" "license id", "kind" "optional", "type" "number", "description" "ensures that the action affects only the license with the specified id this is useful if e g you have multiple licenses for the same product assigned to the same user for obtaining a list of licenses assigned to a user, see \\"user licenses\\"", "children" \[] } ], "headerparameters" \[ { "kind" "required", "name" "date", "type" "string", "children" \[], "description" "in rfc7231 format (see \\"license api authorization\\"), eg thu, 17 nov 2022 20 51 35 gmt" }, { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "see \\"license api authorization\\" article" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "qlx3ifr3fpkeqnnhkuaxk", "code" "\[\n {\n \\"id\\" 2155,\n \\"value\\" \\"t\\",\n \\"variable\\" \\"0\\",\n \\"created at\\" \\"2021 10 13t10 57 25 000z\\",\n \\"device id\\" 1630390110774029\n },\n {\n \\"id\\" 2156,\n \\"value\\" \\"e\\",\n \\"variable\\" \\"1\\",\n \\"created at\\" \\"2021 10 13t10 57 25 000z\\",\n \\"device id\\" 1630390110774029\n }\n]", "language" "200", "customlabel" "" }, { "id" "r7pnangflvc8rz1icgrv8", "code" "", "language" "404", "customlabel" "" } ], "selectedlanguageid" "qlx3ifr3fpkeqnnhkuaxk" }, "examples" { "languages" \[ { "id" "323h9fsg3s2wtlqpufwcw", "language" "curl", "code" "curl location request get '/api/v4/get device variables?product=string\&hardware id=string\&license key=string\&username=string' \\\\\n header 'accept application/json' \\\\\n header 'date string' \\\\\n header 'authorization string'", "customlabel" "" }, { "id" "gfsmrok81x7qjhcci7n5 ", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' '/api/v4/get device variables?product=string\&hardware id=string\&license key=string\&username=string',\n 'headers' {\n 'accept' 'application/json',\n 'date' 'string',\n 'authorization' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "fpufj2 ajmisjnlskzq0m", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"date\\", \\"string\\");\nmyheaders append(\\"authorization\\", \\"string\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"/api/v4/get device variables?product=string\&hardware id=string\&license key=string\&username=string\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "watpnuyzw3a2uiwd7w88a", "language" "python", "code" "import requests\n\nurl = \\"/api/v4/get device variables?product=string\&hardware id=string\&license key=string\&username=string\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json',\n 'date' 'string',\n 'authorization' 'string'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "vtuz001vghw8wmmii58lo", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/api/v4/get device variables?product=string\&hardware id=string\&license key=string\&username=string\\")\n\nhttp = net http new(url host, url port);\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"date\\"] = \\"string\\"\nrequest\[\\"authorization\\"] = \\"string\\"\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "watpnuyzw3a2uiwd7w88a" }, "description" "returns metadata variables assigned to a device", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } schema request query parameters type getdevicevariablesrequestparameters = { // required parameters product string, hardware id string, // required for key based products license key string, // required for user based products username string, // optional parameters license id? string | undefined, } json schema response body type getdevicevariablesresponsebody = ({ variable string, value string | number | boolean, device id number, created at number, // unix timestamp in milliseconds, e g 1737128752745 })\[]; json schema license authorization method there are two types of product licenses based on how the client application authorizes itself to interact with a license key based product licenses client interactions with the license have to be authorized using a license key user based product licenses the license has a corresponding "license user" instead of a license key client interactions with the license have to be authorized using a username errors if an error occurs, the response will have an http status code of 400 or higher, and the response body will contain an error description in the following format { status number, code string, message string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "status" { "type" "number" }, "code" { "type" "string" }, "message" { "type" "string" } }, "required" \[ "status", "code", "message" ], "additionalproperties" false } list of exceptions unknown product (400) provided product was not found license not found (400) license with the provided license user not found license not active (400) the license is not active license not enabled (400) the license is not enabled device not found (400) an active device matching the hardware id not found blacklisted (400) this device is blacklisted