Get Alarm Entry List

  • Description

    This interface is used to retrieve alarm entries for users.

  • Request URLs: (Choose one)

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

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

  • Address Parameters 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 The serial number of FGate

  • Methods

    GET

  • Headers

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

  • Body

    NULL

  • Success Response

    Field Type Description
    id string ID of the alarm entry
    code string Code of the alarm entry
    devAlias string Device alias
    station int PLC 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 width, combined with regId to determine a unique register
    regName string Register name, which can determine a unique register, select it or two parameters above
    addr int PLC main address
    subAddr int PLC sub address
    addrBlk int PLC DB block address
    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 Value 1
    operand2 deciaml Value 2
    condMethod int Condition combination, 0: none, 1: AND, 2: OR
    alarmMsg string Alarm message
    group json object Alarm group information, including id (group ID) and name (group name)
    memo string Remark
    deviceChanged boolean Whether the device has been removed (This parameter only appears while removed, status is true) This parameter appears while connected device changed .
    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 to enable edge execution. Numeric calculation must be configured when enabled.

    Detailed table of value transformation 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

  • Return Codes

    Field Description
    200 Execution succeeded
    401 Access token expired
    404 The interface does not exist, please check the URL
    429 Access interface too frequently, 429 Status code
    400 Error message in HTTP Header [X-FBox-Code],see Appendix Three for details