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 [2020/04/07 12:01] – [Getting meters log] emozolyak | access_via_api [2023/03/02 10:53] (current) – [API usage examples] emozolyak | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | <WRAP center round tip 60%> | ||
+ | |||
+ | |||
====== Using API ====== | ====== Using API ====== | ||
Line 25: | Line 28: | ||
Content-Type: | Content-Type: | ||
+ | <WRAP center round important 60%> | ||
+ | Note that, if you are using another WebHMI as client (via [[Lua_API|cURL Lua]]' | ||
+ | Accept-Encoding: | ||
+ | </ | ||
+ | |||
Example of a connection list request: | Example of a connection list request: | ||
Line 518: | Line 526: | ||
} | } | ||
</ | </ | ||
+ | ==== Register' | ||
^ Register' | ^ Register' | ||
|**id**| int | Unique register id | | |**id**| int | Unique register id | | ||
Line 609: | Line 617: | ||
|3|Double Word | | |3|Double Word | | ||
|4|Unix Time | | |4|Unix Time | | ||
+ | |5|String | | ||
+ | |||
^Storage formats identifiers: | ^Storage formats identifiers: | ||
Line 1238: | 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 1624: | Line 1698: | ||
Content-Type: | Content-Type: | ||
| | ||
- | Consider an example of two events. Event number 1 is the parent event. It starts on the 5th second of every minute and ends on the 40th second of every minute. The log records data once for the entire event. The time of the beginning of the event and the last value of the interval register I60 are recorded in the log. Screenshots illustrate the setting of this event. | ||
- | {{:: | + | <WRAP center round info 80%> |
+ | Please refer for [[events]] chapter for more information. | ||
+ | </ | ||
- | {{:: | ||
- | |||
- | The second event is the child event for the first event. Therefore, it can only be executed when the first event is executed. In addition, the condition is limited so that it starts at the 25th second of every minute and ends at the 35th. Data for it is written to the log every 2 seconds. The current value of the I60 register is written to the log. Screenshots illustrate the setting of this event. | ||
- | |||
- | {{:: | ||
- | |||
- | {{:: | ||
- | |||
- | {{:: | ||
Example of getting date about event #1: | Example of getting date about event #1: | ||
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.1586260894.txt.gz · Last modified: 2020/04/07 12:01 by emozolyak