Osisoft

PI Web API 2018 SP1 Swagger Spec

Swagger Spec file that describes PI Web API

Other#openapi#enterprise

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Swagger Spec file that describes PI Web API

Endpoints 400

Home

  • GETGet top level links for this PI System Web API instance./

Analysis

  • GETRetrieve an Analysis by path./analyses?path=string&selectedFields=string&webIdType=stringThis method returns an Analysis based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of…
  • GETRetrieve analyses based on the specified conditions. By default, returns all analyses./analyses/search?databaseWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • GETRetrieve an Analysis./analyses/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an Analysis./analyses/:webId
  • PATCHUpdate an Analysis./analyses/:webId
  • GETGet an Analysis' categories./analyses/:webId/categories?selectedFields=string&webIdType=string
  • GETGet the security information of the specified security item associated with the Analysis for a specified user./analyses/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned./analyses/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the analysis./analyses/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the analysis with the specified name./analyses/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the analysis./analyses/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the analysis./analyses/:webId/securityentries/:name?applyToChildren=true

AnalysisCategory

  • GETRetrieve an analysis category by path./analysiscategories?path=string&selectedFields=string&webIdType=string
  • GETRetrieve an analysis category./analysiscategories/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an analysis category./analysiscategories/:webId
  • PATCHUpdate an analysis category by replacing items in its definition./analysiscategories/:webId
  • GETGet the security information of the specified security item associated with the analysis category for a specified user./analysiscategories/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the analysis category based on the specified criteria. By default, all security entries for this analysis category are returned./analysiscategories/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the analysis category./analysiscategories/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the analysis category with the specified name./analysiscategories/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the analysis category./analysiscategories/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the analysis category./analysiscategories/:webId/securityentries/:name?applyToChildren=true

AnalysisRulePlugIn

  • GETRetrieve an Analysis Rule Plug-in by path./analysisruleplugins?path=string&selectedFields=string&webIdType=stringThis method returns an Analysis Rule Plug-in based on the hierarchical path associated with it, and should be used when a path has been received from a…
  • GETRetrieve an Analysis Rule Plug-in./analysisruleplugins/:webId?selectedFields=string&webIdType=string

AnalysisRule

  • GETRetrieve an Analysis Rule by path./analysisrules?path=string&selectedFields=string&webIdType=stringThis method returns an Analysis Rule based on the hierarchical path associated with it, and should be used when a path has been received from a separate part…
  • GETRetrieve an Analysis Rule./analysisrules/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an Analysis Rule./analysisrules/:webId
  • PATCHUpdate an Analysis Rule by replacing items in its definition./analysisrules/:webId
  • GETGet the child Analysis Rules of the Analysis Rule./analysisrules/:webId/analysisrules?maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&webIdType=string
  • POSTCreate a new Analysis Rule as a child of an existing Analysis Rule./analysisrules/:webId/analysisrules?webIdType=string

AnalysisTemplate

  • GETRetrieve an analysis template by path./analysistemplates?path=string&selectedFields=string&webIdType=stringThis method returns an analysis template based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • POSTCreate an Analysis template based upon a specified Analysis./analysistemplates?analysisWebId=string&name=string&webIdType=string
  • GETRetrieve analysis templates based on the specified conditions. By default, returns all analysis templates./analysistemplates/search?databaseWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • GETRetrieve an analysis template./analysistemplates/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an analysis template./analysistemplates/:webIdDeleting an analysis template will delete any analysis which was created from it, unless the analysis is tied to a notification.
  • PATCHUpdate an analysis template by replacing items in its definition./analysistemplates/:webId
  • GETGet an analysis template's categories./analysistemplates/:webId/categories?selectedFields=string&webIdType=string
  • GETGet the security information of the specified security item associated with the analysis template for a specified user./analysistemplates/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template are returned./analysistemplates/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the analysis template./analysistemplates/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the analysis template with the specified name./analysistemplates/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the analysis template./analysistemplates/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the analysis template./analysistemplates/:webId/securityentries/:name?applyToChildren=true

