Add Monitoring Point

  • Description

    This interface is used for users to add data monitoring points.

  • Request URL (Choose one)

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

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


  • Query Parameters

    Field Type Description
    Host Server string SeeExplanation of terms
    boxId Long Find it in Get FGate list interface: boxRegs->box->id
    boxNo string Serial number of FGate

  • Method

    PUT

  • Headers

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

  • Body

    The collection length should not exceed 20 at a time

    The body is the data monitoring point list, transmitted in JSON format

    Field Type Description
    dmonGrpId string Monitoring Group ID. If 'dmonGrpId' is used, 'dmonGrpName' is not required.
    dmonGrpName string Monitoring Group Name. If 'dmonGrpName' property is used, 'dmonGrpId' property is not required. If the group does not exist, the system will automatically create one.
    name string Monitoring Point Name
    intDigits int Integer Part (currently invalid), invalid for bit type, binary, hexadecimal, and string types.
    fracDigits int Decimal Part
    unit string Word Type Unit
    privilege int Read/Write Mode 2: Write-Only Mode, 4: Read-Only Mode, 6: Read/Write Mode
    devAlias string Device Driver Alias, please refer to the alias in 'Remote Download' section of FGateManager
    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 uniquely identify a register. Either of the above two parameters can be optionally selected.
    addr int PLC main address
    subAddr int PLC sub-address
    addrBlk int PLC DB block address
    trafficSaving Boolean Is Traffic Saving Mode, true: enabled, false: disabled. Invalid for string types.
    deadValue float Dead Zone Value, data within the range of ±deadValue is not pushed. Not supported for string, bit type, hexadecimal, and binary types
    label JSON Object Label for bit type,while value = 1,display ttext; while value = 0,display as ftext.
    memo string Remarks Information
    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 for descending order, 1 for ascending order.
    charCount int Number of Strings (only valid for string types)
    bitIndexEnabled boolean Enable Bitwise Indexing
    bitIndex int Bitwise Index Number
    valueTransform jobject Numeric Calculation Settings
    executeOnEdge Boolean Enable Edge Execution, numeric calculation must be configured when enabled.

    Value operation settings detailed table

    Field Type Description
    maxValue int Upper Limit of Value
    minValue int Lower Limit of Value
    scaleMaxValue int Upper Limit of Scale
    scaleMinValue int Lower Limit of Scale
    gain int Gain
    offset int Offset
    type int 1: Proportional Conversion, 2: Scaling

  • Successful Response

    Return collection of added monitoring point IDs (long).

  • Return Code

    Field Description
    200 Successful
    401 Access Token Expired
    400 Error message in the HTTP header[X-FBox-Code], see Appendix Three for details.
    429 Access the interface so frequent. See 429 Status code

  • Postman example is as follows:

Login Interface

  • Please see the example in the following image.

Login Interface