Modify Alarm Entry

  • Description

    This interface is used to modify alarm entries.

  • Request Address: (Choose one)

    URL1:[Host Server]/api/v2/box/alarm?boxNo={boxNo}

    URL2:[Host Server]/api/v2/box/{boxId}/alarm

  • 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 serial number

  • Method

    POST

  • Headers

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

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

    Field Type Description
    id string Alarm point entry ID
    alarmGrpId string Alarm point group ID, if alarmGrpId is used, alarmGrpName is not needed
    alarmGrpName string Alarm point group name, if alarmGrpName is used, alarmGrpId is not needed, if the group does not exist, the system will create it automatically, cannot exceed 15 characters
    condition1 int Alarm condition one, 0: not equal to, 1: equal to, 2: greater than, 3: greater than or equal to, 4: less than, 5: less than or equal to
    condtiion2 int Alarm condition two, 0: not equal to, 1: equal to, 2: greater than, 3: greater than or equal to, 4: less than, 5: less than or equal to
    operand1 decimal Operand 1
    operand2 decimal Operand 2
    condMethod int Condition combination, 0: none, 1: AND, 2: OR
    alarmMsg string Alarm message (do not include "test", "testing", etc.), this parameter is required
    memo string Remark information
    devAlias string Device driver alias
    station int PLC communication station No
    dataType int Data type, see Appendix Two for details, binary, hexadecimal, and string types are not supported.
    regId int Register ID, combined with ioWidth, determines the unique register
    ioWidth int Register width, combined with regId, determines the unique register
    regName string Register name, can determine the unique register, choose one of the two above parameters
    addr int PLC main address
    subAddr int PLC sub-address
    addrBlk int PLC DB block address
    valueTransform jobject Numerical operation settings
    executeOnEdge boolean Whether to enable edge computing, numerical operation must be configured when enabled

    Detailed table of numerical operation 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

  • Successful Response

    NULL

  • Response Codes

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