AssetDatabase

  • GETRetrieve an Asset Database by path./assetdatabases?path=string&selectedFields=string&webIdType=stringThis method returns an asset database based on the hierarchical path associated with it, and should be used when a path has been received from a separate part…
  • GETRetrieve an Asset Database./assetdatabases/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an asset database./assetdatabases/:webId
  • PATCHUpdate an asset database by replacing items in its definition./assetdatabases/:webId
  • GETRetrieve analyses based on the specified conditions./assetdatabases/:webId/analyses?field=string&maxCount=0&query=string&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&webIdType=stringUsers can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter…
  • GETRetrieve analysis categories for a given Asset Database./assetdatabases/:webId/analysiscategories?selectedFields=string&webIdType=string
  • POSTCreate an analysis category at the Asset Database root./assetdatabases/:webId/analysiscategories?webIdType=string
  • GETRetrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned./assetdatabases/:webId/analysistemplates?field=string&maxCount=0&query=string&selectedFields=string&sortField=string&sortOrder=string&webIdType=stringUsers can search for the analysis templates based on specific search parameters. If no parameters are specified in the search, the default values for each…
  • POSTCreate an analysis template at the Asset Database root./assetdatabases/:webId/analysistemplates?webIdType=stringAnalyses that are based on an analysis template will inherit characteristics defined in the template.
  • GETRetrieve attribute categories for a given Asset Database./assetdatabases/:webId/attributecategories?selectedFields=string&webIdType=string
  • POSTCreate an attribute category at the Asset Database root./assetdatabases/:webId/attributecategories?webIdType=string
  • GETRetrieves a list of element attributes matching the specified filters from the specified asset database./assetdatabases/:webId/elementattributes?associations=string&attributeCategory=string&attributeDescriptionFilter=string&attributeNameFilter=string&attributeType=string&elementCategory=string&elementDescriptionFilter=string&elementNameFilter=string&elementTemplate=string&elementType=string&maxCount=0&searchFullHierarchy=true&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&webIdType=string
  • GETRetrieve element categories for a given Asset Database./assetdatabases/:webId/elementcategories?selectedFields=string&webIdType=string
  • POSTCreate an element category at the Asset Database root./assetdatabases/:webId/elementcategories?webIdType=string
  • GETRetrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database./assetdatabases/:webId/elements?associations=string&categoryName=string&descriptionFilter=string&elementType=string&maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&templateName=string&webIdType=stringUsers can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter…
  • POSTCreate a child element./assetdatabases/:webId/elements?webIdType=string
  • GETRetrieve element templates based on the specified criteria. Only templates of instance type "Element" and "EventFrame" are returned. By default, all element and event frame templates in the specified Asset Database are returned./assetdatabases/:webId/elementtemplates?field=string&maxCount=0&query=string&selectedFields=string&sortField=string&sortOrder=string&webIdType=stringUsers can search for the element and event frame template based on specific search parameters. If no parameters are specified in the search, the default…
  • POSTCreate a template at the Asset Database root. Specify InstanceType of "Element" or "EventFrame" to create element or event frame template respectively. Only these two types of templates can be created./assetdatabases/:webId/elementtemplates?webIdType=stringElements and event frames that are based on an element template will inherit characteristics defined in the template.
  • GETRetrieve enumeration sets for given asset database./assetdatabases/:webId/enumerationsets?selectedFields=string&webIdType=string
  • POSTCreate an enumeration set at the Asset Database./assetdatabases/:webId/enumerationsets?webIdType=string
  • GETRetrieves a list of event frame attributes matching the specified filters from the specified asset database./assetdatabases/:webId/eventframeattributes?associations=string&attributeCategory=string&attributeDescriptionFilter=string&attributeNameFilter=string&attributeType=string&endTime=string&eventFrameCategory=string&eventFrameDescriptionFilter=string&eventFrameNameFilter=string&eventFrameTemplate=string&maxCount=0&referencedElementNameFilter=string&searchFullHierarchy=true&searchMode=string&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&startTime=string&webIdType=string
  • GETRetrieve event frames based on the specified conditions. By default, returns all children of the specified root resource that have been active in the past 8 hours./assetdatabases/:webId/eventframes?canBeAcknowledged=true&categoryName=string&endTime=string&isAcknowledged=true&maxCount=0&nameFilter=string&referencedElementNameFilter=string&referencedElementTemplateName=string&searchFullHierarchy=true&searchMode=string&selectedFields=string&severity=string&sortField=string&sortOrder=string&startIndex=0&startTime=string&templateName=string&webIdType=string
  • POSTCreate an event frame./assetdatabases/:webId/eventframes?webIdType=string
  • GETExport the asset database./assetdatabases/:webId/export?endTime=string&exportMode=string&startTime=string
  • POSTImport an asset database./assetdatabases/:webId/import?importMode=string
  • GETRetrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database./assetdatabases/:webId/referencedelements?associations=string&categoryName=string&descriptionFilter=string&elementType=string&maxCount=0&nameFilter=string&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&templateName=string&webIdType=stringUsers can search for the referenced elements based on specific search parameters. If no parameters are specified in the search, the default values for each…
  • POSTAdd a reference to an existing element to the specified database./assetdatabases/:webId/referencedelements?referencedElementWebId=string&referenceType=string
  • DELETERemove a reference to an existing element from the specified database./assetdatabases/:webId/referencedelements?referencedElementWebId=string
  • GETGet the security information of the specified security item associated with the asset database for a specified user./assetdatabases/:webId/security?securityItem=string&userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entries for this asset database are returned./assetdatabases/:webId/securityentries?nameFilter=string&securityItem=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the asset database./assetdatabases/:webId/securityentries?applyToChildren=true&securityItem=string&webIdType=string
  • GETRetrieve the security entry of the specified security item associated with the asset database with the specified name./assetdatabases/:webId/securityentries/:name?securityItem=string&selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the asset database./assetdatabases/:webId/securityentries/:name?applyToChildren=true&securityItem=string
  • DELETEDelete a security entry owned by the asset database./assetdatabases/:webId/securityentries/:name?applyToChildren=true&securityItem=string
  • GETRetrieve table categories for a given Asset Database./assetdatabases/:webId/tablecategories?selectedFields=string&webIdType=string
  • POSTCreate a table category on the Asset Database./assetdatabases/:webId/tablecategories?webIdType=string
  • GETRetrieve tables for given Asset Database./assetdatabases/:webId/tables?selectedFields=string&webIdType=string
  • POSTCreate a table on the Asset Database./assetdatabases/:webId/tables?webIdType=string

