Differences

This shows you the differences between two versions of the page.

--- access_via_api [2020/12/08 13:50] – [Getting data for events] emozolyak
+++ access_via_api [2023/03/02 10:53] (current) – [API usage examples] emozolyak
@@ Line 1: / Line 1: @@
+<WRAP center round tip 60%>There is Excel VBA scripts codes example [[example_of_data_access_from_excel_via_api|here]]</WRAP>
 ====== Using API ======
@@ Line 25: / Line 28: @@
   Content-Type: application/json
+<WRAP center round important 60%>
+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: gzip, deflate, sdch
+</WRAP>
 Example of a connection list request:
@@ Line 518: / Line 526: @@
 }
 </code>
+==== Register's attributes ====
 ^ Register's attributes: ^^^
 |**id**|	int 	 | Unique register id |
@@ Line 609: / Line 617: @@
 |3|Double Word |
 |4|Unix Time |
+|5|String |
 ^Storage formats identifiers:^^
@@ Line 1238: / Line 1248: @@
 |min_val	|double	|Minimal 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://192.168.1.1/api/alerts.
+To obtain information about a particular alert, you must perform a following GET request on a URL 'http://192.168.1.1/api/alerts/1' . Here "1" is the ID of the desired alert.
+In the headers, it is necessary to pass API key. For example:
+  X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
+Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported.
+  Accept: application/json
+  Content-Type: application/json
+Example of query for the full graph list:
+  ***URL:** http://192.168.1.1/api/alerts
+  ***Method:** GET
+  *Headers:
+  Accept: application/json
+  Content-Type: application/json
+  Accept-Encoding: gzip, deflate, sdch
+  X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
+Reply example:
+<code>
+[
+    {
+        "id": "1",
+        "title": "a1",
+        "description": "<p>my alert</p>",
+        "image": "",
+        "level": "0",
+        "sound": "0",
+        "canack": "1",
+        "dict_id": "",
+        "condition": "[{\"condition\":\"moreThan\",\"regId\":1,\"min\":\"0\",\"max\":\"\",\"bitNum\":\"\",\"state\":\"\",\"value\":\"\"}]",
+        "category": "",
+        "group_id": ""
+    },
+    {
+        "id": "2",
+        "title": "a2",
+        "description": "<p>my alert</p>",
+        "image": "",
+        "level": "0",
+        "sound": "0",
+        "canack": "1",
+        "dict_id": "",
+        "condition": "[{\"condition\":\"moreThan\",\"regId\":1,\"min\":\"0\",\"max\":\"\",\"bitNum\":\"\",\"state\":\"\",\"value\":\"\"}]",
+        "category": "",
+        "group_id": ""
+    }
+]
+</code>
+<WRAP center round info 60%>
+To get information about currently active alerts, you can use [[current_alerts?s[]=getcurrentalerts |GetCurrentAlerts]] function and copying its output to some register (and then use GET method for current register's values).
+</WRAP>
 ===== Image list =====
@@ Line 1624: / Line 1698: @@
   Content-Type: application/json
-Please refer for events chapter for more information.
+<WRAP center round info 80%>
+Please refer for [[events]] chapter for more information.
+</WRAP>
 Example of getting date about event #1:
@@ Line 2256: / Line 2334: @@
 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]]