Get Historical Data Entry

  • Description

    This API is used to retrieve some historical record entries.

  • Request Address (Choose one)

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

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

  • Address Parameter Description

    Field Type Descrption
    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 Descrption
    Authorization string "Bearer " + Access Token obtained from the login interface

  • Body

    Field Type Descrption
    ids long array Collection of historical record IDs, either this or names
    names string array Collection of historical record names, either this or IDs

  • Successful Response

    Field Type Descrption
    uid long Multi-channel ID of historical data
    name string Multi-channel name of historical data
    period int Acquisition period (unit: s)
    boxId long FGate Id
    hasCtrl bool Whether to enable settings
    ctrl JObject Enable settings, see detailed enable settings table
    channels JArray Channel settings, see channel configuration table

    Detailed Table of Enable Settings

    Field Type Descrption
    ctrlType int Enable item, 0: Disabled;1: Enabled
    devAlias string PLC alias (device alias in remote download)
    station int 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, able to determine a unique register with either of the above two parameters
    addr int Main address
    subAddr int Subaddress
    addBlk int DB block address
    valueTransform jobject Numeric calculation settings
    executeOnEdge boolean Whether edge execution is enabled, numeric calculation must be configured when enabled

    Detailed information of Value Transformation Settings

    Field Type Descrption
    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

    Channel Configuration Table

    Field Type Descrption
    uid long Channel ID
    name string Channel name
    unit string Unit
    intDigits int Integer digits
    fracDigits int Decimal digits
    desc string Description
    hasSubAddress bool Whether there is a subaddress
    hasSubIndex bool Whether there is a DB block address
    devAlias string PLC alias (device alias in remote download)
    Station int 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, able to determine a unique register with either of the above two parameters
    addr int Main address
    subAddr int Subaddress
    addBlk int DB block address

  • 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
    429 Access the interface so frequently. See 429 Status code