Get Monitoring Point by Group

  • Description

    This API is used for users to retrieve monitoring points based on monitoring point groups.

  • Request Address

    URL:[Host Server]/api/v2/box/{boxId}/dmongroup/{groupId}/dmon

  • Address Parameter Description

    Field Type Description
    Host Server string See Explanation of terms
    boxId Long Find it in Get FGate list interface: boxRegs->box->id
    groupId string Monitoring point group ID

  • Method

    GET

  • Header

    Field Type Description
    Authorization string "Bearer " + Access token obtained from login interface
    X-FBox-ClientId string See Appendix One

  • Body

    NULL

  • Successful Response

    Returns a JSON object containing the collection of queried monitoring points, with attributes of a single object as follows:

    Field Type Description
    id string Monitoring point ID
    name string Monitoring point name
    devAlias string Device driver alias
    station int PLC communication station number
    dataType int Data type, see Appendix Two for details
    regId int Register ID, combined with ioWidth, determines a unique register
    ioWidth int Register bit width, combined with regId, determines 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 digits (currently invalid), invalid for bit types, binary, hexadecimal, and string types
    fracDigits int Decimal places
    unit string Unit, valid for word types only
    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 is not pushed within ±deadValue range
    label JSON object Label for bit type,while value = 1,display ttext; while value = 0,display as ftext.
    memo string Remark information
    encoding int Encoding format, used for strings, 0: none, 1: Unicode, 2: Ascii
    stringByteOrder int String byte order, effective when encoded as Ascii format, 0 for descending order, 1 for ascending order.
    charCount int Number of strings (valid for string types only)
    deviceChanged Boolean Whether the device has been removed (This parameter appears only while removed, and status is true) Occurs when the connected device of FGate changes.
    tstate int Offline task flag, 0: not executed, 1: executed successfully, 2: execution failed, 3: firmware not supported

  • Response Codes

    Code Description
    401 Access token expired
    400 Error message in HTTP Header [X-FBox-Code],see Appendix Three for details
    404 Interface does not exist, please check the URL
    429 Access the interface so frequently. See 429 Status code