Get Historical Data List

  • Description

    This interface allows users to retrieve historical data entries.

  • Request Address: (Choose One)

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

    URL2: [Host Server]/api/v2/hdataitems?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 FGate

  • Method

    GET

  • Headers

    Field Type Description
    Authorization string "Bearer " + Access_token obtained in login interface

  • Body

    NULL

  • Successful Response

    Field Type Description
    uid long ID of the historical data entry
    name string Name of the historical data entry
    period int Sampling period (unit: s)
    boxId long FGate ID
    hasCtrl bool Whether settings are enabled
    ctrl jobject Enable settings, see detailed configuration below
    channels jarray Channel settings, see detailed configuration below

    Detailed Configuration of Enable Settings

    Field Type Description
    ctrlType int Enable type, 0: Disable, 1: Enable
    devAlias string PLC alias (device alias in remote download)
    station int 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 bit width, combined with regId to determine a unique register
    regName string Register name, able to determine a unique register, either of the above two parameters is optional
    addr int Main address
    subAddr int Sub address
    addBlk int DB block address

    Channel Configuration Table

    Field Type Description
    uid long Channel ID
    name string Channel name
    unit string Unit
    intDigits int Integer digits
    fracDigits int Decimal places
    desc string Description
    hasSubAddress bool Whether it has a sub-address
    hasSubIndex bool Whether it has a DB block address
    devAlias string PLC alias (device alias in remote download)
    station int 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 bit width, combined with regId to determine a unique register
    regName string Register name, able to determine a unique register, either of the above two parameters is optional
    addr int Main address
    subAddr int Sub address
    addBlk int DB block address

  • Response Codes

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