Open documentation ↗Overview
Swagger Spec file that describes PI Web API
PI Web API 2018 SP1 Swagger Spec is a business API from osisoft.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 413 endpoints.
At a glance
- Authentication
- No auth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Business
- Base URL
https://devdata.osisoft.com/piwebapi- Version
- 1.11.1.5383
- Endpoints
- 413
- OpenAPI
- Specification ↗
- Spec updated
- 2020-07-22
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://devdata.osisoft.com/piwebapi/" \
-H "Accept: application/json"const response = await fetch("https://devdata.osisoft.com/piwebapi/", {
method: "GET",
headers: {
"Accept": "application/json",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://devdata.osisoft.com/piwebapi/",
headers={
"Accept": "application/json",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | / | Get top level links for this PI System Web API instance. |
| GET | /analyses | Retrieve an Analysis by path. |
| GET | /analyses/search | Retrieve analyses based on the specified conditions. By default, returns all analyses. |
| GET | /analyses/{webId} | Retrieve an Analysis. |
| PATCH | /analyses/{webId} | Update an Analysis. |
| DELETE | /analyses/{webId} | Delete an Analysis. |
| GET | /analyses/{webId}/categories | Get an Analysis' categories. |
| GET | /analyses/{webId}/security | Get the security information of the specified security item associated with the Analysis for a specified user. |
| GET | /analyses/{webId}/securityentries | Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned. |
| POST | /analyses/{webId}/securityentries | Create a security entry owned by the analysis. |
| GET | /analyses/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis with the specified name. |
| PUT | /analyses/{webId}/securityentries/{name} | Update a security entry owned by the analysis. |
| DELETE | /analyses/{webId}/securityentries/{name} | Delete a security entry owned by the analysis. |
| GET | /analysiscategories | Retrieve an analysis category by path. |
| GET | /analysiscategories/{webId} | Retrieve an analysis category. |
| PATCH | /analysiscategories/{webId} | Update an analysis category by replacing items in its definition. |
| DELETE | /analysiscategories/{webId} | Delete an analysis category. |
| GET | /analysiscategories/{webId}/security | Get the security information of the specified security item associated with the analysis category for a specified user. |
| GET | /analysiscategories/{webId}/securityentries | Retrieve the security entries associated with the analysis category based on the specified criteria. By default, all security entries for this analysis category |
| POST | /analysiscategories/{webId}/securityentries | Create a security entry owned by the analysis category. |
| GET | /analysiscategories/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis category with the specified name. |
| PUT | /analysiscategories/{webId}/securityentries/{name} | Update a security entry owned by the analysis category. |
| DELETE | /analysiscategories/{webId}/securityentries/{name} | Delete a security entry owned by the analysis category. |
| GET | /analysisruleplugins | Retrieve an Analysis Rule Plug-in by path. |
| GET | /analysisruleplugins/{webId} | Retrieve an Analysis Rule Plug-in. |
| GET | /analysisrules | Retrieve an Analysis Rule by path. |
| GET | /analysisrules/{webId} | Retrieve an Analysis Rule. |
| PATCH | /analysisrules/{webId} | Update an Analysis Rule by replacing items in its definition. |
| DELETE | /analysisrules/{webId} | Delete an Analysis Rule. |
| GET | /analysisrules/{webId}/analysisrules | Get the child Analysis Rules of the Analysis Rule. |
| POST | /analysisrules/{webId}/analysisrules | Create a new Analysis Rule as a child of an existing Analysis Rule. |
| GET | /analysistemplates | Retrieve an analysis template by path. |
| POST | /analysistemplates | Create an Analysis template based upon a specified Analysis. |
| GET | /analysistemplates/search | Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates. |
| GET | /analysistemplates/{webId} | Retrieve an analysis template. |
| PATCH | /analysistemplates/{webId} | Update an analysis template by replacing items in its definition. |
| DELETE | /analysistemplates/{webId} | Delete an analysis template. |
| GET | /analysistemplates/{webId}/categories | Get an analysis template's categories. |
| GET | /analysistemplates/{webId}/security | Get the security information of the specified security item associated with the analysis template for a specified user. |
| GET | /analysistemplates/{webId}/securityentries | Retrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template |
| POST | /analysistemplates/{webId}/securityentries | Create a security entry owned by the analysis template. |
| GET | /analysistemplates/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis template with the specified name. |
| PUT | /analysistemplates/{webId}/securityentries/{name} | Update a security entry owned by the analysis template. |
| DELETE | /analysistemplates/{webId}/securityentries/{name} | Delete a security entry owned by the analysis template. |
| GET | /assetdatabases | Retrieve an Asset Database by path. |
| GET | /assetdatabases/{webId} | Retrieve an Asset Database. |
| PATCH | /assetdatabases/{webId} | Update an asset database by replacing items in its definition. |
| DELETE | /assetdatabases/{webId} | Delete an asset database. |
| GET | /assetdatabases/{webId}/analyses | Retrieve analyses based on the specified conditions. |
| GET | /assetdatabases/{webId}/analysiscategories | Retrieve analysis categories for a given Asset Database. |
| POST | /assetdatabases/{webId}/analysiscategories | Create an analysis category at the Asset Database root. |
| GET | /assetdatabases/{webId}/analysistemplates | Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned. |
| POST | /assetdatabases/{webId}/analysistemplates | Create an analysis template at the Asset Database root. |
| GET | /assetdatabases/{webId}/attributecategories | Retrieve attribute categories for a given Asset Database. |
| POST | /assetdatabases/{webId}/attributecategories | Create an attribute category at the Asset Database root. |
| GET | /assetdatabases/{webId}/elementattributes | Retrieves a list of element attributes matching the specified filters from the specified asset database. |
| GET | /assetdatabases/{webId}/elementcategories | Retrieve element categories for a given Asset Database. |
| POST | /assetdatabases/{webId}/elementcategories | Create an element category at the Asset Database root. |
| GET | /assetdatabases/{webId}/elements | Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database. |
| POST | /assetdatabases/{webId}/elements | Create a child element. |
| GET | /assetdatabases/{webId}/elementtemplates | Retrieve element templates based on the specified criteria. Only templates of instance type "Element" and "EventFrame" are returned. By default, all element and |
| POST | /assetdatabases/{webId}/elementtemplates | Create a template at the Asset Database root. Specify InstanceType of "Element" or "EventFrame" to create element or event frame template respectively. Only the |
| GET | /assetdatabases/{webId}/enumerationsets | Retrieve enumeration sets for given asset database. |
| POST | /assetdatabases/{webId}/enumerationsets | Create an enumeration set at the Asset Database. |
| GET | /assetdatabases/{webId}/eventframeattributes | Retrieves a list of event frame attributes matching the specified filters from the specified asset database. |
| GET | /assetdatabases/{webId}/eventframes | Retrieve event frames based on the specified conditions. By default, returns all children of the specified root resource that have been active in the past 8 hou |
| POST | /assetdatabases/{webId}/eventframes | Create an event frame. |
| GET | /assetdatabases/{webId}/export | Export the asset database. |
| POST | /assetdatabases/{webId}/import | Import an asset database. |
| GET | /assetdatabases/{webId}/referencedelements | Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database. |
| POST | /assetdatabases/{webId}/referencedelements | Add a reference to an existing element to the specified database. |
| DELETE | /assetdatabases/{webId}/referencedelements | Remove a reference to an existing element from the specified database. |
| GET | /assetdatabases/{webId}/security | Get the security information of the specified security item associated with the asset database for a specified user. |
| GET | /assetdatabases/{webId}/securityentries | Retrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entrie |
| POST | /assetdatabases/{webId}/securityentries | Create a security entry owned by the asset database. |
| GET | /assetdatabases/{webId}/securityentries/{name} | Retrieve the security entry of the specified security item associated with the asset database with the specified name. |
| PUT | /assetdatabases/{webId}/securityentries/{name} | Update a security entry owned by the asset database. |
| DELETE | /assetdatabases/{webId}/securityentries/{name} | Delete a security entry owned by the asset database. |
| GET | /assetdatabases/{webId}/tablecategories | Retrieve table categories for a given Asset Database. |
| POST | /assetdatabases/{webId}/tablecategories | Create a table category on the Asset Database. |
| GET | /assetdatabases/{webId}/tables | Retrieve tables for given Asset Database. |
| POST | /assetdatabases/{webId}/tables | Create a table on the Asset Database. |
| GET | /assetservers | Retrieve a list of all Asset Servers known to this service. |
| GET | /assetservers#name | Retrieve an Asset Server by name. |
| GET | /assetservers#path | Retrieve an Asset Server by path. |
| GET | /assetservers/{webId} | Retrieve an Asset Server. |
| GET | /assetservers/{webId}/analysisruleplugins | Retrieve a list of all Analysis Rule Plug-in's. |
| GET | /assetservers/{webId}/assetdatabases | Retrieve a list of all Asset Databases on the specified Asset Server. |
| POST | /assetservers/{webId}/assetdatabases | Create an asset database. |
| GET | /assetservers/{webId}/notificationcontacttemplates | Retrieve a list of all notification contact templates on the specified Asset Server. |
| POST | /assetservers/{webId}/notificationcontacttemplates | Create a notification contact template. |
| GET | /assetservers/{webId}/notificationplugins | Retrieve a list of all notification plugins on the specified Asset Server. |
| GET | /assetservers/{webId}/security | Get the security information of the specified security item associated with the asset server for a specified user. |
| GET | /assetservers/{webId}/securityentries | Retrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries |
| POST | /assetservers/{webId}/securityentries | Create a security entry owned by the asset server. |
| GET | /assetservers/{webId}/securityentries/{name} | Retrieve the security entry of the specified security item associated with the asset server with the specified name. |
| PUT | /assetservers/{webId}/securityentries/{name} | Update a security entry owned by the asset server. |
| DELETE | /assetservers/{webId}/securityentries/{name} | Delete a security entry owned by the asset server. |
| GET | /assetservers/{webId}/securityidentities | Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned. |
| POST | /assetservers/{webId}/securityidentities | Create a security identity. |
Showing the first 100 of 413 endpoints; the full list is in the documentation.
Questions
Does the PI Web API 2018 SP1 Swagger Spec API need an API key?
No. The PI Web API 2018 SP1 Swagger Spec API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.
Does the PI Web API 2018 SP1 Swagger Spec API support HTTPS?
Yes, the PI Web API 2018 SP1 Swagger Spec API is served over HTTPS.
How many endpoints does the PI Web API 2018 SP1 Swagger Spec API have?
Its OpenAPI description lists 413 endpoints in version 1.11.1.5383. The first 100 are shown on this page.
What are alternatives to the PI Web API 2018 SP1 Swagger Spec API?
Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.
Similar business APIs
Compare alternatives →Gmail
BusinessFlexible, RESTful access to the user's inbox
Google Analytics
BusinessCollect, configure and analyze your data to reach the right audience
Apache Superset
BusinessAPI to manage your BI dashboards and data sources on Superset
Trello
BusinessBoards, lists and cards to help you organize and prioritize your projects
Square
BusinessEasy way to take payments, manage refunds, and help customers checkout online
Mailchimp
BusinessSend marketing campaigns and transactional mails
Listed from APIs.guru (CC0).