Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/06/30 14:16
From version 18.1
edited by Mora Zhou
on 2023/12/22 10:06
Change comment: There is no comment for this version
To version 29.1
edited by Devin Chen
on 2025/06/30 14:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Mora
1 +XWiki.DevinChen
Content
... ... @@ -25,9 +25,9 @@
25 25  
26 26  The common KEY is:
27 27  
28 -**comid=2**
28 +**comid=128**
29 29  
30 -**comkey=589625dce895454dbff9782c299db156**
30 +**comkey=7e421dd30a394d74b7b9c079e67e272c**
31 31  
32 32  screctkey=f1cd9351930d4e589922edbcf3b09a7c
33 33  
... ... @@ -427,11 +427,12 @@
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 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
430 +|(% colspan="1" rowspan="6" %)**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)
435 435  |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
436 436  |(% rowspan="11" %)cfgList|monitorId|Tags ID
437 437  |monitorName|Tags name
... ... @@ -477,101 +477,185 @@
477 477  
478 478  "groupId":"7325"
479 479  
481 +"devType":"0"
482 +
480 480  "pageSize":"5"
481 481  
482 482  "pageIndex":"2"
483 483  
484 484  (% style="text-align:center" %)
485 -[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
488 +[[image:1751263596452-675.png||height="222" width="555"]]
486 486  
487 487  **Step3:** Get sign
488 488  
489 -boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
492 +boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263335125&key=f1cd9351930d4e589922edbcf3b09a7c
490 490  
491 -MD5 sign: 0769228e66c945eed5431c41a96949f2
494 +MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
492 492  
493 493  **Step4:** Set common of header
494 494  
495 -{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
498 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"27a89c93a4990d0497a8bd47dea4aed3","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263335125}
496 496  
497 497  (% style="text-align:center" %)
498 -[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
501 +[[image:1751263680622-643.png]]
499 499  
500 500  **Result**
501 501  
502 502  {
503 503  
504 - "code": 200,
507 + "code": 200,
505 505  
506 - "msg": "ok",
509 + "msg": "ok",
507 507  
508 - "reqId": "1573903822419",
511 + "reqId": "1751263500705",
509 509  
510 - "result": {
513 + "result": {
511 511  
512 - "cfgList": [
515 + "cfgList": [
513 513  
514 514   {
515 515  
516 - "monitorId": 91545,
519 + "monitorId": 2276374,
517 517  
518 - "dataId": 105,
521 + "monitorName": "x0",
519 519  
520 - "monitorName": "Temp_9",
523 + "digitBinary": "",
521 521  
522 - "updTime": 1571965761000,
525 + "float_point": -1,
523 523  
524 - "dataLimit": "0 7999",
527 + "rid": "X",
525 525  
526 - "digitBinary": "十进制",
529 + "roleType": 1,
527 527  
528 - "addr": "9",
531 + "string_point": -1,
529 529  
530 - "rid": "D",
533 + "dataId": 105,
531 531  
532 - "roleType": 3,
535 + "addr_stat_no": -1,
533 533  
534 - "digitCount": "5,0",
537 + "updTime": 1745481123000,
535 535  
536 - "addrType": 2
539 + "dataLimit": "0 1",
537 537  
541 + "addr": "0",
542 +
543 + "digitCount": "",
544 +
545 + "boxId": 763,
546 +
547 + "addrType": 0
548 +
538 538   },
539 539  
540 - ……………
551 + {
541 541  
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 +
542 542   {
543 543  
544 - "monitorId": 91541,
587 + "monitorId": 2276367,
545 545  
546 - "dataId": 105,
589 + "monitorName": "okg",
547 547  
548 - "monitorName": "Temp_5",
591 + "digitBinary": "",
549 549  
550 - "updTime": 1571965761000,
593 + "float_point": 1,
551 551  
552 - "dataLimit": "0 7999",
595 + "rid": "HDW",
553 553  
554 - "digitBinary": "十进制",
597 + "roleType": 3,
555 555  
556 - "addr": "5",
599 + "string_point": -1,
557 557  
558 - "rid": "D",
601 + "dataId": 105,
559 559  
560 - "roleType": 3,
603 + "addr_stat_no": -1,
561 561  
562 - "digitCount": "5,0",
605 + "updTime": 1745475213000,
563 563  
564 - "addrType": 2
607 + "dataLimit": "0 299999",
565 565  
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 +
566 566   }
567 567  
568 568   ],
569 569  
570 - "totalPage": 3,
655 + "totalPage": 1,
571 571  
572 - "totalRecord": 15,
657 + "totalRecord": 4,
573 573  
574 - "currentPage": 2
659 + "currentPage": 1
575 575  
576 576   }
577 577  
... ... @@ -578,20 +578,25 @@
578 578  }
579 579  
580 580  (% style="text-align:center" %)
581 -[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
666 +[[image:1751263773173-191.png]]
582 582  
583 583  == **Tags data list** ==
584 584  
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
672 +{{/warning}}
673 +
585 585  **~ {{id name="_Toc24963744"/}}Parameters**
586 586  
587 587  (% class="table-bordered" %)
588 588  |**acturl**|(% colspan="3" %)we-data/realdata
589 589  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
590 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
679 +|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
591 591  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
592 592  |groupId|(% colspan="2" %)Group ID (Required)
593 593  |pageSize|(% colspan="2" %)Number of each page, 10 by default
594 594  |pageIndex|(% colspan="2" %)Number of current page, start from 1
684 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
595 595  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
596 596  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
597 597  |com|Communication port ID
... ... @@ -615,6 +615,8 @@
615 615  
616 616  "boxId":"973"
617 617  
708 +"devType":"0"
709 +
618 618  "groupId":"7325"
619 619  
620 620  "pageSize":"5"
... ... @@ -622,73 +622,149 @@
622 622  "pageIndex":"2"
623 623  
624 624  (% style="text-align:center" %)
625 -[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
717 +[[image:1751264089450-269.png||height="221" width="607"]]
626 626  
627 627  **Step3:** Get sign
628 628  
629 -boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
721 +boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263921050&key=f1cd9351930d4e589922edbcf3b09a7c
630 630  
631 -MD5 sign: 0769228e66c945eed5431c41a96949f2
723 +MD5 sign: 19191b155e92f800f4db086bf06f8367
632 632  
633 -{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
725 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"19191b155e92f800f4db086bf06f8367","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263921050}
634 634  
635 635  **~ {{id name="_Toc24963746"/}}Result**
636 636  
637 637  {
638 638  
639 - "code": 200,
731 + "code": 200,
640 640  
641 - "msg": "ok",
733 + "msg": "ok",
642 642  
643 - "reqId": "1573905679365",
735 + "reqId": "1751264055206",
644 644  
645 - "result": {
737 + "result": {
646 646  
647 - "totalPage": 3,
739 + "totalPage": 1,
648 648  
649 - "list": [
741 + "list": [
650 650  
651 651   {
652 652  
653 - "com": 2939,
745 + "com": 0,
654 654  
655 - "monitorId": 91545,
747 + "string_point": -1,
656 656  
657 - "monitorName": "Temp_9",
749 + "monitorId": 2276374,
658 658  
659 - "groupId": 0,
751 + "addr_stat_no": -1,
660 660  
661 - "state": "1",
753 + "actAuth": 1,
662 662  
663 - "value": "90"
755 + "monitorName": "x0",
664 664  
757 + "groupId": 211608,
758 +
759 + "state": 0,
760 +
761 + "float_point": -1,
762 +
763 + "templateId": 0,
764 +
765 + "value": "0",
766 +
767 + "boxId": 763
768 +
665 665   },
666 666  
667 - …………
771 + {
668 668  
773 + "com": 0,
774 +
775 + "string_point": -1,
776 +
777 + "monitorId": 2276373,
778 +
779 + "addr_stat_no": -1,
780 +
781 + "actAuth": 3,
782 +
783 + "monitorName": "y0",
784 +
785 + "groupId": 211608,
786 +
787 + "state": 0,
788 +
789 + "float_point": -1,
790 +
791 + "templateId": 0,
792 +
793 + "value": "0",
794 +
795 + "boxId": 763
796 +
669 669   },
670 670  
671 671   {
672 672  
673 - "com": 2939,
801 + "com": 0,
674 674  
675 - "monitorId": 91541,
803 + "string_point": -1,
676 676  
677 - "monitorName": "Temp_5",
805 + "monitorId": 2276367,
678 678  
679 - "groupId": 0,
807 + "addr_stat_no": -1,
680 680  
681 - "state": "1",
809 + "actAuth": 3,
682 682  
683 - "value": "87"
811 + "monitorName": "okg",
684 684  
813 + "groupId": 211608,
814 +
815 + "state": 0,
816 +
817 + "float_point": 1,
818 +
819 + "templateId": 0,
820 +
821 + "value": "0",
822 +
823 + "boxId": 763
824 +
825 + },
826 +
827 + {
828 +
829 + "com": 0,
830 +
831 + "string_point": -1,
832 +
833 + "monitorId": 2276366,
834 +
835 + "addr_stat_no": -1,
836 +
837 + "actAuth": 3,
838 +
839 + "monitorName": "hjdfh",
840 +
841 + "groupId": 211608,
842 +
843 + "state": 0,
844 +
845 + "float_point": -1,
846 +
847 + "templateId": 0,
848 +
849 + "value": "0",
850 +
851 + "boxId": 763
852 +
685 685   }
686 686  
687 687   ],
688 688  
689 - "totalRecord": 15,
857 + "totalRecord": 4,
690 690  
691 - "currentPage": 2
859 + "currentPage": 1
692 692  
693 693   }
694 694  
... ... @@ -695,7 +695,7 @@
695 695  }
696 696  
697 697  (% style="text-align:center" %)
698 -[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
866 +[[image:1751264191566-865.png]]
699 699  
700 700  == **Modify tag data** ==
701 701  
... ... @@ -706,9 +706,11 @@
706 706  (% class="table-bordered" %)
707 707  |**acturl**|(% colspan="2" %)we-data/updrealdata
708 708  |**Functions**|(% colspan="2" %)Modify tag data
709 -|(% rowspan="3" %)**Parameters**|Parameter|Description
877 +|(% rowspan="5" %)**Parameters**|Parameter|Description
878 +|boxId|Box ID
710 710  |monitorId|Tag ID
711 711  |value|value
881 +|devType|Device type (0:Box, 1:HMI)
712 712  |**Return value**|(% colspan="2" %)None
713 713  
714 714  **Operating procedures**
... ... @@ -720,25 +720,26 @@
720 720  
721 721  **Step2:** Set parameters on Params
722 722  
723 -"monitorId":"91541"
893 +boxId:6397578
894 +monitorId:1001
895 +value:66
896 +devType:1
724 724  
725 -"value":"60"
726 -
727 727  (% style="text-align:center" %)
728 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
899 +[[image:1746502882467-849.png]]
729 729  
730 730  **Step3:** Get sign
731 731  
732 -comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
903 +boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
733 733  
734 -MD5 sign: 4119b1abc9176a187f781bece04a5296
905 +MD5 sign: 4802a362fde2ca5053ad79fe4d272200
735 735  
736 736  **Step4: **Set common of header
737 737  
738 -{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
909 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
739 739  
740 740  (% style="text-align:center" %)
741 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
912 +[[image:1746503047845-902.png]]
742 742  
743 743  **Result**
744 744  
... ... @@ -755,7 +755,7 @@
755 755  }
756 756  
757 757  (% style="text-align:center" %)
758 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
929 +[[image:1746503002289-932.png]]
759 759  
760 760  == **Historical tags name list** ==
761 761  
... ... @@ -764,8 +764,9 @@
764 764  (% class="table-bordered" %)
765 765  |**acturl**|(% colspan="3" %)we-data/monitors
766 766  |**Functions**|(% colspan="3" %)Get a list of historical tags
767 -|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
768 -|boxId|(% colspan="2" %)VBoxID (Not required)
938 +|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
939 +|boxId|(% colspan="2" %)Box ID (Not required)
940 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
769 769  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
770 770  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
771 771  |monitorId|tag ID
... ... @@ -968,7 +968,7 @@
968 968  (% class="table-bordered" %)
969 969  |**acturl**|(% colspan="3" %)we-data/alarmdata
970 970  |**Function**|(% colspan="3" %)Get alarm data
971 -|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
1143 +|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
972 972  |boxId|(% colspan="2" %)VBoxID, (Required)
973 973  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
974 974  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -985,6 +985,7 @@
985 985  
986 986  (Not necessary)
987 987  )))
1160 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
988 988  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
989 989  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
990 990  |monitorId|tag ID
1746502870811-166.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +36.4 KB
Content
1746502882467-849.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +36.4 KB
Content
1746503002289-932.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +20.3 KB
Content
1746503047845-902.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +42.1 KB
Content
1751263559328-234.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +14.7 KB
Content
1751263596452-675.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +22.9 KB
Content
1751263680622-643.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +27.1 KB
Content
1751263773173-191.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +28.5 KB
Content
1751264089450-269.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +23.2 KB
Content
1751264191566-865.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +26.1 KB
Content