Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/06/30 14:16
From version 22.1
edited by Devin Chen
on 2025/04/10 13:47
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
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  
... ... @@ -432,7 +432,7 @@
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 +|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,101 +478,185 @@
478 478  
479 479  "groupId":"7325"
480 480  
481 +"devType":"0"
482 +
481 481  "pageSize":"5"
482 482  
483 483  "pageIndex":"2"
484 484  
485 485  (% style="text-align:center" %)
486 -[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
488 +[[image:1751263596452-675.png||height="222" width="555"]]
487 487  
488 488  **Step3:** Get sign
489 489  
490 -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
491 491  
492 -MD5 sign: 0769228e66c945eed5431c41a96949f2
494 +MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
493 493  
494 494  **Step4:** Set common of header
495 495  
496 -{"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}
497 497  
498 498  (% style="text-align:center" %)
499 -[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
501 +[[image:1751263680622-643.png]]
500 500  
501 501  **Result**
502 502  
503 503  {
504 504  
505 - "code": 200,
507 + "code": 200,
506 506  
507 - "msg": "ok",
509 + "msg": "ok",
508 508  
509 - "reqId": "1573903822419",
511 + "reqId": "1751263500705",
510 510  
511 - "result": {
513 + "result": {
512 512  
513 - "cfgList": [
515 + "cfgList": [
514 514  
515 515   {
516 516  
517 - "monitorId": 91545,
519 + "monitorId": 2276374,
518 518  
519 - "dataId": 105,
521 + "monitorName": "x0",
520 520  
521 - "monitorName": "Temp_9",
523 + "digitBinary": "",
522 522  
523 - "updTime": 1571965761000,
525 + "float_point": -1,
524 524  
525 - "dataLimit": "0 7999",
527 + "rid": "X",
526 526  
527 - "digitBinary": "十进制",
529 + "roleType": 1,
528 528  
529 - "addr": "9",
531 + "string_point": -1,
530 530  
531 - "rid": "D",
533 + "dataId": 105,
532 532  
533 - "roleType": 3,
535 + "addr_stat_no": -1,
534 534  
535 - "digitCount": "5,0",
537 + "updTime": 1745481123000,
536 536  
537 - "addrType": 2
539 + "dataLimit": "0 1",
538 538  
541 + "addr": "0",
542 +
543 + "digitCount": "",
544 +
545 + "boxId": 763,
546 +
547 + "addrType": 0
548 +
539 539   },
540 540  
541 - ……………
551 + {
542 542  
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 +
543 543   {
544 544  
545 - "monitorId": 91541,
587 + "monitorId": 2276367,
546 546  
547 - "dataId": 105,
589 + "monitorName": "okg",
548 548  
549 - "monitorName": "Temp_5",
591 + "digitBinary": "",
550 550  
551 - "updTime": 1571965761000,
593 + "float_point": 1,
552 552  
553 - "dataLimit": "0 7999",
595 + "rid": "HDW",
554 554  
555 - "digitBinary": "十进制",
597 + "roleType": 3,
556 556  
557 - "addr": "5",
599 + "string_point": -1,
558 558  
559 - "rid": "D",
601 + "dataId": 105,
560 560  
561 - "roleType": 3,
603 + "addr_stat_no": -1,
562 562  
563 - "digitCount": "5,0",
605 + "updTime": 1745475213000,
564 564  
565 - "addrType": 2
607 + "dataLimit": "0 299999",
566 566  
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 +
567 567   }
568 568  
569 569   ],
570 570  
571 - "totalPage": 3,
655 + "totalPage": 1,
572 572  
573 - "totalRecord": 15,
657 + "totalRecord": 4,
574 574  
575 - "currentPage": 2
659 + "currentPage": 1
576 576  
577 577   }
578 578  
... ... @@ -579,7 +579,7 @@
579 579  }
580 580  
581 581  (% style="text-align:center" %)
582 -[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
666 +[[image:1751263773173-191.png]]
583 583  
584 584  == **Tags data list** ==
585 585  
... ... @@ -592,11 +592,12 @@
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 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
679 +|(% colspan="1" rowspan="6" %)**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
684 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
600 600  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
601 601  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
602 602  |com|Communication port ID
... ... @@ -620,6 +620,8 @@
620 620  
621 621  "boxId":"973"
622 622  
708 +"devType":"0"
709 +
623 623  "groupId":"7325"
624 624  
625 625  "pageSize":"5"
... ... @@ -627,73 +627,149 @@
627 627  "pageIndex":"2"
628 628  
629 629  (% style="text-align:center" %)
630 -[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
717 +[[image:1751264089450-269.png||height="221" width="607"]]
631 631  
632 632  **Step3:** Get sign
633 633  
634 -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
635 635  
636 -MD5 sign: 0769228e66c945eed5431c41a96949f2
723 +MD5 sign: 19191b155e92f800f4db086bf06f8367
637 637  
638 -{"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}
639 639  
640 640  **~ {{id name="_Toc24963746"/}}Result**
641 641  
642 642  {
643 643  
644 - "code": 200,
731 + "code": 200,
645 645  
646 - "msg": "ok",
733 + "msg": "ok",
647 647  
648 - "reqId": "1573905679365",
735 + "reqId": "1751264055206",
649 649  
650 - "result": {
737 + "result": {
651 651  
652 - "totalPage": 3,
739 + "totalPage": 1,
653 653  
654 - "list": [
741 + "list": [
655 655  
656 656   {
657 657  
658 - "com": 2939,
745 + "com": 0,
659 659  
660 - "monitorId": 91545,
747 + "string_point": -1,
661 661  
662 - "monitorName": "Temp_9",
749 + "monitorId": 2276374,
663 663  
664 - "groupId": 0,
751 + "addr_stat_no": -1,
665 665  
666 - "state": "1",
753 + "actAuth": 1,
667 667  
668 - "value": "90"
755 + "monitorName": "x0",
669 669  
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 +
670 670   },
671 671  
672 - …………
771 + {
673 673  
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 +
674 674   },
675 675  
676 676   {
677 677  
678 - "com": 2939,
801 + "com": 0,
679 679  
680 - "monitorId": 91541,
803 + "string_point": -1,
681 681  
682 - "monitorName": "Temp_5",
805 + "monitorId": 2276367,
683 683  
684 - "groupId": 0,
807 + "addr_stat_no": -1,
685 685  
686 - "state": "1",
809 + "actAuth": 3,
687 687  
688 - "value": "87"
811 + "monitorName": "okg",
689 689  
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 +
690 690   }
691 691  
692 692   ],
693 693  
694 - "totalRecord": 15,
857 + "totalRecord": 4,
695 695  
696 - "currentPage": 2
859 + "currentPage": 1
697 697  
698 698   }
699 699  
... ... @@ -700,7 +700,7 @@
700 700  }
701 701  
702 702  (% style="text-align:center" %)
703 -[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
866 +[[image:1751264191566-865.png]]
704 704  
705 705  == **Modify tag data** ==
706 706  
... ... @@ -711,9 +711,11 @@
711 711  (% class="table-bordered" %)
712 712  |**acturl**|(% colspan="2" %)we-data/updrealdata
713 713  |**Functions**|(% colspan="2" %)Modify tag data
714 -|(% rowspan="3" %)**Parameters**|Parameter|Description
877 +|(% rowspan="5" %)**Parameters**|Parameter|Description
878 +|boxId|Box ID
715 715  |monitorId|Tag ID
716 716  |value|value
881 +|devType|Device type (0:Box, 1:HMI)
717 717  |**Return value**|(% colspan="2" %)None
718 718  
719 719  **Operating procedures**
... ... @@ -725,25 +725,26 @@
725 725  
726 726  **Step2:** Set parameters on Params
727 727  
728 -"monitorId":"91541"
893 +boxId:6397578
894 +monitorId:1001
895 +value:66
896 +devType:1
729 729  
730 -"value":"60"
731 -
732 732  (% style="text-align:center" %)
733 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
899 +[[image:1746502882467-849.png]]
734 734  
735 735  **Step3:** Get sign
736 736  
737 -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
738 738  
739 -MD5 sign: 4119b1abc9176a187f781bece04a5296
905 +MD5 sign: 4802a362fde2ca5053ad79fe4d272200
740 740  
741 741  **Step4: **Set common of header
742 742  
743 -{"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}
744 744  
745 745  (% style="text-align:center" %)
746 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
912 +[[image:1746503047845-902.png]]
747 747  
748 748  **Result**
749 749  
... ... @@ -760,7 +760,7 @@
760 760  }
761 761  
762 762  (% style="text-align:center" %)
763 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
929 +[[image:1746503002289-932.png]]
764 764  
765 765  == **Historical tags name list** ==
766 766  
... ... @@ -769,8 +769,9 @@
769 769  (% class="table-bordered" %)
770 770  |**acturl**|(% colspan="3" %)we-data/monitors
771 771  |**Functions**|(% colspan="3" %)Get a list of historical tags
772 -|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
773 -|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)
774 774  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
775 775  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
776 776  |monitorId|tag ID
... ... @@ -973,7 +973,7 @@
973 973  (% class="table-bordered" %)
974 974  |**acturl**|(% colspan="3" %)we-data/alarmdata
975 975  |**Function**|(% colspan="3" %)Get alarm data
976 -|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
1143 +|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
977 977  |boxId|(% colspan="2" %)VBoxID, (Required)
978 978  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
979 979  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -990,6 +990,7 @@
990 990  
991 991  (Not necessary)
992 992  )))
1160 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
993 993  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
994 994  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
995 995  |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