How can we improve PI Developer Technologies for you?

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

27 votes
Sign in Sign in with OSIsoft
Signed in as (Sign out)

We’ll send you updates on this idea

Anna Perry shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →
PLANNED  ·  Ray Verhoeff responded  · 

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.

1 comment

Sign in Sign in with OSIsoft
Signed in as (Sign out)
Submitting...
  • Joey Langan commented  ·   ·  Flag as inappropriate

    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.

Feedback and Knowledge Base

Posted ideas will have one of the following statuses.
Full definition of these statuses can be found on the Home Page.
No status
NEEDS MORE DISCUSSION
RESEARCHING/EVALUATING
DECLINED
PLANNED
STARTED/IN DEVELOPMENT
IN BETA
COMPLETED