PI Developer Technologies
Welcome to the
PI Developer Technologies
feedback page!
This forum covers the PI AF SDK, PI Web API, PI OPC DA and HDA Servers, and the PI SQL family. We created this forum to hear your ideas, feature suggestions and feedback. Please suggest your most important features and design change ideas on this site, and vote for your favorite ideas.
Please note that your ideas and comments posted here are visible to all other users.
- For bugs, please open a case with OSIsoft Tech Support through myOSIsoft Customer Portal (https://my.osisoft.com) instead of sharing them on this site.
- For documentation feedback and bugs, please report to documentation@osisoft.com instead of sharing them on this site.
-
Add Options for PI Web API Call Statistics
Add auditing or a view of statistics for the calls or requests done by each individual application. Allow a PI Admin to see which user or application is making a specific call and see how long it takes to complete to monitor performance and potentially resource intensive Web API calls.
37 votesWe are researching and evaluating opportunities to expose PI Web API health, diagnostic, and basic telemetry data.
-
Implement a checkpoint system for index crawls
When the crawler fails on an incremental crawl, the index search must perform a complete rebuild of the index. It would be beneficial for there to be a way to revert to a previous built index just prior to the failed incremental crawl so that the index file is available. This is particularly useful for large data sources that take hours or days to crawl before they're usable again.
12 votes -
Allow parameters to be passed to a request body in the Batch Controller
I would like the ability to pass response values from one request into the body of a dependent request using the batch controller to avoid making 2 calls to the PI Web API.
Currently, I can only use Parameters in subsequent URLs, but not bodies.
12 votesFrank Garriel responded
The idea still exists on our product backlog, but there are no plans in place to develop and release this functionality at this time.
-
Add bulk delete methods in the Web API
As a PI Web API user, I would like a simple method to perform bulk deletes of a particular attribute or PI tag. Currently, a bulk delete requires 2 calls. One to retrieve the event I wish to delete and another to delete it.
11 votesWeb ID 2.0 should allow you to compute the WebID of a resource without needing to make a call to PI Web API. With that computed WebID, you can make the single call to PI Web API to delete the resource.
Does this solution meet your needs? Have I understood it correctly?
-
Add a PI Collective member info PI WebAPI controller
As an end-user, I want to be able to see to which PI Collective member I am connecting to. I also want to be able to toggle programmatically from one PI Collective member to the other so I can make sure the informaiton I am seeing is aligned and in synch accross all PI Collective members without going into thick PI clients or through log files.
10 votesThis is a novel idea for monitoring PI Collective health, but there are no plans to add this ability to PI Web API. What advantages do you see in using PI Web API here?
-
Time Context Value Retrieval
Example Scenario:
We want to know the Specific Electricity Consumption (kWh/mt) over a time period (selected by users).
Specific Electricity Consumption = (Electricity Consumption(kWh)) / (Raw Feed Consumed(mt))
Where, Electricity Consumption (kWh) and Raw Feed Consumed (mt) are both attributes with PIPoint data reference, using value retrieval method: TimeMethod = Time Range; TimeRangeMethod = Total; EventWeighted
Then, Specific Electricity Consumption is attribute with Formula data reference, simply: A=Electricity Consumption; B=Raw Feed Consumed;[A/B]
So, on PI Vision, it can display the specific electricity consumption with the correct values. However, if we query through PI Web API for our own webpage, it…
7 votes -
Restrict Access to Web API Endpoint by User
As a PI Web API administrator, I would like to natively restrict which users can and cannot see particular URLs and controllers on my PI Web API endpoint.
7 votes -
Provide programmatic interface to manage OMF applications
Enable Create,Read, Update, Delete operations for OMF applications via an API so that the process is standardized and efficient/effective as opposed to manual and error prone, especially for larger numbers of apps.
6 votes -
Support attribute types referencing AF Elements and Attributes
We use attributes to reference elements and attributes extensively to model context and relationships in our AF models. Is this going to be supported in the future? Kind regards, Gregor
6 votesThis item is under review. Currently considering the following behavior for attributes links:
Current behavior:
Error returned: “Unsupported data type: ‘OSIsoft.AF.Asset.AFAttribute’.”
Similar error for AFElement.Change under consideration:
Value link for Attributes of value type “Attribute” returns the referenced attribute’s GET response (“/attributes/[webid]”)
Value link for Attributes of value type “Element” returns the referenced element’s GET response (“/elements/[webid]”) -
Service to find changes in the PI System
As a programmer, I want to be able to use the PI Web API to find out about changes in the PI System. This mean Elements, Templates, Attributes, Event Frames and PI Point configuration changes.
6 votes“Finding changes in the PI System” is still being evaluated.
Correction: Previously this was shown as “planned” and part of Stream Updates. Stream Updates will allow you to retrieve data updates instead of having to retrieve the entire stream.
The upcoming PI Web API 2018 SP1 release will tell the caller if the stream has changed (e.g., the PI Point data reference was changed to a different PI Point), so that the caller can re-subscribe to the correct stream. It will not provide a mechanism to know what specifically those changes are on the stream, nor on the entire PI System.
-
Allow Creation of Acknowledgeable Event Frames
The PI Web API exposes a "CanBeAcknowledged" property when reading Event Frames. However, this property is read-only: it cannot be supplied when creating a new Event Frame or updating an existing Event Frame. I would like the ability to include this parameter when creating an Event Frame.
5 votes -
Write annotations on archive data via PI Web API
My client is interested in writing annotations to Stream (time series) data via the PI Web API. I know it's possible to pull this data via the ?associations=annotations query parameters but the write feature is missing.
5 votes -
AdHoc StreamSet actions fail if there is at least one bad WebId
Currently calling any of the AdHoc StreamSet actions causes the entire call to fail if the request includes at least one bad WebId. It would be better if the response came back successful and only the sub-items with bad WebIds included an error message.
5 votes -
Annotate Elements with Web API
Add functionality to annotate AF Elements using Web API.
5 votes -
omf endpoint: override type uom in container messages
OMF 1.2 specification includes an enhancement to allow the use of propertyoverrides keyword in container messages.
Request is to add this functionality to Web API OMF endpoint specifically for the uom propertyFor example:
1. device configured with uom, OMF application creates a type specifying that uom.
2 new version of the device changes the uom. OMF application needs to create containers with the new uom, retaining other properties of the type.4 votes -
Rebuild Index is not working as expected
In the https://pivision-us.oxy.com/piwebapi/admin/search/database.html page the Rebuild Index button does not work. It should allow the pi vision administrator to immediate re-indexing of individual AF database at the time without affecting the usability of the others.
4 votes -
Expose Calculation.PercentTrue
PercentTrue is missing in the WebAPI. Would you consider adding it? For some context, I come from here:
https://pisquare.osisoft.com/message/115587-re-calculation-percenttrue-is-missing-on-the-webapi
4 votes -
Add support for AFElement Versions
Add support for AFElement versions to PI Web API.
1. Create a new Element Version by defining the effective date and an optional version comment. 2. Add Get and Find methods which support querying AFElements by setting a QueryDate.
See also https://pisquare.osisoft.com/message/122510-re-how-to-create-a-new-af-element-version-with-pi-web-api and https://pisquare.osisoft.com/message/590273 votes -
Return Partial Results From Event Frame Search in PI Web API
Currently when searching for event frames, a 400 error is returned if not all elements in the search exist.
piwebapi/eventFrames/search?databaseWebId=WebId&Element:IN("\server\AssetSwap\Site2\Asset1";"\server\AssetSwap\Site2\Asset2"
This is cumbersome especially in the case of asset swapping in PI Vision when parent elements could contain variable child elements. For any parent element that contains less than the max child elements, a 400 error will occur when searching for event frames for related parent elements.
3 votes -
Support Performance Equation Syntax for time parameters in the PI Web API
As a Web API developer, I would like to be able to use time PE functions in the Web API using the streams/streamsets controller to allow for complex time queries.
3 votes
- Don't see your idea?