Skip to Main Content
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.

Status No status
Categories PI Web API
Created by Guest
Created on Aug 23, 2022

PI WEB API - Swagger page

It would be great if as an addition to conventional documentation there was a SWAGGER page with short explanation of methods and parameters (including return types, etc.)
  • 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 very clear.

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


  • Guest
    Reply
    |
    Aug 23, 2022
    The PI Web API help docs are good, but they often don't include examples of both inputs AND outputs. Swagger (OpenAPI) is helpful to developers new to the API and helpful when experimenting with possible solutions. It leaves no ambiguity about what input is expected, what additional options might be available, and what output to expect.