AVEVA™ PI System™ Feedback Portal

Welcome to our feedback site!


We created this site to hear your enhancement ideas, suggestions and feedback about AVEVA products and services. All of the feedback you share here is monitored and reviewed by the AVEVA product managers.

To start, take a look at the ideas in the list below and VOTE for your favorite ideas submitted by other users. POST your own idea if it hasn’t been suggested yet. Include COMMENTS and share relevant business case details that will help our product team get more information on the suggestion. Please note that your ideas and comments are visible to all other users.


This page is for feedback specifically for AVEVA PI System. For links to our other feedback portals, please see the tab RESOURCES below.

Add a new idea Subscribe
Status Planned
Product AVEVA™ PI System Access (PSA)
Categories Help / Documentation / Videos
Created by Guest
Created on Aug 23, 2022

RELATED IDEAS

Complete PI Web API documentation

As a PI Web API user I want to know exactly what kind of Body Parameters (their defaults and description) are supported by PI Web API methods. The current sample requests are not sufficient because they do not describe the values for body parameter, though many parameters have unique restrictions. Here is an example of desired content: https://developers.jivesoftware.com/api/v3/cloud/rest/StreamEntity.html
  • ADMIN RESPONSE
    Aug 23, 2022
    We have received a lot of feedback on this. We are looking at on-line help with better samples of queries and responses. We are looking at some web frameworks for offering a live "Try It" feature for PI Web API. We are also looking at comprehensive search within the PI Web API help system.
  • Attach files
  • GaryYegiazaryan
    Reply
    |     Jan 19, 2024

    There used to be a Swagger specification, but it was removed from the documentation in PI Web API 2018 SP1 with no explanation as to why.

    It would help speed up development if we had a swagger or open API spec. The current documentation is not sufficient.

    https://docs.aveva.com/bundle/pi-web-api-reference/page/help/changelog/pi-web-api.html#:~:text=Removed%20OpenAPI/Swagger%20specification%20endpoint

  • zwhite
    Reply
    |     Sep 14, 2022

    Here is another great example for api documentation. https://www.bitmex.com/api/explorer/

    Lists all the endpoints and the accepted operations per end point, and then will build a URL based on what ever operations are submitted.

  • Guest
    Reply
    |     Aug 23, 2022
    An example of a good API: http://docs.winkapiv2.apiary.io/#reference/device/camera/get-camera 1. Has a hierarchical navigation (on the left) 2. It explains what the call is and what the parameters / attributes are 3. It give an example request in a lot of different ways: RAW (http), cURL, JAVA, javascript, node.js, Perl, Phyton, PHP, Ruby, Go, C#, VB, Groovy, Objective-C, Swift 4. It gives an example response 5. It allows you to run your a query against a simulated set of data 6. exportable (prefer to pdf for offline reading, but to a standard APIB or swagger is ok) Maybe the included swagger export will help - but that is another tool/client I need to now install learn - if you look at the link above - it almost includes all of my requirements already.