Add Alarm Entry

  • Description

    This interface is used for users to add alarm entries.

  • Request URL (Choose one)

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

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

  • Query Parameters

    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 FGate

  • Method

    PUT

  • Request Headers

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

  • Request Body
    The collection length should not longer than 20 at a time

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

    Field Type Description
    alarmGrpId string Alarm group ID, if 'alarmGrpId' is used, 'alarmGrpName' is not required
    alarmGrpName string Alarm group name, if 'alarmGrpName' is used, 'alarmGrpId' is not required. If the group does not exist, the system will automatically create it,but it 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 items such as test,testing), this parameter is required
    memo string Remarks information
    devAlias string Device alias
    station int PLC communication station No
    dataType int Data type, see Appendix Two, does not support binary, hexadecimal, string types
    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, which can determine a unique 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
    name string Alarm entry name (optional, if multiple entries are added at once, each entry name must be different)
    valueTransform jobject Numeric Calculation settings
    executeOnEdge Boolean Whether to 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 alarm entry IDs (long).

  • Return Code

    Code 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 frequently. See 429 Status code

  • Postman example is as follows:

Login Interface

  • Please see the example in the following image.

Login Interface