• HTTP document
    Show / Hide Table of Contents
    • Login Interface
      • Explanation of terms
      • Login
      • Refresh Login
    • Write Data Process
      • Add FGate Group
      • Add FGate
      • Add Monitoring Group
      • Add Monitoring Point
      • Get FGate List
      • FGate Monitoring List
      • Write Monitoring Value
      • Get Monitoring Value
    • Information Access
      • Get Single FGate
      • Get Monitoring Group
      • Get Some monitoring Points
      • Get Monitoring Point by Group
      • Get Iccid、Imei
      • Get Location of FGate
    • Remote Download
      • Get FGate Drive List
      • Download FGate Drive
      • Get Register Type of Device
      • Get Server Drive List
    • Modification Interface
      • Modify FGate Group
      • Modify FGate Name
      • Modify Monitoring
      • Modify Refresh Interval
    • Delete Interface
      • Delete FGate Group
      • Delete FGate
      • Delete Monitoring Group
      • Delete Monitoring Point
    • Alarm Interface
      • Alarm Group
        • Get Alarm Group List
        • Add Alarm Group
        • Modify Alarm Group
        • Delete Alarm Group
      • Alarm Contact
        • Get Alarm Contact List
        • Get Single Alarm Contact
        • Add Alarm contact
        • Modify Alarm Contact
        • Delete Alarm Contact
      • Alarm Record
        • Get Alarm Entry List
        • Get Alarm Entry
        • Add Alarm Entry
        • Modify Alarm Entry
        • Delete Alarm Entry
        • Get Historical Alarm
        • Get Alarm Entry Status
        • Confirm Alarm
    • Historical Data
      • Get Historical Data List
      • Get Historical Data Entry
      • Add Historical Record
      • Update Historical Record
      • Delete Historical Data
      • Get Historical Data
    • Push Monitoring Data
      • Enable Monitoring Group
      • Disable Monitoring Group
      • Enable Monitoring Group List
      • Disable Monitoring Group List
      • Enable All Monitoring Points
      • Disable All Monitoring Points
      • Enable One Monitoring Point
      • Disable One Monitoring Point
      • Enable Some Monitoring Points
      • Disable Some Monitoring Points
      • Enable Some Monitoring Points
      • Enable One Monitoring Group
      • Enable Some Monitoring Groups
    • Data Push(SignalR)
      • Real-time Data Push(signalR)
      • Status Change Push
      • Real-time Data Push
      • Alarm Trigger
      • Alarm Restore
    • Write in Batch
      • Get Bacth Write Group
      • Write Value in Batch
    • Appendix
      • Appendix One
      • Appendix Two
      • Appendix Three
      • 429 Status Code

    FGate Monitoring List

    • Description

      This interface is used for users to obtain an array (JSON array) of all monitoring groups under the current FGate.

    • Request Address: (Choose one)

      URL1:[Host Server]/api/v2/box/{boxId}/dmon/grouped

      URL2:[Host Server]/api/v2/box/dmon/grouped?boxNo={boxNo}


    • Address Parameter Description

      Field Type Description
      Host Server string See Explanation of terms
      Uid Long Find it in Get FGate list interface: boxRegs->box->id
      boxNo string FGate serial number
    • Method

      GET

    • Headers

      Field Type Description
      Authorization string "Bearer " + Access Token obtained from the login interface
    • Body

      NULL

    • Success Response

      Field Type Description
      id string Monitoring point group ID
      name string Monitoring point group name
      items json array Monitoring point array, single attribute as follows

      Monitoring point attributes are as follows:

      Field Type Description
      id string Monitoring point ID
      name string Monitoring point name
      grpId string Monitoring point group ID
      grpName string Monitoring point group name
      devAlias string Device alias
      station int PLC communication station number
      dataType int Data type, see Appendix Two for details
      regId int Register ID, used in conjunction with ioWidth to determine a unique register
      ioWidth int Register bit width, used in conjunction with regId to determine a unique register
      regName string Register name, can determine a unique register, optional with the above two parameters
      addr int PLC main address
      subAddr int PLC sub-address
      addrBlk int PLC DB block address
      intDigits int Integer part (currently invalid), invalid for bit types, binary, hexadecimal, and string types
      fracDigits int Decimal places
      unit string Unit, only valid for word types
      privilege int Read-write mode 2: write-only mode, 4: read-only mode, 6: read-write mode
      trafficSaving Boolean Whether to enable traffic saving mode, true: enabled, false: not enabled
      deadValue float Dead zone value, data within ±deadValue range is not pushed
      label json object Label for bit type,while value = 1,display ttext; while value = 0,display as ftext.
      memo string Remarks
      encoding int Encoding format, used for string , 0: non-string types, 1: Unicode, 2: Ascii
      stringByteOrder int String byte order, valid when encoded in Ascii format: 0: descend order, 1: ascend order
      charCount int Number of characters (only valid for string types)
      deviceChanged Boolean Whether the device has been removed (This parameter only appears while removed, status is true) This parameter appears while connected device changed .
      tstate int Offline task flag, 0: not executed, 1: successful execution, 2: execution failed, 3: firmware not supported
      valueTransform jobject Numeric Calculation settings
      executeOnEdge boolean Whether to enable edge execution. When enabled, numeric Calculation must be configured

      Detailed table of value transformation settings

      Field Type Description
      maxValue int Maximum value
      minValue int Minimum value
      scaleMaxValue int Scale maximum value
      scaleMinValue int Scale minimum value
      gain int Gain
      offset int Offset
      type int 1: proportional conversion, 2: scaling
    • Return Codes

      Field Description
      200 Execution succeeded
      401 Access token expired
      404 The interface does not exist, please check the URL
      429 Access interface too frequently, 429 Status code
      400 Error message in HTTP Header [X-FBox-Code],see Appendix Three for details
    • Postman example is as follows:

    Monitoring Point List Interface

    Back to top Generated by DocFX