Automate Osisoft PI 2018 SP1 Swagger Spec
HumDay reads Osisoft PI 2018 SP1 Swagger Spec’s own published API description and derives 413 operations from it. Describe the outcome you want in plain words — you get a program that is written, proven on real data, and run for you.
What Osisoft PI 2018 SP1 Swagger Spec is
Swagger Spec file that describes PI Web API
API host: devdata.osisoft.com
What HumDay can do in Osisoft PI 2018 SP1 Swagger Spec
161 documented operations change something in Osisoft PI 2018 SP1 Swagger Spec. The 55 most useful are listed here.
- PATCHUpdate a notification contact template by replacing items in its definition.
/notificationcontacttemplates/{webId} - POSTCreate a new attribute of the specified event frame.
/eventframes/{webId}/attributes - POSTCreate a notification contact template.
/assetservers/{webId}/notificationcontacttemplates - POSTCreate a link for a "Search Elements By Attribute Value" operation, whose queries are specified in the request content.
/elements/searchbyattribute - POSTCreate a security entry owned by the notification contact template.
/notificationcontacttemplates/{webId}/securityentries - POSTCreate a link for a "Search EventFrames By Attribute Value" operation, whose queries are specified in the request content.
/eventframes/searchbyattribute - PATCHUpdate an event frame by replacing items in its definition.
/eventframes/{webId} - PATCHUpdate a notification rule by replacing items in its definition.
/notificationrules/{webId} - PATCHUpdate a notification rule template by replacing items in its definition.
/notificationruletemplates/{webId} - DELETEDelete a notification contact template.
/notificationcontacttemplates/{webId} - POSTCreate an Analysis template based upon a specified Analysis.
/analysistemplates - POSTExecutes the create configuration function of the data references found within the attributes of the event frame, and optionally, its children.
/eventframes/{webId}/config - POSTCreate a new attribute of the specified element.
/elements/{webId}/attributes - POSTCreate a new attribute as a child of the specified attribute.
/attributes/{webId}/attributes - POSTCreate an annotation on an event frame.
/eventframes/{webId}/annotations - POSTCreate an event frame as a child of the specified event frame.
/eventframes/{webId}/eventframes - POSTCreate an event frame.
/assetdatabases/{webId}/eventframes - POSTCreate a notification rule.
/elements/{webId}/notificationrules - POSTCreate a new Analysis Rule as a child of an existing Analysis Rule.
/analysisrules/{webId}/analysisrules - POSTCreate a security entry owned by the event frame.
/eventframes/{webId}/securityentries - POSTCreate a security entry owned by the notification rule.
/notificationrules/{webId}/securityentries - POSTCreate a security entry owned by the notification rule template.
/notificationruletemplates/{webId}/securityentries - POSTCreate a notification rule template.
/elementtemplates/{webId}/notificationruletemplates - POSTCreate a notification rule subscriber.
/notificationrules/{webId}/notificationrulesubscribers - PATCHUpdate a table by replacing items in its definition.
/tables/{webId} - PATCHUpdate an element by replacing items in its definition.
/elements/{webId} - PATCHUpdate a Time Rule by replacing items in its definition.
/timerules/{webId} - PATCHUpdate an attribute by replacing items in its definition.
/attributes/{webId} - DELETEDelete an event frame.
/eventframes/{webId} - PATCHUpdate an Analysis Rule by replacing items in its definition.
/analysisrules/{webId} - POSTCreate a notification rule subscriber.
/notificationruletemplates/{webId}/notificationrulesubscribers - PATCHUpdate an asset database by replacing items in its definition.
/assetdatabases/{webId} - PATCHUpdate an enumeration set by replacing items in its definition.
/enumerationsets/{webId} - PATCHUpdate a table category by replacing items in its definition.
/tablecategories/{webId} - PATCHUpdate an element template by replacing items in its definition.
/elementtemplates/{webId} - PATCHUpdate a security mapping by replacing items in its definition.
/securitymappings/{webId} - PATCHUpdate an analysis template by replacing items in its definition.
/analysistemplates/{webId} - PATCHUpdate an element category by replacing items in its definition.
/elementcategories/{webId} - PATCHUpdate an enumeration value by replacing items in its definition.
/enumerationvalues/{webId} - DELETEDelete a notification rule.
/notificationrules/{webId} - PATCHUpdate an analysis category by replacing items in its definition.
/analysiscategories/{webId} - PATCHUpdate an existing attribute template by replacing items in its definition.
/attributetemplates/{webId} - PATCHUpdate a security identity by replacing items in its definition.
/securityidentities/{webId} - PATCHUpdate an attribute category by replacing items in its definition.
/attributecategories/{webId} - POSTExecute a batch of requests against the service.
/batch - PATCHUpdate an annotation on an event frame by replacing items in its definition.
/eventframes/{webId}/annotations/{id} - DELETEDelete a notification rule template.
/notificationruletemplates/{webId} - DELETEDelete a notification rule subscriber.
/notificationrulesubscribers/{webId} - PATCHUpdate a notification rule subscriber.
/notificationrulesubscribers/{webId} - POSTExecutes the create configuration function of the data references found within the attributes of the element, and optionally, its children.
/elements/{webId}/config - PUTSet the value of a configuration item attribute.
/attributes/{webId}/value - POSTCreate or update an attribute's DataReference configuration (Create/Update PI point for PI Point DataReference).
/attributes/{webId}/config - POSTCreate an Analysis.
/elements/{webId}/analyses - POSTCreate a child element.
/elements/{webId}/elements - POSTCreate a unit in the specified Unit Class.
/unitclasses/{webId}/units
What HumDay can read from Osisoft PI 2018 SP1 Swagger Spec
These are the operations a schedule or a trigger can watch.
- GETOpens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute.
/streamsets/{webId}/channel - GETRetrieves a list of currently running channel instances.
/channels/instances - GETOpens a channel that will send messages about any value changes for the specified streams.
/streamsets/channel - GETGet the security information of the specified security item associated with the notification contact template for a specified user.
/notificationcontacttemplates/{webId}/security - GETRetrieve notification contact templates based on the specified conditions.
/notificationcontacttemplates/search - GETOpens a channel that will send messages about any value changes for the specified stream.
/streams/{webId}/channel - GETGet the security information of the specified security item associated with the event frame for a specified user.
/eventframes/{webId}/security - GETRetrieve a notification contact template by path.
/notificationcontacttemplates - GETGet the security information of the specified security item associated with the notification rule for a specified user.
/notificationrules/{webId}/security - GETGet the security information of the specified security item associated with the notification rule template for a specified user.
/notificationruletemplates/{webId}/security - GETRetrieve event frames based on the specified conditions.
/eventframes/search - GETRetrieve a list of all notification contact templates on the specified Asset Server.
/assetservers/{webId}/notificationcontacttemplates - GETRetrieve notification rules based on the specified conditions.
/notificationrules/search - GETRetrieve Notification rule templates based on the specified conditions.
/notificationruletemplates/search - GETRetrieve a list of Data Servers known to this service.
/dataservers - GETRetrieve an event frame by path.
/eventframes - GETRetrieve a notification contact template.
/notificationcontacttemplates/{webId} - GETRetrieve a list of all Asset Servers known to this service.
/assetservers - GETRetrieve a notification rule by path.
/notificationrules - GETGet the security information of the specified security item associated with the table for a specified user.
/tables/{webId}/security - GETRetrieve a notification plugin by path.
/notificationplugIns - GETGet the security information of the specified security item associated with the Analysis for a specified user.
/analyses/{webId}/security - GETGet the security information of the specified security item associated with the element for a specified user.
/elements/{webId}/security - GETGet the security information of the specified security item associated with the asset server for a specified user.
/assetservers/{webId}/security - GETRetrieve a notification rule template by path.
/notificationruletemplates - GETGet the security information of the specified security item associated with the asset database for a specified user.
/assetdatabases/{webId}/security - GETGet the security information of the specified security item associated with the enumeration set for a specified user.
/enumerationsets/{webId}/security - GETRetrieve a notification rule subscriber by path.
/notificationrulesubscribers - GETGet the security information of the specified security item associated with the table category for a specified user.
/tablecategories/{webId}/security - GETGet the security information of the specified security item associated with the element template for a specified user.
/elementtemplates/{webId}/security - GETGet the security information of the specified security item associated with the security mapping for a specified user.
/securitymappings/{webId}/security - GETGet the security information of the specified security item associated with the analysis template for a specified user.
/analysistemplates/{webId}/security - GETGet the security information of the specified security item associated with the element category for a specified user.
/elementcategories/{webId}/security - GETGet the security information of the specified security item associated with the analysis category for a specified user.
/analysiscategories/{webId}/security - GETGet the security information of the specified security item associated with the security identity for a specified user.
/securityidentities/{webId}/security - GETGet the security information of the specified security item associated with the attribute category for a specified user.
/attributecategories/{webId}/security - GETRetrieve analyses based on the specified conditions.
/analyses/search - GETRetrieve a list of all notification plugins on the specified Asset Server.
/assetservers/{webId}/notificationplugins - GETRetrieve elements based on the specified conditions.
/elements/search - GETRetrieves a list of event frame attributes matching the specified filters from the specified event frame.
/eventframes/{webId}/eventframeattributes - GETRetrieve attributes based on the specified conditions.
/attributes/search - GETRetrieves a list of event frame attributes matching the specified filters from the specified asset database.
/assetdatabases/{webId}/eventframeattributes - GETRetrieve multiple event frames by web ids or paths.
/eventframes/multiple - GETRetrieve analysis templates based on the specified conditions.
/analysistemplates/search - GETRetrieve the security entries associated with the notification contact template based on the specified criteria.
/notificationcontacttemplates/{webId}/securityentries
How automating Osisoft PI 2018 SP1 Swagger Spec works
- Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
- Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
- See it proven. The program runs and shows you the result before it is allowed near your live Osisoft PI 2018 SP1 Swagger Spec account.
- Grant access, then go live. You approve the specific Osisoft PI 2018 SP1 Swagger Spec operations it may use — and only those.
Automate Osisoft PI 2018 SP1 Swagger Spec with these
Categories
Questions about Osisoft PI 2018 SP1 Swagger Spec automation
- Can HumDay connect to Osisoft PI 2018 SP1 Swagger Spec?
- Yes. HumDay reads Osisoft PI 2018 SP1 Swagger Spec's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 413 operations are documented.
- Do I need to write code to automate Osisoft PI 2018 SP1 Swagger Spec?
- No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your Osisoft PI 2018 SP1 Swagger Spec account.
- What can HumDay do in Osisoft PI 2018 SP1 Swagger Spec?
- 161 of the 413 documented operations change something in Osisoft PI 2018 SP1 Swagger Spec, and 252 read from it. HumDay only ever uses the specific operations your approved contract needs.
- Is my Osisoft PI 2018 SP1 Swagger Spec account safe?
- Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to Osisoft PI 2018 SP1 Swagger Spec is held behind that approval.
Where this came from
The operations above are read from a published API description for Osisoft PI 2018 SP1 Swagger Spec at devdata.osisoft.com/piwebapi/help/specification. Descriptions are the provider’s own words, not ours. Last published 2020-07-22.