Funkce /api/get vrací stav zařízení. Odpověď je ve formátu JSON.
Metoda: POST
Klíče:
K získání hodnot všech vstupních slouží klíč "param". (když nedám žádný parametr/klíč?),
Jak vypadá požadavek jen na některé klíče?
POST { "param": [ "sntp_enable", "sntp_server", "sntp_timeout", "sntp_period", "dev_sn", "test_wr_param" ] } nebo POST { "param": [] //returns all existing parameters } |
Odpověď je ve formátu json.
POST { "status": { // return unread parameters "sntp_timeout": "undefined", "test_wr_param": "access_denied" }, "value": { // returns read parameters "sntp_enable":"no", "sntp_server": "ntp.cesnet.cz", "sntp_period": 2, "dev_sn": "00000013" } } |
To get the reading of parameter value.
{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "get - request", "type": "object", "properties": { "param": { "type": "array", "items": { "type": "string", "pattern": "^[a-z_][a-z0-9_]*$" } } }, "required": [ "param" ], "additionalProperties": false } |
Meaning of json items:
$.param:
Array with names of configuration parameters to retrieve their values.
An empty array causes read all parameter values.
Type: array
Optional.
{ "param": [ // request for reading values of specific parameters "sntp_enable", "sntp_server", "sntp_timeout", "sntp_period", "dev_sn", "test_wr_param" ] } //OR { "param": [ ] //request for reading all values of existing parameters: } |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "deviceType": { "type": "string" } }, "required": [ "deviceType", ] } |
{ "deviceType": "5.1.0.0" } |