Get Alarm Entry

  • Description

    This API is used for users to retrieve some alarm entries.

  • Request Address(Choose one)

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

    URL2: [Host Server]/api/v2/box/alarm/get?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 Serial number of the FGate

  • Method

    POST

  • Headers

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

  • Body

    Collection of alarm entry UIDs

  • Successful Response

    Field Type Description
    id string ID of the alarm entry
    code string Alarm entry code
    devAlias string Device alias
    station int PLC communication station No
    dataType int Data type, see Appendix Two for details
    regId int Register ID, combined with ioWidth to determine a unique register
    ioWidth int Register bit width, combined with regId to determine a unique register
    regName string Register name, determine a unique register with either of the above two parameters
    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 Operand 1
    operand2 deciaml Operand 2
    condMethod int Condition combination, 0: None, 1: And, 2: Or
    alarmMsg string Alarm message
    group JSON object Alarm group information, with properties including: id (Group ID), name (Group Name)
    memo string Remark
    deviceChanged boolean Whether the device has been removed (This parameter appears only while removed, and status is true) Occurs when the connected device of FGate changes.
    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 edge execution is enabled. When enabled, numeric calculation must be configured

    Detailed Table 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: Scaling

  • Status Codes

    Code Description
    200 Successful execution
    401 Access token expired
    400 Error message in HTTP Header [X-FBox-Code], details in Appendix Three
    404 Interface does not exist, please check the URL