Professional Documents
Culture Documents
PI Web API
Rockwell Automation
Rockwell logo
Automation
Listen
Think
Solve Center
TechConnect
Customer Care
ADD TO FAVORITES
Document ID
QA57970
Published Date
06/18/2020
Summary
FactoryTalk Historian SE: PI Web Services vs. PI Web API
Question
What’s the difference between PI Web Services vs. PI Web API?
Which FactoryTalk Historian uses which?
Where can I get some additional training information?
Answer
Historian SE Advanced Server option is required for the PI Web Services
Top
Following definition are taken from the OSI support site:
https://rockwellautomation.custhelp.com/app/answers/answer_view/a_id/1092686/loc/en_US 1/5
10/12/2021 16:22 FactoryTalk Historian SE: PI Web Services vs. PI Web API
PI Web Services
PI Web Services consists of a web service that accesses PI System data (PI and AF) in
response to web service queries. It enables the retrieval of data types supported by
the PI System, which include data related to PI Points, PI AF Elements, and PI Event
Frames. The web service is a Windows Communication Foundation (WCF) service
that allows web services clients to access PI System data through Simple Object
Access Protocol (SOAP). PI Web Services supports writing data to the PI System as
well as retrieval of standard PI summary calculations.
PI Web Services is designed for lightweight, firewall-friendly data access over LAN or
WAN and facilitates 2 main scenarios:
Development of customer thick or thin/web applications, in various
programming languages and on various operating systems.
Integration of PI System data within other Enterprise Business Systems, such as
ERPs and data orchestration engines.
PI Web API
The PI Web API is a RESTful interface to the PI system. It gives client applications
read and write access to their AF and PI data over HTTPS.
REST stands for 'representational state transfer.' In the context of the PI Web API, this
means that the API is:
Stateless
The PI Web API is stateless. This means that the service retains no observable
knowledge of clients across requests. Each request is an independent transaction
between the client and the server. One important consequence of this property is
that the check out - make changes - check in transaction pattern found in many
database-related APIs (e.g. the AFSDK) is not exposed by the PI Web API. Rather,
Top
each request encapsulates this pattern internally.
https://rockwellautomation.custhelp.com/app/answers/answer_view/a_id/1092686/loc/en_US 2/5
10/12/2021 16:22 FactoryTalk Historian SE: PI Web Services vs. PI Web API
Resource-oriented
Interaction with the PI Web API is organized around resources. A resource is a
structured piece of data that represents an object in one of the PI Systems
connected to the Web API. Most important PI and AF objects, such as Asset Servers,
Data Servers, points, elements, attributes, event frames, and so on, map to resources
in the PI Web API. Four primary operations are used to interact with these resources:
create, read, update, and delete (often abbreviated as CRUD).
Navigable by links
Links (also called hypermedia) capture the organization of the resources exposed by
the Web API. You're probably familiar with the hierarchical structure of AF objects:
Asset Servers contain databases, which contain elements, which contain attributes,
and so on. Links express these relationships. For example, an Asset Server resource
links to the collection of databases it contains, and each database links to its parent
Asset Server.
OSI Training videos for PI WEB API
Historian versions:
PI Web Services 2010 R2
491469 FactoryTalk Historian SE: What's New in v3.00.xx?
OSI Release Notes
PI Web Services 2012
562414 FactoryTalk Historian SE: What's New in v4.00 & v4.00.01?
OSI Release Notes
OSI User Guide
PI Web API 2016
1026195 FactoryTalk Historian SE: What's New in v5.01?
Top
PI Web API 2017
https://rockwellautomation.custhelp.com/app/answers/answer_view/a_id/1092686/loc/en_US 3/5
10/12/2021 16:22 FactoryTalk Historian SE: PI Web Services vs. PI Web API
RATE CONTENT
DISCLAIMER
This knowledge base web site is intended to provide general technical information on a particular subject or
subjects and is not an exhaustive treatment of such subjects. Accordingly, the information in this web site is not
intended to constitute application, design, software or other professional engineering advice or services. Before
making any decision or taking any action, which might affect your equipment, you should consult a qualified
professional advisor.
ROCKWELL AUTOMATION DOES NOT WARRANT THE COMPLETENESS, TIMELINESS OR ACCURACY OF ANY OF THE
DATA CONTAINED IN THIS WEB SITE AND MAY MAKE CHANGES THERETO AT ANY TIME IN ITS SOLE DISCRETION
WITHOUT NOTICE. FURTHER, ALL INFORMATION CONVEYED HEREBY IS PROVIDED TO USERS "AS IS." IN NO EVENT
SHALL ROCKWELL BE LIABLE FOR ANY DAMAGES OF ANY KIND INCLUDING DIRECT, INDIRECT, INCIDENTAL,
CONSEQUENTIAL, LOSS PROFIT OR DAMAGE, EVEN IF ROCKWELL AUTOMATION HAVE BEEN ADVISED ON THE
POSSIBILITY OF SUCH DAMAGES.
ROCKWELL AUTOMATION DISCLAIMS ALL WARRANTIES WHETHER EXPRESSED OR IMPLIED IN RESPECT OF THE
INFORMATION (INCLUDING SOFTWARE) PROVIDED HEREBY, INCLUDING THE IMPLIED WARRANTIES OF FITNESS
FOR A PARTICULAR PURPOSE, MERCHANTABILITY, AND NON-INFRINGEMENT. Note that certain jurisdictions do not
countenance the exclusion of implied warranties; thus, this disclaimer may not apply to you.
Top
www.rockwellautomation.com
https://rockwellautomation.custhelp.com/app/answers/answer_view/a_id/1092686/loc/en_US 4/5
10/12/2021 16:22 FactoryTalk Historian SE: PI Web Services vs. PI Web API
Copyright © 2021 Rockwell Automation, Inc. All Rights Reserved.
Top
https://rockwellautomation.custhelp.com/app/answers/answer_view/a_id/1092686/loc/en_US 5/5