access_via_api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| access_via_api [2021/05/12 08:32] – ↷ Links adapted because of a move operation atolstov | access_via_api [2023/03/02 10:53] (current) – [API usage examples] emozolyak | ||
|---|---|---|---|
| Line 29: | Line 29: | ||
| <WRAP center round important 60%> | <WRAP center round important 60%> | ||
| - | Note that, if you are using another WebHMI as client (via cURL Lua's library), the following line should be removed | + | Note that, if you are using another WebHMI as client (via [[Lua_API|cURL Lua]]'s library), the following line should be removed |
| Accept-Encoding: | Accept-Encoding: | ||
| </ | </ | ||
| Line 526: | Line 526: | ||
| } | } | ||
| </ | </ | ||
| + | ==== Register' | ||
| ^ Register' | ^ Register' | ||
| |**id**| int | Unique register id | | |**id**| int | Unique register id | | ||
| Line 617: | Line 617: | ||
| |3|Double Word | | |3|Double Word | | ||
| |4|Unix Time | | |4|Unix Time | | ||
| + | |5|String | | ||
| + | |||
| ^Storage formats identifiers: | ^Storage formats identifiers: | ||
| Line 1246: | Line 1248: | ||
| |min_val |double |Minimal value of the Y axis| | |min_val |double |Minimal value of the Y axis| | ||
| |max_val |double |Maximal value of the Y axis| | |max_val |double |Maximal value of the Y axis| | ||
| + | |||
| + | ===== Alert list ===== | ||
| + | |||
| + | To get a list of all alerts, you must perform a GET request on the URL like this: http:// | ||
| + | |||
| + | To obtain information about a particular alert, you must perform a following GET request on a URL ' | ||
| + | |||
| + | In the headers, it is necessary to pass API key. For example: | ||
| + | |||
| + | X-WH-APIKEY: | ||
| + | | ||
| + | Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported. | ||
| + | |||
| + | Accept: application/ | ||
| + | Content-Type: | ||
| + | |||
| + | Example of query for the full graph list: | ||
| + | |||
| + | ***URL:** http:// | ||
| + | ***Method: | ||
| + | *Headers: | ||
| + | |||
| + | Accept: application/ | ||
| + | Content-Type: | ||
| + | Accept-Encoding: | ||
| + | X-WH-APIKEY: | ||
| + | |||
| + | Reply example: | ||
| + | < | ||
| + | [ | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ] | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 60%> | ||
| + | To get information about currently active alerts, you can use [[current_alerts? | ||
| + | </ | ||
| + | |||
| + | |||
| ===== Image list ===== | ===== Image list ===== | ||
| Line 2268: | Line 2334: | ||
| The %%//%% are comments, they are absent in the real reponse. | The %%//%% are comments, they are absent in the real reponse. | ||
| + | ====== API usage examples ====== | ||
| + | |||
| + | * [[access_from_lua_to_webhmi_itself | Data access from WebHMI itself]] | ||
| + | * [[example_of_data_access_from_excel_via_api|Data access from Excel]] | ||
| + | * [[example_of_data_access_from_c_c|Data access from C/C++]] | ||
| + | * [[google_sheet_api_example|Data access from the Google Sheets]] | ||
| + | * [[Android demo application]] | ||
| + | * [[Android application via Chrome]] | ||
access_via_api.1620808368.txt.gz · Last modified: 2021/05/12 08:32 by atolstov