AssetServer

  • GETRetrieve a list of all Asset Servers known to this service./assetservers?selectedFields=string&webIdType=string
  • GETRetrieve an Asset Server by name./assetservers#name?name=string&selectedFields=string&webIdType=stringThis method returns an asset server based on the name associated with it. Users should primarily search with the WebID when available.
  • GETRetrieve an Asset Server by path./assetservers#path?path=string&selectedFields=string&webIdType=stringThis method returns an asset server based on the hierarchical path associated with it, and should be used when a path has been received from a separate part…
  • GETRetrieve an Asset Server./assetservers/:webId?selectedFields=string&webIdType=string
  • GETRetrieve a list of all Analysis Rule Plug-in's./assetservers/:webId/analysisruleplugins?selectedFields=string&webIdType=string
  • GETRetrieve a list of all Asset Databases on the specified Asset Server./assetservers/:webId/assetdatabases?selectedFields=string&webIdType=string
  • POSTCreate an asset database./assetservers/:webId/assetdatabases?webIdType=string
  • GETRetrieve a list of all notification contact templates on the specified Asset Server./assetservers/:webId/notificationcontacttemplates?selectedFields=string&webIdType=string
  • POSTCreate a notification contact template./assetservers/:webId/notificationcontacttemplates?webIdType=string
  • GETRetrieve a list of all notification plugins on the specified Asset Server./assetservers/:webId/notificationplugins?selectedFields=string&webIdType=string
  • GETGet the security information of the specified security item associated with the asset server for a specified user./assetservers/:webId/security?securityItem=string&userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries for this asset server are returned./assetservers/:webId/securityentries?nameFilter=string&securityItem=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the asset server./assetservers/:webId/securityentries?applyToChildren=true&securityItem=string&webIdType=string
  • GETRetrieve the security entry of the specified security item associated with the asset server with the specified name./assetservers/:webId/securityentries/:name?securityItem=string&selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the asset server./assetservers/:webId/securityentries/:name?applyToChildren=true&securityItem=string
  • DELETEDelete a security entry owned by the asset server./assetservers/:webId/securityentries/:name?applyToChildren=true&securityItem=string
  • GETRetrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned./assetservers/:webId/securityidentities?field=string&maxCount=0&query=string&selectedFields=string&sortField=string&sortOrder=string&webIdType=string
  • POSTCreate a security identity./assetservers/:webId/securityidentities?webIdType=string
  • GETRetrieve security identities for a specific user./assetservers/:webId/securityidentities#userIdentity?userIdentity=string&selectedFields=string&webIdType=string
  • GETRetrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned./assetservers/:webId/securitymappings?field=string&maxCount=0&query=string&selectedFields=string&sortField=string&sortOrder=string&webIdType=string
  • POSTCreate a security mapping./assetservers/:webId/securitymappings?webIdType=string
  • GETRetrieve a list of all Time Rule Plug-in's./assetservers/:webId/timeruleplugins?selectedFields=string&webIdType=string
  • GETRetrieve a list of all unit classes on the specified Asset Server./assetservers/:webId/unitclasses?selectedFields=string&webIdType=string
  • POSTCreate a unit class in the specified Asset Server./assetservers/:webId/unitclasses?webIdType=string

AttributeCategory

  • GETRetrieve an attribute category by path./attributecategories?path=string&selectedFields=string&webIdType=string
  • GETRetrieve an attribute category./attributecategories/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an attribute category./attributecategories/:webId
  • PATCHUpdate an attribute category by replacing items in its definition./attributecategories/:webId
  • GETGet the security information of the specified security item associated with the attribute category for a specified user./attributecategories/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the attribute category based on the specified criteria. By default, all security entries for this attribute category are returned./attributecategories/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the attribute category./attributecategories/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the attribute category with the specified name./attributecategories/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the attribute category./attributecategories/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the attribute category./attributecategories/:webId/securityentries/:name?applyToChildren=true

