Swagger Spec file that describes PI Web API
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://devdata.osisoft.com/piwebapi
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Swagger Spec file that describes PI Web API
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Get top level links for this PI System Web API instance. Home |
GET | /analyses | Retrieve an Analysis by path. This method returns an Analysis based on the hierarchical path associated with i |
GET | /analyses/search | Retrieve analyses based on the specified conditions. By default, returns all analyses. Analysis |
GET | /analyses/{webId} | Retrieve an Analysis. Analysis |
PATCH | /analyses/{webId} | Update an Analysis. Analysis |
DELETE | /analyses/{webId} | Delete an Analysis. Analysis |
GET | /analyses/{webId}/categories | Get an Analysis' categories. Analysis |
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 se |
POST | /analyses/{webId}/securityentries | Create a security entry owned by the analysis. Analysis |
GET | /analyses/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis with the specified name. Analysis |
PUT | /analyses/{webId}/securityentries/{name} | Update a security entry owned by the analysis. Analysis |
DELETE | /analyses/{webId}/securityentries/{name} | Delete a security entry owned by the analysis. Analysis |
GET | /analysiscategories | Retrieve an analysis category by path. AnalysisCategory |
GET | /analysiscategories/{webId} | Retrieve an analysis category. AnalysisCategory |
PATCH | /analysiscategories/{webId} | Update an analysis category by replacing items in its definition. AnalysisCategory |
DELETE | /analysiscategories/{webId} | Delete an analysis category. AnalysisCategory |
GET | /analysiscategories/{webId}/security | Get the security information of the specified security item associated with the analysis category for a specif |
GET | /analysiscategories/{webId}/securityentries | Retrieve the security entries associated with the analysis category based on the specified criteria. By defaul |
POST | /analysiscategories/{webId}/securityentries | Create a security entry owned by the analysis category. AnalysisCategory |
GET | /analysiscategories/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis category with the specified name. AnalysisCategory |
PUT | /analysiscategories/{webId}/securityentries/{name} | Update a security entry owned by the analysis category. AnalysisCategory |
DELETE | /analysiscategories/{webId}/securityentries/{name} | Delete a security entry owned by the analysis category. AnalysisCategory |
GET | /analysisruleplugins | Retrieve an Analysis Rule Plug-in by path. This method returns an Analysis Rule Plug-in based on the hierarchi |
GET | /analysisruleplugins/{webId} | Retrieve an Analysis Rule Plug-in. AnalysisRulePlugIn |
GET | /analysisrules | Retrieve an Analysis Rule by path. This method returns an Analysis Rule based on the hierarchical path associa |
GET | /analysisrules/{webId} | Retrieve an Analysis Rule. AnalysisRule |
PATCH | /analysisrules/{webId} | Update an Analysis Rule by replacing items in its definition. AnalysisRule |
DELETE | /analysisrules/{webId} | Delete an Analysis Rule. AnalysisRule |
GET | /analysisrules/{webId}/analysisrules | Get the child Analysis Rules of the Analysis Rule. AnalysisRule |
POST | /analysisrules/{webId}/analysisrules | Create a new Analysis Rule as a child of an existing Analysis Rule. AnalysisRule |
GET | /analysistemplates | Retrieve an analysis template by path. This method returns an analysis template based on the hierarchical path |
POST | /analysistemplates | Create an Analysis template based upon a specified Analysis. AnalysisTemplate |
GET | /analysistemplates/search | Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates. Ana |
GET | /analysistemplates/{webId} | Retrieve an analysis template. AnalysisTemplate |
PATCH | /analysistemplates/{webId} | Update an analysis template by replacing items in its definition. AnalysisTemplate |
DELETE | /analysistemplates/{webId} | Delete an analysis template. Deleting an analysis template will delete any analysis which was created from it, |
GET | /analysistemplates/{webId}/categories | Get an analysis template's categories. AnalysisTemplate |
GET | /analysistemplates/{webId}/security | Get the security information of the specified security item associated with the analysis template for a specif |
GET | /analysistemplates/{webId}/securityentries | Retrieve the security entries associated with the analysis template based on the specified criteria. By defaul |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://devdata.osisoft.com/piwebapi/help/specification
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.