Historian WebAPI

Historian WebAPI provides a RESTful API for the
FactoryTalk®
Historian server. It runs as a
Windows®
service and provides the client applications with read and write permissions to process data from the FactoryTalk Historian system over HTTPS. The URL format is as follows:
  • https://{ComputerName}:{Port}/api/v1.0/{Controller}/{Action}?Parameters=xxx
  • https://{IPv4}:{Port}/api/v1.0/{Controller}/{Action}?Parameters=xxx
TIP:
  • The default port number is 7070, and the default minimum logging level is Info. You can customize the port number and logging level.
  • "v1.0" is the current API version. If it is not provided or the version is invalid, the error message "Invalid API version" displays.
  • Because Historian WebAPI initially runs only with HTTPS, the installer provides a self-signed certificate. As for the production system, we recommend that you replace this self-signed certificate with your custom certificate after the installation.
  • For services whose request type is POST or PUT, the maximum size of the request body should be less than or equal to 2 MB. For services whose request type is GET, the maximum length of the request URL parameter should be less than or equal to 4,096 characters.
To ensure high performance, Historian WebAPI can cache up to three servers where each server can contain up to three thousand Historian points. The server and point overcapacity will overwrite the first cached ones.
For more information, see
Historian WebAPI
 in .
Historian WebAPI supports the following controllers:
In this release, Historian WebAPI is designed for communication between other
Rockwell Automation®
products and
FactoryTalk® Historian Site Edition
. Currently, general production usage of Historian WebAPI by third-party (non-Rockwell Automation) software is not supported.
When working with previous versions of
FactoryTalk Historian SE
, keep the following in mind:
  • To avoid potential conflicts, install Historian WebAPI from
    FactoryTalk Historian SE
     version 12.00.00 on a separate computer from the one running
    FactoryTalk Historian SE
     versions 8.00.00, 9.01.00, 10.00.00, or 11.00.00.
  • FactoryTalk Historian SE
     versions 8.00.00 and 9.01.00 do not include the FTHAPI point source. If you're using WebAPI from version 12.00.00 to connect the Historian SE server from version 8.00.00 or 9.01.00, you will not be able to create Historian points. To create Historian points, use the FTMS point source instead.
Rockwell Automation recognizes that some of the terms that are currently used in our industry and in this publication are not in alignment with the movement toward inclusive language in technology. We are proactively collaborating with industry peers to find alternatives to such terms and making changes to our products and content. Please excuse the use of such terms in our content while we implement these changes.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal