Get Some monitoring Points

  • Description

    This API is used to retrieve some monitoring data for users.

  • Request Address(Choose one)

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

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

  • 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
    boxNo string Serial number of the FGate

  • Meader

    POST

  • Header

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

  • Body 

    Collection of Monitoring Point UIDs

  • Successful Response

    Returns a JSON object containing the queried monitoring points, with the properties of each point as follows:

    Field Type Description
    id string Data Point ID
    name string Data Point Name
    devAlias string Device Alias
    station int PLC Communication Station Number
    dataType int Data Type, see Appendix Two for details
    regId int Register ID, combined with ioWidth to determine a unique register
    ioWidth int Register Bit Width, combined with regId to determine a unique register
    regName string Register Name, can determine a unique register with either of the above two parameters
    addr int PLC Main Address
    subAddr int PLC Subaddress
    addrBlk int PLC DB Block Address
    intDigits int Integer Digits (Currently Invalid), Invalid for bit, binary, hexadecimal, and string types
    fracDigits int Decimal Digits
    unit string Unit (Valid only for string types)
    privilege int Read/write mode 2: Write-only mode, 4: Read-only mode, 6: Read/write mode
    trafficSaving boolean Whether traffic saving mode is enabled, true: enabled, false: disabled
    deadValue float Dead zone value, data changes within ±deadValue range is not pushed
    label JSON Object Label for bit type,while value = 1,display as ttext; while value = 0,display as ftext.
    memo string Remarks
    encoding int Encoding format, 0: none (valid for string types only), 1: Unicode, 2: Ascii
    stringByteOrder int String byte order, valid when encoding is Ascii, 0: descend order, 1: ascend order
    charCount int Number of characters (valid only for string types)
    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 status, 0: not executed, 1: executed successfully, 2: execution failed, 3: firmware not supported
    valueTransform jobject Numeric calculation settings
    executeOnEdge boolean Whether edge execution is enabled, numeric calculation must be configured when enabled

    Detailed Information of Value Transformation Settings

    Field Type Description
    maxValue int Maximum value
    minValue int Minimum value
    scaleMaxValue int Maximum scale
    scaleMinValue int Minimum scale
    gain int Gain
    offset int Offset
    type int 1: Scale conversion, 2: Scaling

  • Status Codes

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

  • Postman example is as follows:

dmonget