Attribute

  • GETRetrieve an attribute by path./attributes?path=string&associations=string&selectedFields=string&webIdType=stringThis method returns an attribute based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of…
  • GETRetrieve multiple attributes by web id or path./attributes/multiple?asParallel=true&associations=string&includeMode=string&path=string&selectedFields=string&webId=string&webIdType=string
  • GETRetrieve attributes based on the specified conditions. Returns attributes using the specified search query string./attributes/search?associations=string&databaseWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • GETRetrieve an attribute./attributes/:webId?associations=string&selectedFields=string&webIdType=string
  • DELETEDelete an attribute./attributes/:webId
  • PATCHUpdate an attribute by replacing items in its definition./attributes/:webIdIf an attribute is based on a template, the user must make sure to update the attribute appropriately so that it does not conflict with the template's design.…
  • GETGet the child attributes of the specified attribute./attributes/:webId/attributes?associations=string&categoryName=string&maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&showExcluded=true&showHidden=true&sortField=string&sortOrder=string&startIndex=0&templateName=string&trait=string&traitCategory=string&valueType=string&webIdType=string
  • POSTCreate a new attribute as a child of the specified attribute./attributes/:webId/attributes?webIdType=string
  • GETGet an attribute's categories./attributes/:webId/categories?selectedFields=string&webIdType=string
  • POSTCreate or update an attribute's DataReference configuration (Create/Update PI point for PI Point DataReference)./attributes/:webId/config?webIdType=string
  • GETGet the attribute's value. This call is intended for use with attributes that have no data reference only. For attributes with a data reference, consult the documentation for Streams./attributes/:webId/value?selectedFields=string
  • PUTSet the value of a configuration item attribute. For attributes with a data reference or non-configuration item attributes, consult the documentation for streams./attributes/:webId/valueUsers must be aware of the value type that the attribute takes before changing the value. If a value entered by the user does not match the value type…

AttributeTemplate

  • GETRetrieve an attribute template by path./attributetemplates?path=string&selectedFields=string&webIdType=stringThis method returns an attribute template based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • GETRetrieve an attribute template./attributetemplates/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an attribute template./attributetemplates/:webIdDeleting an attribute template will delete the attributes that were created based on the template
  • PATCHUpdate an existing attribute template by replacing items in its definition./attributetemplates/:webIdUpdating an attribute template will propagate changes to the attributes that were created based on the template
  • GETRetrieve an attribute template's child attribute templates./attributetemplates/:webId/attributetemplates?selectedFields=string&webIdType=string
  • POSTCreate an attribute template as a child of another attribute template./attributetemplates/:webId/attributetemplates?webIdType=string
  • GETGet an attribute template's categories./attributetemplates/:webId/categories?selectedFields=string&webIdType=string

AttributeTrait

  • GETRetrieve all attribute traits of the specified category/categories./attributetraits?category=string&selectedFields=string
  • GETRetrieve an attribute trait./attributetraits/:name?selectedFields=string

Batch

  • POSTExecute a batch of requests against the service. As shown in the Sample Request, the input is a dictionary with IDs as keys and request objects as values. Each request object specifies the HTTP method and the resource and, optionally, the content and a list of parent IDs. The list of parent IDs specifies which other requests must complete before the given request will be executed. The example first creates an element, then gets the element by the response's Location header, then creates an attribute for the element. Note that the resource can be an absolute URL or a JsonPath that references the response to the parent request. The batch's response is a dictionary uses keys corresponding those provided in the request, with response objects containing a status code, response headers, and the response body. A request can alternatively specify a request template in place of a resource. In this case, a single JsonPath may select multiple tokens, and a separate subrequest will be made from the template for each token. The responses of these subrequests will returned as the content of a single outer response./batch

Calculation

  • GETReturns results of evaluating the expression over the time range from the start time to the end time at a defined interval./calculation/intervals?expression=string&endTime=string&sampleInterval=string&selectedFields=string&startTime=string&webId=string
  • GETReturns the result of evaluating the expression at each point in time over the time range from the start time to the end time where a recorded value exists for a member of the expression./calculation/recorded?expression=string&endTime=string&selectedFields=string&startTime=string&webId=string
  • GETReturns the result of evaluating the expression over the time range from the start time to the end time. The time range is first divided into a number of summary intervals. Then the calculation is performed for the specified summaries over each interval./calculation/summary?expression=string&calculationBasis=string&endTime=string&sampleInterval=string&sampleType=string&selectedFields=string&startTime=string&summaryDuration=string&summaryType=string&timeType=string&webId=string
  • GETReturns the result of evaluating the expression at the specified timestamps./calculation/times?expression=string&time=string&selectedFields=string&sortOrder=string&webId=string

Channel

  • GETRetrieves a list of currently running channel instances./channels/instances

DataServer

  • GETRetrieve a list of Data Servers known to this service./dataservers?selectedFields=string&webIdType=stringThis method returns a list of all available known Data Servers that the user can connect to. Even though a server may be returned in the list, the user may…
  • GETRetrieve a Data Server by name./dataservers#name?name=string&selectedFields=string&webIdType=stringThis method returns a data server based on the name. Users should primarily search with the WebID when available.
  • GETRetrieve a Data Server by path./dataservers#path?path=string&selectedFields=string&webIdType=stringThis method returns a data server based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of…
  • GETRetrieve a Data Server./dataservers/:webId?selectedFields=string&webIdType=string
  • GETRetrieve enumeration sets for given Data Server./dataservers/:webId/enumerationsets?selectedFields=string&webIdType=string
  • POSTCreate an enumeration set on the Data Server./dataservers/:webId/enumerationsets?webIdType=string
  • GETRetrieves the specified license for the given Data Server. The fields of the response object are string representations of the numerical values reported by the Data Server, with "Infinity" representing a license field with no limit./dataservers/:webId/license?module=string&selectedFields=string&webIdType=string
  • GETRetrieve a list of points on a specified Data Server./dataservers/:webId/points?maxCount=0&nameFilter=string&selectedFields=string&startIndex=0&webIdType=stringUsers can search for the data servers based on specific search parameters. If no parameters are specified in the search, the default values for each parameter…
  • POSTCreate a point in the specified Data Server./dataservers/:webId/points?webIdType=string

