Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 25.1
edited by Devin Chen
on 2025/04/10 16:16
Change comment: There is no comment for this version
To version 15.1
edited by Mora Zhou
on 2023/12/22 10:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.DevinChen
1 +XWiki.Mora
Content
... ... @@ -1,4 +1,4 @@
1 -= **General** =
1 += **1 General** =
2 2  
3 3  This documents introduces WECON V-BOX HTTP API. And this document also shows some examples. All example is tested from postman application.
4 4  
... ... @@ -48,7 +48,7 @@
48 48  **✎Note:** If it is for Virtual Deployment, the comid and comkey would not be the same with values above. Try to get the actual value from HTTP access (V-NET~-~-Services~-~-HTTP access)
49 49  )))
50 50  
51 -== **Interface Parameter Description** ==
51 +== **1.1 Interface Parameter Description** ==
52 52  
53 53  **Global parameters**
54 54  
... ... @@ -72,7 +72,7 @@
72 72  (% style="text-align:center" %)
73 73  [[image:1.png||height="141" width="500" class="img-thumbnail"]]
74 74  
75 -== **Example key and value** ==
75 +== **1.2 Example key and value** ==
76 76  
77 77  1).**comid**=2
78 78  
... ... @@ -83,10 +83,10 @@
83 83  4).**ts**=1573897380
84 84  
85 85  (((
86 -= **Basic API** =
86 += **2 Basic API** =
87 87  )))
88 88  
89 -== **{{id name="_Toc24963726"/}}Login operation** ==
89 +== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
90 90  
91 91  (((
92 92  **2.1.1 Parameters**
... ... @@ -103,7 +103,7 @@
103 103  |utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
104 104  |sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
105 105  
106 -**Operating procedures**
106 +**2.1.2 Operating procedures**
107 107  
108 108  **Setp1: ** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/login>>url:http://api.v-box.net/box-data/api/we-data/login]]
109 109  
... ... @@ -143,7 +143,7 @@
143 143  [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
144 144  
145 145  (((
146 -**Result**
146 +**2.1.3 Result**
147 147  )))
148 148  
149 149  {
... ... @@ -170,17 +170,17 @@
170 170  [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
171 171  
172 172  (((
173 -= **Service data APIs** =
173 += **3 Service data APIs** =
174 174  )))
175 175  
176 -== **V-Box list** ==
176 +== **3.1 V-Box list** ==
177 177  
178 -**{{id name="_Toc24963732"/}}Parameters**
178 +**3.1.1 {{id name="_Toc24963732"/}}Parameters**
179 179  
180 180  (% style="text-align:center" %)
181 181  [[image:X.png||height="412" width="700" class="img-thumbnail"]]
182 182  
183 -**~ {{id name="_Toc24963733"/}}Operating procedures**
183 +**3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
184 184  
185 185  **Step1:**  Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/boxs>>url:http://api.v-box.net/box-data/api/we-data/boxs]]
186 186  
... ... @@ -204,7 +204,7 @@
204 204  (% style="text-align:center" %)
205 205  [[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
206 206  
207 -**Result**
207 +**3.1.3 Result**
208 208  
209 209  {
210 210  
... ... @@ -333,9 +333,9 @@
333 333  (% style="text-align:center" %)
334 334  [[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
335 335  
336 -== **Real-time group list** ==
336 +== **3.2 Real-time group list** ==
337 337  
338 -**{{id name="_Toc24963736"/}} Parameters**
338 +**3.2.1{{id name="_Toc24963736"/}} Parameters**
339 339  
340 340  (% class="table-bordered" %)
341 341  |**acturl**|(% colspan="3" %)we-data/realgroups
... ... @@ -347,7 +347,7 @@
347 347  |groupId|Group ID
348 348  |groupName|Group name
349 349  
350 -**Operating procedures**
350 +**3.2.2 Operating procedures**
351 351  
352 352  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realgroups>>url:http://api.v-box.net/box-data/api/we-data/realgroups]]
353 353  
... ... @@ -374,7 +374,7 @@
374 374  (% style="text-align:center" %)
375 375  [[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
376 376  
377 -**Result**
377 +**3.2.3 Result**
378 378  
379 379  {
380 380  
... ... @@ -420,19 +420,18 @@
420 420  
421 421  [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
422 422  
423 -== **Real-time tags configuration list** ==
423 +== **3.3 Real-time tags configuration list** ==
424 424  
425 -**Parameters**
425 +**3.3.1 Parameters**
426 426  
427 427  (% class="table-bordered" %)
428 428  |**acturl**|(% colspan="3" %)we-data/realcfgs
429 429  |**Functions**|(% colspan="3" %)Get the tags configuration information in the specified group in V-BOX.
430 -|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
430 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
431 431  |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
432 432  |groupId|(% colspan="2" %)Group ID (Required)
433 433  |pageSize|(% colspan="2" %)Number of each page, 10 by default
434 434  |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
436 436  |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
437 437  |(% rowspan="11" %)cfgList|monitorId|Tags ID
438 438  |monitorName|Tags name
... ... @@ -465,7 +465,7 @@
465 465  |totalRecord|(% colspan="2" %)Total record number
466 466  |currentPage|(% colspan="2" %)Current page number
467 467  
468 -**Operating procedures**
467 +**3.3.2 Operating procedures**
469 469  
470 470  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realcfgs>>url:http://api.v-box.net/box-data/api/we-data/realcfgs]]
471 471  
... ... @@ -498,7 +498,7 @@
498 498  (% style="text-align:center" %)
499 499  [[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
500 500  
501 -**Result**
500 +**3.3.3 Result**
502 502  
503 503  {
504 504  
... ... @@ -581,23 +581,18 @@
581 581  (% style="text-align:center" %)
582 582  [[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
583 583  
584 -== **Tags data list** ==
583 +== (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
585 585  
586 -{{warning}}
587 -This API is not for getting the real-time data all the time.If you need to get the continuously updated real-time monitoring point data values,you need to use **[[Send switch to device>>https://docs.we-con.com.cn/bin/view/V-BOX/V-Net/Manual/6%20HTTP%20API/#HSendswitchtodevice]] **API with this API
588 -{{/warning}}
585 +**3.4.1 {{id name="_Toc24963744"/}}Parameters**
589 589  
590 -**~ {{id name="_Toc24963744"/}}Parameters**
591 -
592 592  (% class="table-bordered" %)
593 593  |**acturl**|(% colspan="3" %)we-data/realdata
594 594  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
595 -|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
590 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
596 596  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
597 597  |groupId|(% colspan="2" %)Group ID (Required)
598 598  |pageSize|(% colspan="2" %)Number of each page, 10 by default
599 599  |pageIndex|(% colspan="2" %)Number of current page, start from 1
600 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
601 601  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
602 602  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
603 603  |com|Communication port ID
... ... @@ -610,7 +610,7 @@
610 610  |totalRecord|(% colspan="2" %)Total record
611 611  |currentPage|(% colspan="2" %)current page
612 612  
613 -**~ {{id name="_Toc24963745"/}}Operating procedures**
607 +**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
614 614  
615 615  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realdata>>url:http://api.v-box.net/box-data/api/we-data/realdata]]
616 616  
... ... @@ -638,7 +638,7 @@
638 638  
639 639  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
640 640  
641 -**~ {{id name="_Toc24963746"/}}Result**
635 +**3.4.3 {{id name="_Toc24963746"/}}Result**
642 642  
643 643  {
644 644  
... ... @@ -703,23 +703,21 @@
703 703  (% style="text-align:center" %)
704 704  [[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
705 705  
706 -== **Modify tag data** ==
700 +== **3.5 Modify tag data** ==
707 707  
708 708  (((
709 -**Parameters**
703 +**3.5.1 Parameters**
710 710  )))
711 711  
712 712  (% class="table-bordered" %)
713 713  |**acturl**|(% colspan="2" %)we-data/updrealdata
714 714  |**Functions**|(% colspan="2" %)Modify tag data
715 -|(% rowspan="5" %)**Parameters**|Parameter|Description
716 -|boxId|Box ID
709 +|(% rowspan="3" %)**Parameters**|Parameter|Description
717 717  |monitorId|Tag ID
718 718  |value|value
719 -|devType|Device type (0:Box, 1:HMI)
720 720  |**Return value**|(% colspan="2" %)None
721 721  
722 -**Operating procedures**
714 +**3.5.2 Operating procedures**
723 723  
724 724  **Step1:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/updrealdata>>url:http://api.v-box.net/box-data/api/we-data/updrealdata]]
725 725  
... ... @@ -748,7 +748,7 @@
748 748  (% style="text-align:center" %)
749 749  [[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
750 750  
751 -**Result**
743 +**3.5.3 Result**
752 752  
753 753  {
754 754  
... ... @@ -765,22 +765,21 @@
765 765  (% style="text-align:center" %)
766 766  [[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
767 767  
768 -== **Historical tags name list** ==
760 +== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
769 769  
770 -**Parameters**
762 +**3.6.1 Parameters**
771 771  
772 772  (% class="table-bordered" %)
773 773  |**acturl**|(% colspan="3" %)we-data/monitors
774 774  |**Functions**|(% colspan="3" %)Get a list of historical tags
775 -|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
776 -|boxId|(% colspan="2" %)Box ID (Not required)
777 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
767 +|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
768 +|boxId|(% colspan="2" %)VBoxID (Not required)
778 778  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
779 779  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
780 780  |monitorId|tag ID
781 781  |monitorName|tag name
782 782  
783 -**Operating procedures**
774 +**3.6.2 Operating procedures**
784 784  
785 785  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/monitors>>url:http://api.v-box.net/box-data/api/we-data/monitors]]
786 786  
... ... @@ -807,7 +807,7 @@
807 807  (% style="text-align:center" %)
808 808  [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
809 809  
810 -**Result**
801 +**3.6.3 Result**
811 811  
812 812  {
813 813  
... ... @@ -850,9 +850,9 @@
850 850  (% style="text-align:center" %)
851 851  [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
852 852  
853 -== **Historical tag data list** ==
844 +== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
854 854  
855 -**~ {{id name="_Toc24963756"/}}Parameters**
846 +**3.7.1 {{id name="_Toc24963756"/}}Parameters**
856 856  
857 857  (% class="table-bordered" %)
858 858  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -872,7 +872,7 @@
872 872  |totalRecord|(% colspan="2" %)Total records
873 873  |currentPage|(% colspan="2" %)Current page
874 874  
875 -**Operating procedures**
866 +**3.7.2 Operating procedures**
876 876  
877 877  **Step:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/historydata>>url:http://api.v-box.net/box-data/api/we-data/historydata]]
878 878  
... ... @@ -907,7 +907,7 @@
907 907  (% style="text-align:center" %)
908 908  [[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
909 909  
910 -**Result**
901 +**3.7.3 Result**
911 911  
912 912  {
913 913  
... ... @@ -970,14 +970,14 @@
970 970  (% style="text-align:center" %)
971 971  [[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
972 972  
973 -== **Alarm tags data list** ==
964 +== **3.8 Alarm tags data list** ==
974 974  
975 -**{{id name="_Toc24963760"/}}Parameters**
966 +**​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
976 976  
977 977  (% class="table-bordered" %)
978 978  |**acturl**|(% colspan="3" %)we-data/alarmdata
979 979  |**Function**|(% colspan="3" %)Get alarm data
980 -|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
971 +|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
981 981  |boxId|(% colspan="2" %)VBoxID, (Required)
982 982  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
983 983  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -994,7 +994,6 @@
994 994  
995 995  (Not necessary)
996 996  )))
997 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
998 998  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
999 999  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1000 1000  |monitorId|tag ID
... ... @@ -1008,7 +1008,7 @@
1008 1008  |totalRecord|(% colspan="2" %)Total records
1009 1009  |currentPage|(% colspan="2" %)Current page
1010 1010  
1011 -**~ {{id name="_Toc24963761"/}}Operating procedures**
1001 +**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1012 1012  
1013 1013  **Step1:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/alarmdata>>url:http://api.v-box.net/box-data/api/we-data/alarmdata]]
1014 1014  
... ... @@ -1045,7 +1045,7 @@
1045 1045  (% style="text-align:center" %)
1046 1046  [[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1047 1047  
1048 -**Result**
1038 +**3.8.3 Result**
1049 1049  
1050 1050  {
1051 1051