• HTTP document
    Show / Hide Table of Contents
    • Login Interface
      • Explanation of terms
      • Login
      • Refresh Login
    • Write Data Process
      • Add FGate Group
      • Add FGate
      • Add Monitoring Group
      • Add Monitoring Point
      • Get FGate List
      • FGate Monitoring List
      • Write Monitoring Value
      • Get Monitoring Value
    • Information Access
      • Get Single FGate
      • Get Monitoring Group
      • Get Some monitoring Points
      • Get Monitoring Point by Group
      • Get Iccid、Imei
      • Get Location of FGate
    • Remote Download
      • Get FGate Drive List
      • Download FGate Drive
      • Get Register Type of Device
      • Get Server Drive List
    • Modification Interface
      • Modify FGate Group
      • Modify FGate Name
      • Modify Monitoring
      • Modify Refresh Interval
    • Delete Interface
      • Delete FGate Group
      • Delete FGate
      • Delete Monitoring Group
      • Delete Monitoring Point
    • Alarm Interface
      • Alarm Group
        • Get Alarm Group List
        • Add Alarm Group
        • Modify Alarm Group
        • Delete Alarm Group
      • Alarm Contact
        • Get Alarm Contact List
        • Get Single Alarm Contact
        • Add Alarm contact
        • Modify Alarm Contact
        • Delete Alarm Contact
      • Alarm Record
        • Get Alarm Entry List
        • Get Alarm Entry
        • Add Alarm Entry
        • Modify Alarm Entry
        • Delete Alarm Entry
        • Get Historical Alarm
        • Get Alarm Entry Status
        • Confirm Alarm
    • Historical Data
      • Get Historical Data List
      • Get Historical Data Entry
      • Add Historical Record
      • Update Historical Record
      • Delete Historical Data
      • Get Historical Data
    • Push Monitoring Data
      • Enable Monitoring Group
      • Disable Monitoring Group
      • Enable Monitoring Group List
      • Disable Monitoring Group List
      • Enable All Monitoring Points
      • Disable All Monitoring Points
      • Enable One Monitoring Point
      • Disable One Monitoring Point
      • Enable Some Monitoring Points
      • Disable Some Monitoring Points
      • Enable Some Monitoring Points
      • Enable One Monitoring Group
      • Enable Some Monitoring Groups
    • Data Push(SignalR)
      • Real-time Data Push(signalR)
      • Status Change Push
      • Real-time Data Push
      • Alarm Trigger
      • Alarm Restore
    • Write in Batch
      • Get Bacth Write Group
      • Write Value in Batch
    • Appendix
      • Appendix One
      • Appendix Two
      • Appendix Three
      • 429 Status Code

    Update Historical Record

    • 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 the FGate
    • Method

      POST

    • Header

      Field Type Description
      Authorization string "Bearer " + access_token obtained from login interface
    • Body
      Multiple-channel history record collection, with properties as follows:

      Field Type Description
      uid long History record entry Id
      name string Name of the history record entry
      period int Sampling period in seconds, range: 1-86400
      channels Array Channel collection, individual attributes see table below
      hasctrl bool Whether to use enable, if used, enable configuration needs to be set
      ctrl object Enable configuration properties

      Individual attributes for channels:

      Field Type Description
      name string Channel name
      unit string Channel unit
      desc string Channel description
      intDigits int Integer digits of the channel
      fracDigits int Fractional digits of the channel
      devAlias string Device driver alias
      station int PLC communication station No
      dataType int Data type, details in Appendix Two, not supporting binary, hexadecimal, string types
      regId int Register Id, combined with ioWidth, uniquely determines the register
      ioWidth int Register bit width, combined with regId, uniquely determines the register
      regName string Register name, can uniquely determine the register, choose one of the above two parameters
      addr int PLC main address
      subAddr int PLC sub-address
      addrBlk int PLC DB block address
      valueTransform jobject Numeric operation settings
      executeOnEdge boolean Whether to enable edge computing, must be configured for numeric operation to be enabled

      Detailed table for numeric operation settings:

      Field Type Description
      maxValue int Maximum value
      minValue int Minimum value
      scaleMaxValue int Maximum scale value
      scaleMinValue int Minimum scale value
      gain int Gain
      offset int Offset
      type int 1: Proportional conversion, 2: Scaling

      Enable configuration properties:

      Field Type Description
      ctrlType int Enable item, 0: Disable, 1: Enable
      devAlias string PLC alias (device alias in remote download)
      station int Station No
      dataType int Data type, details in Appendix Two
      regId int Register Id, combined with ioWidth, uniquely determines the register
      ioWidth int Register bit width, combined with regId, uniquely determines the register
      regName string Register name, can uniquely determine the register, choose one of the above two parameters
      addr int PLC main address
      subAddr int PLC sub-address
      addrBlk int PLC DB block address
    • Successful Response

      NULL

    • Response Codes

      Code Description
      200 Execution successful.
      401 Access token expired.
      400 Error message in HTTP Header [X-FBox-Code], details in Appendix Three.
      429 Access the interface so frequent. See 429 Status code
    Back to top Generated by DocFX