ElementCategory

  • GETRetrieve an element category by path./elementcategories?path=string&selectedFields=string&webIdType=string
  • GETRetrieve an element category./elementcategories/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an element category./elementcategories/:webId
  • PATCHUpdate an element category by replacing items in its definition./elementcategories/:webId
  • GETGet the security information of the specified security item associated with the element category for a specified user./elementcategories/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the element category based on the specified criteria. By default, all security entries for this element category are returned./elementcategories/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the element category./elementcategories/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the element category with the specified name./elementcategories/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the element category./elementcategories/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the element category./elementcategories/:webId/securityentries/:name?applyToChildren=true

Element

  • GETRetrieve an element by path./elements?path=string&associations=string&selectedFields=string&webIdType=stringThis method returns an element based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the…
  • GETRetrieve multiple elements by web id or path./elements/multiple?asParallel=true&associations=string&includeMode=string&path=string&selectedFields=string&webId=string&webIdType=string
  • GETRetrieve elements based on the specified conditions. By default, returns all the elements./elements/search?associations=string&databaseWebId=string&maxCount=0&query=string&queryDate=string&selectedFields=string&startIndex=0&webIdType=string
  • POSTCreate a link for a "Search Elements By Attribute Value" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root Element. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the Elements. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators./elements/searchbyattribute?associations=string&noResults=true&webIdType=string
  • GETExecute a "Search Elements By Attribute Value" operation./elements/searchbyattribute/:searchId?associations=string&categoryName=string&descriptionFilter=string&maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&webIdType=string
  • GETRetrieve an element./elements/:webId?associations=string&selectedFields=string&webIdType=string
  • DELETEDelete an element./elements/:webId
  • PATCHUpdate an element by replacing items in its definition./elements/:webId
  • GETRetrieve analyses based on the specified conditions./elements/:webId/analyses?maxCount=0&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&webIdType=stringUsers can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter…
  • POSTCreate an Analysis./elements/:webId/analyses?webIdType=string
  • GETGet the attributes of the specified element./elements/:webId/attributes?associations=string&categoryName=string&maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&showExcluded=true&showHidden=true&sortField=string&sortOrder=string&startIndex=0&templateName=string&trait=string&traitCategory=string&valueType=string&webIdType=string
  • POSTCreate a new attribute of the specified element./elements/:webId/attributes?webIdType=string
  • GETGet an element's categories./elements/:webId/categories?selectedFields=string&webIdType=string
  • POSTExecutes the create configuration function of the data references found within the attributes of the element, and optionally, its children./elements/:webId/config?includeChildElements=true
  • GETRetrieves a list of element attributes matching the specified filters from the specified element./elements/:webId/elementattributes?associations=string&attributeCategory=string&attributeDescriptionFilter=string&attributeNameFilter=string&attributeType=string&elementCategory=string&elementDescriptionFilter=string&elementNameFilter=string&elementTemplate=string&elementType=string&maxCount=0&searchFullHierarchy=true&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&webIdType=string
  • GETRetrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element./elements/:webId/elements?associations=string&categoryName=string&descriptionFilter=string&elementType=string&maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&templateName=string&webIdType=stringUsers can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter…
  • POSTCreate a child element./elements/:webId/elements?webIdType=string
  • GETRetrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element that have been active in the past 8 hours./elements/:webId/eventframes?canBeAcknowledged=true&categoryName=string&endTime=string&isAcknowledged=true&maxCount=0&nameFilter=string&searchMode=string&selectedFields=string&severity=string&sortField=string&sortOrder=string&startIndex=0&startTime=string&templateName=string&webIdType=string
  • GETRetrieve notification rules for an element/elements/:webId/notificationrules?selectedFields=string&webIdType=string
  • POSTCreate a notification rule./elements/:webId/notificationrules?webIdType=string
  • GETGet a list of the full or relative paths to this element./elements/:webId/paths?relativePath=stringThis method will return paths with the primary path at the first index. If there is no primary path, then null will be at the first index. If relative path is…
  • GETRetrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements of the current resource./elements/:webId/referencedelements?associations=string&categoryName=string&descriptionFilter=string&elementType=string&maxCount=0&nameFilter=string&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&templateName=string&webIdType=stringUsers can search for the referenced elements based on specific search parameters. If no parameters are specified in the search, the default values for each…
  • POSTAdd a reference to an existing element to the child elements collection./elements/:webId/referencedelements?referencedElementWebId=string&referenceType=string
  • DELETERemove a reference to an existing element from the child elements collection./elements/:webId/referencedelements?referencedElementWebId=string
  • GETGet the security information of the specified security item associated with the element for a specified user./elements/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned./elements/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the element./elements/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the element with the specified name./elements/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the element./elements/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the element./elements/:webId/securityentries/:name?applyToChildren=true

