Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/06/30 14:16
From version 29.1
edited by Devin Chen
on 2025/06/30 14:16
Change comment: There is no comment for this version
To version 23.1
edited by Devin Chen
on 2025/04/10 13:51
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=128**
28 +**comid=2**
29 29  
30 -**comkey=7e421dd30a394d74b7b9c079e67e272c**
30 +**comkey=589625dce895454dbff9782c299db156**
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,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"]]
486 +[[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
490 +boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
493 493  
494 -MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
492 +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}
496 +{"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]]
499 +[[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,
505 + "code": 200,
508 508  
509 - "msg": "ok",
507 + "msg": "ok",
510 510  
511 - "reqId": "1751263500705",
509 + "reqId": "1573903822419",
512 512  
513 - "result": {
511 + "result": {
514 514  
515 - "cfgList": [
513 + "cfgList": [
516 516  
517 517   {
518 518  
519 - "monitorId": 2276374,
517 + "monitorId": 91545,
520 520  
521 - "monitorName": "x0",
519 + "dataId": 105,
522 522  
523 - "digitBinary": "",
521 + "monitorName": "Temp_9",
524 524  
525 - "float_point": -1,
523 + "updTime": 1571965761000,
526 526  
527 - "rid": "X",
525 + "dataLimit": "0 7999",
528 528  
529 - "roleType": 1,
527 + "digitBinary": "十进制",
530 530  
531 - "string_point": -1,
529 + "addr": "9",
532 532  
533 - "dataId": 105,
531 + "rid": "D",
534 534  
535 - "addr_stat_no": -1,
533 + "roleType": 3,
536 536  
537 - "updTime": 1745481123000,
535 + "digitCount": "5,0",
538 538  
539 - "dataLimit": "0 1",
537 + "addrType": 2
540 540  
541 - "addr": "0",
542 -
543 - "digitCount": "",
544 -
545 - "boxId": 763,
546 -
547 - "addrType": 0
548 -
549 549   },
550 550  
551 - {
541 + ……………
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,
545 + "monitorId": 91541,
588 588  
589 - "monitorName": "okg",
547 + "dataId": 105,
590 590  
591 - "digitBinary": "",
549 + "monitorName": "Temp_5",
592 592  
593 - "float_point": 1,
551 + "updTime": 1571965761000,
594 594  
595 - "rid": "HDW",
553 + "dataLimit": "0 7999",
596 596  
597 - "roleType": 3,
555 + "digitBinary": "十进制",
598 598  
599 - "string_point": -1,
557 + "addr": "5",
600 600  
601 - "dataId": 105,
559 + "rid": "D",
602 602  
603 - "addr_stat_no": -1,
561 + "roleType": 3,
604 604  
605 - "updTime": 1745475213000,
563 + "digitCount": "5,0",
606 606  
607 - "dataLimit": "0 299999",
565 + "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,
571 + "totalPage": 3,
656 656  
657 - "totalRecord": 4,
573 + "totalRecord": 15,
658 658  
659 - "currentPage": 1
575 + "currentPage": 2
660 660  
661 661   }
662 662  
... ... @@ -663,7 +663,7 @@
663 663  }
664 664  
665 665  (% style="text-align:center" %)
666 -[[image:1751263773173-191.png]]
582 +[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
667 667  
668 668  == **Tags data list** ==
669 669  
... ... @@ -681,7 +681,7 @@
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)
600 +|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
... ... @@ -705,8 +705,6 @@
705 705  
706 706  "boxId":"973"
707 707  
708 -"devType":"0"
709 -
710 710  "groupId":"7325"
711 711  
712 712  "pageSize":"5"
... ... @@ -714,149 +714,73 @@
714 714  "pageIndex":"2"
715 715  
716 716  (% style="text-align:center" %)
717 -[[image:1751264089450-269.png||height="221" width="607"]]
631 +[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
718 718  
719 719  **Step3:** Get sign
720 720  
721 -boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263921050&key=f1cd9351930d4e589922edbcf3b09a7c
635 +boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
722 722  
723 -MD5 sign: 19191b155e92f800f4db086bf06f8367
637 +MD5 sign: 0769228e66c945eed5431c41a96949f2
724 724  
725 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"19191b155e92f800f4db086bf06f8367","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263921050}
639 +{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
726 726  
727 727  **~ {{id name="_Toc24963746"/}}Result**
728 728  
729 729  {
730 730  
731 - "code": 200,
645 + "code": 200,
732 732  
733 - "msg": "ok",
647 + "msg": "ok",
734 734  
735 - "reqId": "1751264055206",
649 + "reqId": "1573905679365",
736 736  
737 - "result": {
651 + "result": {
738 738  
739 - "totalPage": 1,
653 + "totalPage": 3,
740 740  
741 - "list": [
655 + "list": [
742 742  
743 743   {
744 744  
745 - "com": 0,
659 + "com": 2939,
746 746  
747 - "string_point": -1,
661 + "monitorId": 91545,
748 748  
749 - "monitorId": 2276374,
663 + "monitorName": "Temp_9",
750 750  
751 - "addr_stat_no": -1,
665 + "groupId": 0,
752 752  
753 - "actAuth": 1,
667 + "state": "1",
754 754  
755 - "monitorName": "x0",
669 + "value": "90"
756 756  
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 -
769 769   },
770 770  
771 - {
673 + …………
772 772  
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 -
797 797   },
798 798  
799 799   {
800 800  
801 - "com": 0,
679 + "com": 2939,
802 802  
803 - "string_point": -1,
681 + "monitorId": 91541,
804 804  
805 - "monitorId": 2276367,
683 + "monitorName": "Temp_5",
806 806  
807 - "addr_stat_no": -1,
685 + "groupId": 0,
808 808  
809 - "actAuth": 3,
687 + "state": "1",
810 810  
811 - "monitorName": "okg",
689 + "value": "87"
812 812  
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 -
853 853   }
854 854  
855 855   ],
856 856  
857 - "totalRecord": 4,
695 + "totalRecord": 15,
858 858  
859 - "currentPage": 1
697 + "currentPage": 2
860 860  
861 861   }
862 862  
... ... @@ -863,7 +863,7 @@
863 863  }
864 864  
865 865  (% style="text-align:center" %)
866 -[[image:1751264191566-865.png]]
704 +[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
867 867  
868 868  == **Modify tag data** ==
869 869  
... ... @@ -874,11 +874,9 @@
874 874  (% class="table-bordered" %)
875 875  |**acturl**|(% colspan="2" %)we-data/updrealdata
876 876  |**Functions**|(% colspan="2" %)Modify tag data
877 -|(% rowspan="5" %)**Parameters**|Parameter|Description
878 -|boxId|Box ID
715 +|(% rowspan="3" %)**Parameters**|Parameter|Description
879 879  |monitorId|Tag ID
880 880  |value|value
881 -|devType|Device type (0:Box, 1:HMI)
882 882  |**Return value**|(% colspan="2" %)None
883 883  
884 884  **Operating procedures**
... ... @@ -890,26 +890,25 @@
890 890  
891 891  **Step2:** Set parameters on Params
892 892  
893 -boxId:6397578
894 -monitorId:1001
895 -value:66
896 -devType:1
729 +"monitorId":"91541"
897 897  
731 +"value":"60"
732 +
898 898  (% style="text-align:center" %)
899 -[[image:1746502882467-849.png]]
734 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
900 900  
901 901  **Step3:** Get sign
902 902  
903 -boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
738 +comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
904 904  
905 -MD5 sign: 4802a362fde2ca5053ad79fe4d272200
740 +MD5 sign: 4119b1abc9176a187f781bece04a5296
906 906  
907 907  **Step4: **Set common of header
908 908  
909 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
744 +{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
910 910  
911 911  (% style="text-align:center" %)
912 -[[image:1746503047845-902.png]]
747 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
913 913  
914 914  **Result**
915 915  
... ... @@ -926,7 +926,7 @@
926 926  }
927 927  
928 928  (% style="text-align:center" %)
929 -[[image:1746503002289-932.png]]
764 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
930 930  
931 931  == **Historical tags name list** ==
932 932  
... ... @@ -935,9 +935,8 @@
935 935  (% class="table-bordered" %)
936 936  |**acturl**|(% colspan="3" %)we-data/monitors
937 937  |**Functions**|(% colspan="3" %)Get a list of historical tags
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)
773 +|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
774 +|boxId|(% colspan="2" %)VBoxID (Not required)
941 941  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
942 942  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
943 943  |monitorId|tag ID
... ... @@ -1140,7 +1140,7 @@
1140 1140  (% class="table-bordered" %)
1141 1141  |**acturl**|(% colspan="3" %)we-data/alarmdata
1142 1142  |**Function**|(% colspan="3" %)Get alarm data
1143 -|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
977 +|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
1144 1144  |boxId|(% colspan="2" %)VBoxID, (Required)
1145 1145  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
1146 1146  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -1157,7 +1157,6 @@
1157 1157  
1158 1158  (Not necessary)
1159 1159  )))
1160 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
1161 1161  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
1162 1162  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1163 1163  |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
1751264089450-269.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -23.2 KB
Content
1751264191566-865.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -26.1 KB
Content