Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/06/30 14:16
From version 28.1
edited by Devin Chen
on 2025/06/30 14:09
Change comment: There is no comment for this version
To version 19.1
edited by xingzhi lin
on 2025/04/01 11:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.DevinChen
1 +XWiki.lxz
Content
... ... @@ -25,9 +25,9 @@
25 25  
26 26  The common KEY is:
27 27  
28 -**comid=128**
28 +**comid=2**
29 29  
30 -**comkey=7e421dd30a394d74b7b9c079e67e272c**
30 +**comkey=589625dce895454dbff9782c299db156**
31 31  
32 32  screctkey=f1cd9351930d4e589922edbcf3b09a7c
33 33  
... ... @@ -427,12 +427,11 @@
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
... ... @@ -478,185 +478,101 @@
478 478  
479 479  "groupId":"7325"
480 480  
481 -"devType":"0"
482 -
483 483  "pageSize":"5"
484 484  
485 485  "pageIndex":"2"
486 486  
487 487  (% style="text-align:center" %)
488 -[[image:1751263596452-675.png||height="222" width="555"]]
485 +[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
489 489  
490 490  **Step3:** Get sign
491 491  
492 -boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263335125&key=f1cd9351930d4e589922edbcf3b09a7c
489 +boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
493 493  
494 -MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
491 +MD5 sign: 0769228e66c945eed5431c41a96949f2
495 495  
496 496  **Step4:** Set common of header
497 497  
498 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"27a89c93a4990d0497a8bd47dea4aed3","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263335125}
495 +{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
499 499  
500 500  (% style="text-align:center" %)
501 -[[image:1751263680622-643.png]]
498 +[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
502 502  
503 503  **Result**
504 504  
505 505  {
506 506  
507 - "code": 200,
504 + "code": 200,
508 508  
509 - "msg": "ok",
506 + "msg": "ok",
510 510  
511 - "reqId": "1751263500705",
508 + "reqId": "1573903822419",
512 512  
513 - "result": {
510 + "result": {
514 514  
515 - "cfgList": [
512 + "cfgList": [
516 516  
517 517   {
518 518  
519 - "monitorId": 2276374,
516 + "monitorId": 91545,
520 520  
521 - "monitorName": "x0",
518 + "dataId": 105,
522 522  
523 - "digitBinary": "",
520 + "monitorName": "Temp_9",
524 524  
525 - "float_point": -1,
522 + "updTime": 1571965761000,
526 526  
527 - "rid": "X",
524 + "dataLimit": "0 7999",
528 528  
529 - "roleType": 1,
526 + "digitBinary": "十进制",
530 530  
531 - "string_point": -1,
528 + "addr": "9",
532 532  
533 - "dataId": 105,
530 + "rid": "D",
534 534  
535 - "addr_stat_no": -1,
532 + "roleType": 3,
536 536  
537 - "updTime": 1745481123000,
534 + "digitCount": "5,0",
538 538  
539 - "dataLimit": "0 1",
536 + "addrType": 2
540 540  
541 - "addr": "0",
542 -
543 - "digitCount": "",
544 -
545 - "boxId": 763,
546 -
547 - "addrType": 0
548 -
549 549   },
550 550  
551 - {
540 + ……………
552 552  
553 - "monitorId": 2276373,
554 -
555 - "monitorName": "y0",
556 -
557 - "digitBinary": "",
558 -
559 - "float_point": -1,
560 -
561 - "rid": "Y",
562 -
563 - "roleType": 3,
564 -
565 - "string_point": -1,
566 -
567 - "dataId": 105,
568 -
569 - "addr_stat_no": -1,
570 -
571 - "updTime": 1745480354000,
572 -
573 - "dataLimit": "0 1",
574 -
575 - "addr": "0",
576 -
577 - "digitCount": "",
578 -
579 - "boxId": 763,
580 -
581 - "addrType": 0
582 -
583 - },
584 -
585 585   {
586 586  
587 - "monitorId": 2276367,
544 + "monitorId": 91541,
588 588  
589 - "monitorName": "okg",
546 + "dataId": 105,
590 590  
591 - "digitBinary": "",
548 + "monitorName": "Temp_5",
592 592  
593 - "float_point": 1,
550 + "updTime": 1571965761000,
594 594  
595 - "rid": "HDW",
552 + "dataLimit": "0 7999",
596 596  
597 - "roleType": 3,
554 + "digitBinary": "十进制",
598 598  
599 - "string_point": -1,
556 + "addr": "5",
600 600  
601 - "dataId": 105,
558 + "rid": "D",
602 602  
603 - "addr_stat_no": -1,
560 + "roleType": 3,
604 604  
605 - "updTime": 1745475213000,
562 + "digitCount": "5,0",
606 606  
607 - "dataLimit": "0 299999",
564 + "addrType": 2
608 608  
609 - "addr": "10",
610 -
611 - "digitCount": "5,0",
612 -
613 - "boxId": 763,
614 -
615 - "addrType": 2
616 -
617 - },
618 -
619 - {
620 -
621 - "monitorId": 2276366,
622 -
623 - "monitorName": "hjdfh",
624 -
625 - "digitBinary": "",
626 -
627 - "float_point": -1,
628 -
629 - "rid": "HDX",
630 -
631 - "roleType": 3,
632 -
633 - "string_point": -1,
634 -
635 - "dataId": 105,
636 -
637 - "addr_stat_no": -1,
638 -
639 - "updTime": 1745475139000,
640 -
641 - "dataLimit": "0 299999,0 15",
642 -
643 - "addr": "0,0",
644 -
645 - "digitCount": "",
646 -
647 - "boxId": 763,
648 -
649 - "addrType": 0
650 -
651 651   }
652 652  
653 653   ],
654 654  
655 - "totalPage": 1,
570 + "totalPage": 3,
656 656  
657 - "totalRecord": 4,
572 + "totalRecord": 15,
658 658  
659 - "currentPage": 1
574 + "currentPage": 2
660 660  
661 661   }
662 662  
... ... @@ -663,12 +663,12 @@
663 663  }
664 664  
665 665  (% style="text-align:center" %)
666 -[[image:1751263773173-191.png]]
581 +[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
667 667  
668 668  == **Tags data list** ==
669 669  
670 670  {{warning}}
671 -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
586 +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 with this API
672 672  {{/warning}}
673 673  
674 674  **~ {{id name="_Toc24963744"/}}Parameters**
... ... @@ -676,12 +676,11 @@
676 676  (% class="table-bordered" %)
677 677  |**acturl**|(% colspan="3" %)we-data/realdata
678 678  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
679 -|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
594 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
680 680  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
681 681  |groupId|(% colspan="2" %)Group ID (Required)
682 682  |pageSize|(% colspan="2" %)Number of each page, 10 by default
683 683  |pageIndex|(% colspan="2" %)Number of current page, start from 1
684 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
685 685  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
686 686  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
687 687  |com|Communication port ID
... ... @@ -796,11 +796,9 @@
796 796  (% class="table-bordered" %)
797 797  |**acturl**|(% colspan="2" %)we-data/updrealdata
798 798  |**Functions**|(% colspan="2" %)Modify tag data
799 -|(% rowspan="5" %)**Parameters**|Parameter|Description
800 -|boxId|Box ID
713 +|(% rowspan="3" %)**Parameters**|Parameter|Description
801 801  |monitorId|Tag ID
802 802  |value|value
803 -|devType|Device type (0:Box, 1:HMI)
804 804  |**Return value**|(% colspan="2" %)None
805 805  
806 806  **Operating procedures**
... ... @@ -812,26 +812,25 @@
812 812  
813 813  **Step2:** Set parameters on Params
814 814  
815 -boxId:6397578
816 -monitorId:1001
817 -value:66
818 -devType:1
727 +"monitorId":"91541"
819 819  
729 +"value":"60"
730 +
820 820  (% style="text-align:center" %)
821 -[[image:1746502882467-849.png]]
732 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
822 822  
823 823  **Step3:** Get sign
824 824  
825 -boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
736 +comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
826 826  
827 -MD5 sign: 4802a362fde2ca5053ad79fe4d272200
738 +MD5 sign: 4119b1abc9176a187f781bece04a5296
828 828  
829 829  **Step4: **Set common of header
830 830  
831 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
742 +{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
832 832  
833 833  (% style="text-align:center" %)
834 -[[image:1746503047845-902.png]]
745 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
835 835  
836 836  **Result**
837 837  
... ... @@ -848,7 +848,7 @@
848 848  }
849 849  
850 850  (% style="text-align:center" %)
851 -[[image:1746503002289-932.png]]
762 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
852 852  
853 853  == **Historical tags name list** ==
854 854  
... ... @@ -857,9 +857,8 @@
857 857  (% class="table-bordered" %)
858 858  |**acturl**|(% colspan="3" %)we-data/monitors
859 859  |**Functions**|(% colspan="3" %)Get a list of historical tags
860 -|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
861 -|boxId|(% colspan="2" %)Box ID (Not required)
862 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
771 +|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
772 +|boxId|(% colspan="2" %)VBoxID (Not required)
863 863  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
864 864  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
865 865  |monitorId|tag ID
... ... @@ -1062,7 +1062,7 @@
1062 1062  (% class="table-bordered" %)
1063 1063  |**acturl**|(% colspan="3" %)we-data/alarmdata
1064 1064  |**Function**|(% colspan="3" %)Get alarm data
1065 -|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
975 +|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
1066 1066  |boxId|(% colspan="2" %)VBoxID, (Required)
1067 1067  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
1068 1068  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -1079,7 +1079,6 @@
1079 1079  
1080 1080  (Not necessary)
1081 1081  )))
1082 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
1083 1083  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
1084 1084  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1085 1085  |monitorId|tag ID
1746502870811-166.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -36.4 KB
Content
1746502882467-849.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -36.4 KB
Content
1746503002289-932.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -20.3 KB
Content
1746503047845-902.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -42.1 KB
Content
1751263559328-234.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -14.7 KB
Content
1751263596452-675.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -22.9 KB
Content
1751263680622-643.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -27.1 KB
Content
1751263773173-191.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -28.5 KB
Content