ElementTemplate

  • GETRetrieve an element template by path./elementtemplates?path=string&selectedFields=string&webIdType=stringThis method returns an element template based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • GETRetrieve an element template./elementtemplates/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an element template./elementtemplates/:webIdDeleting an element template will delete all associated templated data from elements which were created from it.
  • PATCHUpdate an element template by replacing items in its definition./elementtemplates/:webIdUpdating the InstanceType property of an element template will not affect any elements that have already been created from this template; it will only affect…
  • GETGet analysis templates for an element template./elementtemplates/:webId/analysistemplates?selectedFields=string&webIdType=string
  • GETGet child attribute templates for an element template./elementtemplates/:webId/attributetemplates?depthFirstTraverse=true&maxCount=0&selectedFields=string&showDescendants=true&showInherited=true&startIndex=0&webIdType=stringIf 'showInherited' and 'showDescendants' are 'true', it returns all the attribute templates from current element template and the base template. If…
  • POSTCreate an attribute template./elementtemplates/:webId/attributetemplates?webIdType=string
  • GETGet base element templates for an element template./elementtemplates/:webId/baseelementtemplates?maxCount=0&selectedFields=string&webIdType=stringThe root template will be returned first, followed by successive templates in the inheritance chain.
  • GETGet an element template's categories./elementtemplates/:webId/categories?selectedFields=string&showInherited=true&webIdType=string
  • GETGet derived element templates for an element template./elementtemplates/:webId/derivedelementtemplates?maxCount=0&selectedFields=string&showDescendants=true&webIdType=string
  • GETGet notification rule templates for an element template/elementtemplates/:webId/notificationruletemplates?selectedFields=string&webIdType=string
  • POSTCreate a notification rule template./elementtemplates/:webId/notificationruletemplates?webIdType=string
  • GETGet the security information of the specified security item associated with the element template for a specified user./elementtemplates/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the element template based on the specified criteria. By default, all security entries for this element template are returned./elementtemplates/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the element template./elementtemplates/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the element template with the specified name./elementtemplates/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the element template./elementtemplates/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the element template./elementtemplates/:webId/securityentries/:name?applyToChildren=true

EnumerationSet

  • GETRetrieve an enumeration set by path./enumerationsets?path=string&selectedFields=string&webIdType=stringThis method returns an enumeration set based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • GETRetrieve an enumeration set./enumerationsets/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an enumeration set./enumerationsets/:webId
  • PATCHUpdate an enumeration set by replacing items in its definition./enumerationsets/:webId
  • GETRetrieve an enumeration set's values./enumerationsets/:webId/enumerationvalues?selectedFields=string&webIdType=string
  • POSTCreate an enumeration value for a enumeration set./enumerationsets/:webId/enumerationvalues?webIdType=string
  • GETGet the security information of the specified security item associated with the enumeration set for a specified user./enumerationsets/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the enumeration set based on the specified criteria. By default, all security entries for this enumeration set are returned./enumerationsets/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the enumeration set./enumerationsets/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the enumeration set with the specified name./enumerationsets/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the enumeration set./enumerationsets/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the enumeration set./enumerationsets/:webId/securityentries/:name?applyToChildren=true

EnumerationValue

  • GETRetrieve an enumeration value by path./enumerationvalues?path=string&selectedFields=string&webIdType=stringThis method returns a enumeration value based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • GETRetrieve an enumeration value mapping/enumerationvalues/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an enumeration value from an enumeration set./enumerationvalues/:webIdDeleting a value will remove it from the enumeration set along with any value references within the PI Web API system.
  • PATCHUpdate an enumeration value by replacing items in its definition./enumerationvalues/:webId

