Modify Monitoring

  • Description

    This interface is used to modify data monitoring points.

  • Request Address: (Choose one)

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

    URL2:[Host Server]/api/v2/box/dmon?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 FGate seriall number

  • Method

    POST

  • Headers

    Field Type Description
    Authorization string "Bearer " + access_token obtained from login interface

  • Body
    Do not exceed 20 items in one request.

    Body is a list of data monitoring points in JSON format.

    Field Type Description
    dmonGrpId string Monitoring point group ID
    dmonGrpName string Monitoring point group name
    id string Monitoring point ID
    name string Monitoring point name
    intDigits int Integer digits (currently ineffective)
    fracDigits int Decimal places
    unit string Unit
    privilege int Access mode: 2 (write only), 4 (read only), 6 (read and write)
    devAlias string Device driver alias
    station int PLC communication station number
    dataType int Data type (see Appendix Two)
    regId int Register ID (combined with ioWidth to determine a unique register)
    ioWidth int Register width (combined with regId to determine a unique register)
    regName string Register name (can determine a unique register, either regId or ioWidth is optional)
    addr int PLC main address
    subAddr int PLC sub-address
    addrBlk int PLC DB block addressDB
    trafficSaving boolean Traffic saving mode (true: enabled, false: disabled; ineffective for string type)
    deadValue float Dead zone value; data within ±deadValue range is not pushed (not supported for string, bit, hex, and binary types)
    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, 0: none (for string type), 1: Unicode, 2: ASCII
    stringByteOrder int String byte order, valid when encoding is ASCII; 0 for descending order, 1 for ascending order
    charCount int Number of strings (valid only for string type)
    bitIndexEnabled boolean Whether to enable bit index
    bitIndex int Bit index number
    valueTransform jobject Value operation settings
    executeOnEdge boolean Whether to enable edge computing; must be configured for value operation to take effect

    Details 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: Proportional conversion, 2: Zoom

  • Successful Response

    NULL

  • Response Codes

    Code Description
    401 Access token expired
    400 Error information in HTTP Header [X-FBox-Code], see details in Appendix Three
    429 Access the interface so frequently. See 429 Status code