EventFrame

  • GETRetrieve an event frame by path./eventframes?path=string&selectedFields=string&webIdType=stringThis method returns an event frame based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of…
  • GETRetrieve multiple event frames by web ids or paths./eventframes/multiple?asParallel=true&includeMode=string&path=string&selectedFields=string&webId=string&webIdType=string
  • GETRetrieve event frames based on the specified conditions. Returns event frames using the specified search query string./eventframes/search?databaseWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • POSTCreate a link for a "Search EventFrames By Attribute Value" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root EventFrame. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the EventFrames. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators./eventframes/searchbyattribute?noResults=true&selectedFields=string&webIdType=string
  • GETExecute a "Search EventFrames By Attribute Value" operation./eventframes/searchbyattribute/:searchId?canBeAcknowledged=true&endTime=string&isAcknowledged=true&maxCount=0&nameFilter=string&referencedElementNameFilter=string&searchFullHierarchy=true&searchMode=string&selectedFields=string&severity=string&sortField=string&sortOrder=string&startIndex=0&startTime=string&webIdType=string
  • GETRetrieve an event frame./eventframes/:webId?selectedFields=string&webIdType=string
  • DELETEDelete an event frame./eventframes/:webId
  • PATCHUpdate an event frame by replacing items in its definition./eventframes/:webId
  • PATCHCalls the EventFrame's Acknowledge method./eventframes/:webId/acknowledge
  • GETGet an event frame's annotations./eventframes/:webId/annotations?selectedFields=string&webIdType=string
  • POSTCreate an annotation on an event frame./eventframes/:webId/annotations?webIdType=string
  • GETGet a specific annotation on an event frame./eventframes/:webId/annotations/:id?selectedFields=string&webIdType=string
  • DELETEDelete an annotation on an event frame. If the annotation has attached media, the attached media will also be deleted./eventframes/:webId/annotations/:id
  • PATCHUpdate an annotation on an event frame by replacing items in its definition./eventframes/:webId/annotations/:id
  • DELETEDelete attached media from an annotation on an event frame./eventframes/:webId/annotations/:id/attachment/media
  • GETGets the metadata of the media attached to the specified annotation./eventframes/:webId/annotations/:id/attachment/media/metadata?selectedFields=string&webIdType=string
  • GETGet the attributes of the specified event frame./eventframes/:webId/attributes?associations=string&categoryName=string&maxCount=0&nameFilter=string&searchFullHierarchy=true&selectedFields=string&showExcluded=true&showHidden=true&sortField=string&sortOrder=string&startIndex=0&templateName=string&trait=string&traitCategory=string&valueType=string&webIdType=string
  • POSTCreate a new attribute of the specified event frame./eventframes/:webId/attributes?webIdType=string
  • POSTCalls the EventFrame's CaptureValues method./eventframes/:webId/attributes/capture
  • GETGet an event frame's categories./eventframes/:webId/categories?selectedFields=string&webIdType=string
  • POSTExecutes the create configuration function of the data references found within the attributes of the event frame, and optionally, its children./eventframes/:webId/config?includeChildElements=true
  • GETRetrieves a list of event frame attributes matching the specified filters from the specified event frame./eventframes/:webId/eventframeattributes?associations=string&attributeCategory=string&attributeDescriptionFilter=string&attributeNameFilter=string&attributeType=string&endTime=string&eventFrameCategory=string&eventFrameDescriptionFilter=string&eventFrameNameFilter=string&eventFrameTemplate=string&maxCount=0&referencedElementNameFilter=string&searchFullHierarchy=true&searchMode=string&selectedFields=string&sortField=string&sortOrder=string&startIndex=0&startTime=string&webIdType=string
  • GETRetrieve event frames based on the specified conditions. By default, returns all children of the specified root event frame that have been active in the past 8 hours./eventframes/:webId/eventframes?canBeAcknowledged=true&categoryName=string&endTime=string&isAcknowledged=true&maxCount=0&nameFilter=string&referencedElementNameFilter=string&referencedElementTemplateName=string&searchFullHierarchy=true&searchMode=string&selectedFields=string&severity=string&sortField=string&sortOrder=string&startIndex=0&startTime=string&templateName=string&webIdType=string
  • POSTCreate an event frame as a child of the specified event frame./eventframes/:webId/eventframes?webIdType=string
  • GETRetrieve the event frame's referenced elements./eventframes/:webId/referencedelements?associations=string&selectedFields=string&webIdType=string
  • GETGet the security information of the specified security item associated with the event frame for a specified user./eventframes/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the event frame based on the specified criteria. By default, all security entries for this event frame are returned./eventframes/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the event frame./eventframes/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the event frame with the specified name./eventframes/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the event frame./eventframes/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the event frame./eventframes/:webId/securityentries/:name?applyToChildren=true

NotificationContactTemplate

  • GETRetrieve a notification contact template by path./notificationcontacttemplates?path=string&selectedFields=string&webIdType=string
  • GETRetrieve notification contact templates based on the specified conditions. Returns notification contact templates using the specified search query string./notificationcontacttemplates/search?assetServerWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • GETRetrieve a notification contact template./notificationcontacttemplates/:webId?selectedFields=string&webIdType=string
  • DELETEDelete a notification contact template./notificationcontacttemplates/:webId
  • PATCHUpdate a notification contact template by replacing items in its definition./notificationcontacttemplates/:webId
  • GETRetrieve notification contact template's child templates./notificationcontacttemplates/:webId/notificationcontacttemplates?selectedFields=string&webIdType=string
  • GETGet the security information of the specified security item associated with the notification contact template for a specified user./notificationcontacttemplates/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the notification contact template based on the specified criteria. By default, all security entries for this notification contact template are returned./notificationcontacttemplates/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the notification contact template./notificationcontacttemplates/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the notification contact template with the specified name./notificationcontacttemplates/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the notification contact template./notificationcontacttemplates/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the notification contact template./notificationcontacttemplates/:webId/securityentries/:name?applyToChildren=true

NotificationPlugIn

  • GETRetrieve a notification plugin by path./notificationplugIns?path=string&selectedFields=string&webIdType=stringThis method returns a notification plugin based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • GETRetrieve a notification plugin./notificationplugins/:webId?selectedFields=string&webIdType=string

NotificationRule

  • GETRetrieve a notification rule by path./notificationrules?path=string&selectedFields=string&webIdType=stringThis method returns a Notification Rule based on the hierarchical path associated with it, and should be used when a path has been received from a separate…
  • GETRetrieve notification rules based on the specified conditions. Returns notification rules using the specified search query string./notificationrules/search?databaseWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • GETRetrieve a notification rule./notificationrules/:webId?selectedFields=string&webIdType=string
  • DELETEDelete a notification rule./notificationrules/:webId
  • PATCHUpdate a notification rule by replacing items in its definition./notificationrules/:webId
  • GETRetrieve notification rule subscribers./notificationrules/:webId/notificationrulesubscribers?selectedFields=string&webIdType=string
  • POSTCreate a notification rule subscriber./notificationrules/:webId/notificationrulesubscribers?webIdType=string
  • GETGet the security information of the specified security item associated with the notification rule for a specified user./notificationrules/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the notification rule based on the specified criteria. By default, all security entries for this notification rule are returned./notificationrules/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the notification rule./notificationrules/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the notification rule with the specified name./notificationrules/:webId/securityentries/:name?selectedFields=string&webIdType=string
  • PUTUpdate a security entry owned by the notification rule./notificationrules/:webId/securityentries/:name?applyToChildren=true
  • DELETEDelete a security entry owned by the notification rule./notificationrules/:webId/securityentries/:name?applyToChildren=true

NotificationRuleSubscriber

  • GETRetrieve a notification rule subscriber by path./notificationrulesubscribers?path=string&selectedFields=string&webIdType=stringThis method returns a Notification Rule Subscriber based on the hierarchical path associated with it, and should be used when a path has been received from a…
  • GETRetrieve a notification rule subscriber./notificationrulesubscribers/:webId?selectedFields=string&webIdType=string
  • DELETEDelete a notification rule subscriber./notificationrulesubscribers/:webId
  • PATCHUpdate a notification rule subscriber./notificationrulesubscribers/:webId
  • GETRetrieve notification rule subscriber subscribers./notificationrulesubscribers/:webId/notificationrulesubscribers?selectedFields=string&webIdType=string

NotificationRuleTemplate

  • GETRetrieve a notification rule template by path./notificationruletemplates?path=string&selectedFields=string&webIdType=stringThis method returns a Notification Rule Template based on the hierarchical path associated with it, and should be used when a path has been received from a…
  • GETRetrieve Notification rule templates based on the specified conditions. Returns Notification rule templates using the specified search query string./notificationruletemplates/search?databaseWebId=string&maxCount=0&query=string&selectedFields=string&startIndex=0&webIdType=string
  • GETGet the specified notification rule template./notificationruletemplates/:webId?selectedFields=string&webIdType=string
  • DELETEDelete a notification rule template./notificationruletemplates/:webId
  • PATCHUpdate a notification rule template by replacing items in its definition./notificationruletemplates/:webId
  • GETRetrieve notification rule template subscribers./notificationruletemplates/:webId/notificationrulesubscribers?selectedFields=string&webIdType=string
  • POSTCreate a notification rule subscriber./notificationruletemplates/:webId/notificationrulesubscribers?webIdType=string
  • GETGet the security information of the specified security item associated with the notification rule template for a specified user./notificationruletemplates/:webId/security?userIdentity=string&forceRefresh=true&selectedFields=string&webIdType=string
  • GETRetrieve the security entries associated with the notification rule template based on the specified criteria. By default, all security entries for this notification rule template are returned./notificationruletemplates/:webId/securityentries?nameFilter=string&selectedFields=string&webIdType=string
  • POSTCreate a security entry owned by the notification rule template./notificationruletemplates/:webId/securityentries?applyToChildren=true&webIdType=string
  • GETRetrieve the security entry associated with the notification rule template with the specified name./notificationruletemplates/:webId/securityentries/:name?selectedFields=string&webIdType=string

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://devdata.osisoft.com/piwebapi
Authentication
None declared in the description
Operations
413 operations on 263 pathsGET 252POST 68DELETE 47PATCH 28PUT 18
Main resources
AssetDatabase 38EventFrame 31Element 30StreamSet 27AssetServer 24ElementTemplate 18Stream 14AnalysisTemplate 13NotificationRule 13NotificationRuleTemplate 13
Description format
Swagger 2.0, API version 1.11.1.5383
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the PI Web API 2018 SP1 Swagger Spec in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the PI Web API 2018 SP1 Swagger Spec collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get top level links for this PI System Web API instance.” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PI Web API 2018 SP1 Swagger Spec?

Swagger Spec file that describes PI Web API It is listed under Other and has 413 endpoints.

Who publishes the PI Web API 2018 SP1 Swagger Spec?

It is listed from Osisoft's public API description (an OpenAPI document), not published by Osisoft on Swastik Codes. Anyone who controls osisoft.com can claim the profile by adding a DNS TXT record.

What is the base URL of the PI Web API 2018 SP1 Swagger Spec?

Requests go to https://devdata.osisoft.com/piwebapi. Endpoint paths are added to this base URL.

How do I authenticate with the PI Web API 2018 SP1 Swagger Spec?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the PI Web API 2018 SP1 Swagger Spec have?

413 operations on 263 paths (252 GET, 68 POST, 47 DELETE, 28 PATCH, 18 PUT). The largest groups are AssetDatabase, EventFrame, Element, StreamSet. This listing's collection holds the first 400.

Is forking the PI Web API 2018 SP1 Swagger Spec free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.