| HomeApi |
Get |
GET / |
Get top level links for this PI System Web API instance. |
| AnalysisApi |
GetByPath |
GET /analyses |
Retrieve an Analysis by path. |
| AnalysisApi |
Get |
GET /analyses/{webId} |
Retrieve an Analysis. |
| AnalysisApi |
Update |
PATCH /analyses/{webId} |
Update an Analysis. |
| AnalysisApi |
Delete |
DELETE /analyses/{webId} |
Delete an Analysis. |
| AnalysisApi |
GetCategories |
GET /analyses/{webId}/categories |
Get an Analysis' categories. |
| AnalysisApi |
GetSecurity |
GET /analyses/{webId}/security |
Get the security information of the specified security item associated with the Analysis for a specified user. |
| AnalysisApi |
GetSecurityEntries |
GET /analyses/{webId}/securityentries |
Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned. |
| AnalysisApi |
CreateSecurityEntry |
POST /analyses/{webId}/securityentries |
Create a security entry owned by the analysis. |
| AnalysisApi |
GetSecurityEntryByName |
GET /analyses/{webId}/securityentries/{name} |
Retrieve the security entry associated with the analysis with the specified name. |
| AnalysisApi |
UpdateSecurityEntry |
PUT /analyses/{webId}/securityentries/{name} |
Update a security entry owned by the analysis. |
| AnalysisApi |
DeleteSecurityEntry |
DELETE /analyses/{webId}/securityentries/{name} |
Delete a security entry owned by the analysis. |
| AnalysisCategoryApi |
GetByPath |
GET /analysiscategories |
Retrieve an analysis category by path. |
| AnalysisCategoryApi |
Get |
GET /analysiscategories/{webId} |
Retrieve an analysis category. |
| AnalysisCategoryApi |
Update |
PATCH /analysiscategories/{webId} |
Update an analysis category by replacing items in its definition. |
| AnalysisCategoryApi |
Delete |
DELETE /analysiscategories/{webId} |
Delete an analysis category. |
| AnalysisCategoryApi |
GetSecurity |
GET /analysiscategories/{webId}/security |
Get the security information of the specified security item associated with the analysis category for a specified user. |
| AnalysisCategoryApi |
GetSecurityEntries |
GET /analysiscategories/{webId}/securityentries |
Retrieve the security entries associated with the analysis category based on the specified criteria. By default, all security entries for this analysis category are returned. |
| AnalysisCategoryApi |
CreateSecurityEntry |
POST /analysiscategories/{webId}/securityentries |
Create a security entry owned by the analysis category. |
| AnalysisCategoryApi |
GetSecurityEntryByName |
GET /analysiscategories/{webId}/securityentries/{name} |
Retrieve the security entry associated with the analysis category with the specified name. |
| AnalysisCategoryApi |
UpdateSecurityEntry |
PUT /analysiscategories/{webId}/securityentries/{name} |
Update a security entry owned by the analysis category. |
| AnalysisCategoryApi |
DeleteSecurityEntry |
DELETE /analysiscategories/{webId}/securityentries/{name} |
Delete a security entry owned by the analysis category. |
| AnalysisRulePlugInApi |
GetByPath |
GET /analysisruleplugins |
Retrieve an Analysis Rule Plug-in by path. |
| AnalysisRulePlugInApi |
Get |
GET /analysisruleplugins/{webId} |
Retrieve an Analysis Rule Plug-in. |
| AnalysisRuleApi |
GetByPath |
GET /analysisrules |
Retrieve an Analysis Rule by path. |
| AnalysisRuleApi |
Get |
GET /analysisrules/{webId} |
Retrieve an Analysis Rule. |
| AnalysisRuleApi |
Update |
PATCH /analysisrules/{webId} |
Update an Analysis Rule by replacing items in its definition. |
| AnalysisRuleApi |
Delete |
DELETE /analysisrules/{webId} |
Delete an Analysis Rule. |
| AnalysisRuleApi |
GetAnalysisRules |
GET /analysisrules/{webId}/analysisrules |
Get the child Analysis Rules of the Analysis Rule. |
| AnalysisRuleApi |
CreateAnalysisRule |
POST /analysisrules/{webId}/analysisrules |
Create a new Analysis Rule as a child of an existing Analysis Rule. |
| AnalysisTemplateApi |
GetByPath |
GET /analysistemplates |
Retrieve an analysis template by path. |
| AnalysisTemplateApi |
CreateFromAnalysis |
POST /analysistemplates |
Create an Analysis template based upon a specified Analysis. |
| AnalysisTemplateApi |
Get |
GET /analysistemplates/{webId} |
Retrieve an analysis template. |
| AnalysisTemplateApi |
Update |
PATCH /analysistemplates/{webId} |
Update an analysis template by replacing items in its definition. |
| AnalysisTemplateApi |
Delete |
DELETE /analysistemplates/{webId} |
Delete an analysis template. |
| AnalysisTemplateApi |
GetCategories |
GET /analysistemplates/{webId}/categories |
Get an analysis template's categories. |
| AnalysisTemplateApi |
GetSecurity |
GET /analysistemplates/{webId}/security |
Get the security information of the specified security item associated with the analysis template for a specified user. |
| AnalysisTemplateApi |
GetSecurityEntries |
GET /analysistemplates/{webId}/securityentries |
Retrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template are returned. |
| AnalysisTemplateApi |
CreateSecurityEntry |
POST /analysistemplates/{webId}/securityentries |
Create a security entry owned by the analysis template. |
| AnalysisTemplateApi |
GetSecurityEntryByName |
GET /analysistemplates/{webId}/securityentries/{name} |
Retrieve the security entry associated with the analysis template with the specified name. |
| AnalysisTemplateApi |
UpdateSecurityEntry |
PUT /analysistemplates/{webId}/securityentries/{name} |
Update a security entry owned by the analysis template. |
| AnalysisTemplateApi |
DeleteSecurityEntry |
DELETE /analysistemplates/{webId}/securityentries/{name} |
Delete a security entry owned by the analysis template. |
| AssetDatabaseApi |
GetByPath |
GET /assetdatabases |
Retrieve an Asset Database by path. |
| AssetDatabaseApi |
Get |
GET /assetdatabases/{webId} |
Retrieve an Asset Database. |
| AssetDatabaseApi |
Update |
PATCH /assetdatabases/{webId} |
Update an asset database by replacing items in its definition. |
| AssetDatabaseApi |
Delete |
DELETE /assetdatabases/{webId} |
Delete an asset database. |
| AssetDatabaseApi |
FindAnalyses |
GET /assetdatabases/{webId}/analyses |
Retrieve analyses based on the specified conditions. |
| AssetDatabaseApi |
GetAnalysisCategories |
GET /assetdatabases/{webId}/analysiscategories |
Retrieve analysis categories for a given Asset Database. |
| AssetDatabaseApi |
CreateAnalysisCategory |
POST /assetdatabases/{webId}/analysiscategories |
Create an analysis category at the Asset Database root. |
| AssetDatabaseApi |
GetAnalysisTemplates |
GET /assetdatabases/{webId}/analysistemplates |
Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned. |
| AssetDatabaseApi |
CreateAnalysisTemplate |
POST /assetdatabases/{webId}/analysistemplates |
Create an analysis template at the Asset Database root. |
| AssetDatabaseApi |
GetAttributeCategories |
GET /assetdatabases/{webId}/attributecategories |
Retrieve attribute categories for a given Asset Database. |
| AssetDatabaseApi |
CreateAttributeCategory |
POST /assetdatabases/{webId}/attributecategories |
Create an attribute category at the Asset Database root. |
| AssetDatabaseApi |
FindElementAttributes |
GET /assetdatabases/{webId}/elementattributes |
Retrieves a list of element attributes matching the specified filters from the specified asset database. |
| AssetDatabaseApi |
GetElementCategories |
GET /assetdatabases/{webId}/elementcategories |
Retrieve element categories for a given Asset Database. |
| AssetDatabaseApi |
CreateElementCategory |
POST /assetdatabases/{webId}/elementcategories |
Create an element category at the Asset Database root. |
| AssetDatabaseApi |
GetElements |
GET /assetdatabases/{webId}/elements |
Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database. |
| AssetDatabaseApi |
CreateElement |
POST /assetdatabases/{webId}/elements |
Create a child element. |
| AssetDatabaseApi |
GetElementTemplates |
GET /assetdatabases/{webId}/elementtemplates |
Retrieve 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. |
| AssetDatabaseApi |
CreateElementTemplate |
POST /assetdatabases/{webId}/elementtemplates |
Create 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. |
| AssetDatabaseApi |
GetEnumerationSets |
GET /assetdatabases/{webId}/enumerationsets |
Retrieve enumeration sets for given asset database. |
| AssetDatabaseApi |
CreateEnumerationSet |
POST /assetdatabases/{webId}/enumerationsets |
Create an enumeration set at the Asset Database. |
| AssetDatabaseApi |
FindEventFrameAttributes |
GET /assetdatabases/{webId}/eventframeattributes |
Retrieves a list of event frame attributes matching the specified filters from the specified asset database. |
| AssetDatabaseApi |
GetEventFrames |
GET /assetdatabases/{webId}/eventframes |
Retrieve event frames based on the specified conditions. By default, returns all children of the specified root resource with a start time in the past 8 hours. |
| AssetDatabaseApi |
CreateEventFrame |
POST /assetdatabases/{webId}/eventframes |
Create an event frame. |
| AssetDatabaseApi |
Export |
GET /assetdatabases/{webId}/export |
Export the asset database. |
| AssetDatabaseApi |
Import |
POST /assetdatabases/{webId}/import |
Import an asset database. |
| AssetDatabaseApi |
GetReferencedElements |
GET /assetdatabases/{webId}/referencedelements |
Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database. |
| AssetDatabaseApi |
AddReferencedElement |
POST /assetdatabases/{webId}/referencedelements |
Add a reference to an existing element to the specified database. |
| AssetDatabaseApi |
RemoveReferencedElement |
DELETE /assetdatabases/{webId}/referencedelements |
Remove a reference to an existing element from the specified database. |
| AssetDatabaseApi |
GetSecurity |
GET /assetdatabases/{webId}/security |
Get the security information of the specified security item associated with the asset database for a specified user. |
| AssetDatabaseApi |
GetSecurityEntries |
GET /assetdatabases/{webId}/securityentries |
Retrieve 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. |
| AssetDatabaseApi |
CreateSecurityEntry |
POST /assetdatabases/{webId}/securityentries |
Create a security entry owned by the asset database. |
| AssetDatabaseApi |
GetSecurityEntryByName |
GET /assetdatabases/{webId}/securityentries/{name} |
Retrieve the security entry of the specified security item associated with the asset database with the specified name. |
| AssetDatabaseApi |
UpdateSecurityEntry |
PUT /assetdatabases/{webId}/securityentries/{name} |
Update a security entry owned by the asset database. |
| AssetDatabaseApi |
DeleteSecurityEntry |
DELETE /assetdatabases/{webId}/securityentries/{name} |
Delete a security entry owned by the asset database. |
| AssetDatabaseApi |
GetTableCategories |
GET /assetdatabases/{webId}/tablecategories |
Retrieve table categories for a given Asset Database. |
| AssetDatabaseApi |
CreateTableCategory |
POST /assetdatabases/{webId}/tablecategories |
Create a table category on the Asset Database. |
| AssetDatabaseApi |
GetTables |
GET /assetdatabases/{webId}/tables |
Retrieve tables for given Asset Database. |
| AssetDatabaseApi |
CreateTable |
POST /assetdatabases/{webId}/tables |
Create a table on the Asset Database. |
| AssetServerApi |
List |
GET /assetservers |
Retrieve a list of all Asset Servers known to this service. |
| AssetServerApi |
GetByName |
GET /assetservers#name |
Retrieve an Asset Server by name. |
| AssetServerApi |
GetByPath |
GET /assetservers#path |
Retrieve an Asset Server by path. |
| AssetServerApi |
Get |
GET /assetservers/{webId} |
Retrieve an Asset Server. |
| AssetServerApi |
GetAnalysisRulePlugIns |
GET /assetservers/{webId}/analysisruleplugins |
Retrieve a list of all Analysis Rule Plug-in's. |
| AssetServerApi |
GetDatabases |
GET /assetservers/{webId}/assetdatabases |
Retrieve a list of all Asset Databases on the specified Asset Server. |
| AssetServerApi |
CreateAssetDatabase |
POST /assetservers/{webId}/assetdatabases |
Create an asset database. |
| AssetServerApi |
GetSecurity |
GET /assetservers/{webId}/security |
Get the security information of the specified security item associated with the asset server for a specified user. |
| AssetServerApi |
GetSecurityEntries |
GET /assetservers/{webId}/securityentries |
Retrieve 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. |
| AssetServerApi |
CreateSecurityEntry |
POST /assetservers/{webId}/securityentries |
Create a security entry owned by the asset server. |
| AssetServerApi |
GetSecurityEntryByName |
GET /assetservers/{webId}/securityentries/{name} |
Retrieve the security entry of the specified security item associated with the asset server with the specified name. |
| AssetServerApi |
UpdateSecurityEntry |
PUT /assetservers/{webId}/securityentries/{name} |
Update a security entry owned by the asset server. |
| AssetServerApi |
DeleteSecurityEntry |
DELETE /assetservers/{webId}/securityentries/{name} |
Delete a security entry owned by the asset server. |
| AssetServerApi |
GetSecurityIdentities |
GET /assetservers/{webId}/securityidentities |
Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned. |
| AssetServerApi |
CreateSecurityIdentity |
POST /assetservers/{webId}/securityidentities |
Create a security identity. |
| AssetServerApi |
GetSecurityIdentitiesForUser |
GET /assetservers/{webId}/securityidentities#userIdentity |
Retrieve security identities for a specific user. |
| AssetServerApi |
GetSecurityMappings |
GET /assetservers/{webId}/securitymappings |
Retrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned. |
| AssetServerApi |
CreateSecurityMapping |
POST /assetservers/{webId}/securitymappings |
Create a security mapping. |
| AssetServerApi |
GetTimeRulePlugIns |
GET /assetservers/{webId}/timeruleplugins |
Retrieve a list of all Time Rule Plug-in's. |
| AssetServerApi |
GetUnitClasses |
GET /assetservers/{webId}/unitclasses |
Retrieve a list of all unit classes on the specified Asset Server. |
| AssetServerApi |
CreateUnitClass |
POST /assetservers/{webId}/unitclasses |
Create a unit class in the specified Asset Server. |
| AttributeCategoryApi |
GetByPath |
GET /attributecategories |
Retrieve an attribute category by path. |
| AttributeCategoryApi |
Get |
GET /attributecategories/{webId} |
Retrieve an attribute category. |
| AttributeCategoryApi |
Update |
PATCH /attributecategories/{webId} |
Update an attribute category by replacing items in its definition. |
| AttributeCategoryApi |
Delete |
DELETE /attributecategories/{webId} |
Delete an attribute category. |
| AttributeCategoryApi |
GetSecurity |
GET /attributecategories/{webId}/security |
Get the security information of the specified security item associated with the attribute category for a specified user. |
| AttributeCategoryApi |
GetSecurityEntries |
GET /attributecategories/{webId}/securityentries |
Retrieve the security entries associated with the attribute category based on the specified criteria. By default, all security entries for this attribute category are returned. |
| AttributeCategoryApi |
CreateSecurityEntry |
POST /attributecategories/{webId}/securityentries |
Create a security entry owned by the attribute category. |
| AttributeCategoryApi |
GetSecurityEntryByName |
GET /attributecategories/{webId}/securityentries/{name} |
Retrieve the security entry associated with the attribute category with the specified name. |
| AttributeCategoryApi |
UpdateSecurityEntry |
PUT /attributecategories/{webId}/securityentries/{name} |
Update a security entry owned by the attribute category. |
| AttributeCategoryApi |
DeleteSecurityEntry |
DELETE /attributecategories/{webId}/securityentries/{name} |
Delete a security entry owned by the attribute category. |
| AttributeApi |
GetByPath |
GET /attributes |
Retrieve an attribute by path. |
| AttributeApi |
Get |
GET /attributes/{webId} |
Retrieve an attribute. |
| AttributeApi |
Update |
PATCH /attributes/{webId} |
Update an attribute by replacing items in its definition. |
| AttributeApi |
Delete |
DELETE /attributes/{webId} |
Delete an attribute. |
| AttributeApi |
GetAttributes |
GET /attributes/{webId}/attributes |
Get the child attributes of the specified attribute. |
| AttributeApi |
CreateAttribute |
POST /attributes/{webId}/attributes |
Create a new attribute as a child of the specified attribute. |
| AttributeApi |
GetCategories |
GET /attributes/{webId}/categories |
Get an attribute's categories. |
| AttributeApi |
CreateConfig |
POST /attributes/{webId}/config |
Create or update an attribute's DataReference configuration (Create/Update PI point for PI Point DataReference). |
| AttributeApi |
GetValue |
GET /attributes/{webId}/value |
Get 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. |
| AttributeApi |
SetValue |
PUT /attributes/{webId}/value |
Set the value of a configuration item attribute. For attributes with a data reference or non-configuration item attributes, consult the documentation for streams. |
| AttributeApi |
GetMultiple |
GET /attributes/multiple |
Retrieve multiple attributes by web id or path. |
| AttributeTemplateApi |
GetByPath |
GET /attributetemplates |
Retrieve an attribute template by path. |
| AttributeTemplateApi |
Get |
GET /attributetemplates/{webId} |
Retrieve an attribute template. |
| AttributeTemplateApi |
Update |
PATCH /attributetemplates/{webId} |
Update an existing attribute template by replacing items in its definition. |
| AttributeTemplateApi |
Delete |
DELETE /attributetemplates/{webId} |
Delete an attribute template. |
| AttributeTemplateApi |
GetAttributeTemplates |
GET /attributetemplates/{webId}/attributetemplates |
Retrieve an attribute template's child attribute templates. |
| AttributeTemplateApi |
CreateAttributeTemplate |
POST /attributetemplates/{webId}/attributetemplates |
Create an attribute template as a child of another attribute template. |
| AttributeTemplateApi |
GetCategories |
GET /attributetemplates/{webId}/categories |
Get an attribute template's categories. |
| AttributeTraitApi |
GetByCategory |
GET /attributetraits |
Retrieve all attribute traits of the specified category/categories. |
| AttributeTraitApi |
Get |
GET /attributetraits/{name} |
Retrieve an attribute trait. |
| BatchApi |
Execute |
POST /batch |
Execute 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. |
| CalculationApi |
GetAtIntervals |
GET /calculation/intervals |
Returns results of evaluating the expression over the time range from the start time to the end time at a defined interval. |
| CalculationApi |
GetAtRecorded |
GET /calculation/recorded |
Returns 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. |
| CalculationApi |
GetSummary |
GET /calculation/summary |
Returns 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. |
| CalculationApi |
GetAtTimes |
GET /calculation/times |
Returns the result of evaluating the expression at the specified timestamps. |
| ChannelApi |
Instances |
GET /channels/instances |
Retrieves a list of currently running channel instances. |
| DataServerApi |
List |
GET /dataservers |
Retrieve a list of Data Servers known to this service. |
| DataServerApi |
GetByName |
GET /dataservers#name |
Retrieve a Data Server by name. |
| DataServerApi |
GetByPath |
GET /dataservers#path |
Retrieve a Data Server by path. |
| DataServerApi |
Get |
GET /dataservers/{webId} |
Retrieve a Data Server. |
| DataServerApi |
GetEnumerationSets |
GET /dataservers/{webId}/enumerationsets |
Retrieve enumeration sets for given Data Server. |
| DataServerApi |
CreateEnumerationSet |
POST /dataservers/{webId}/enumerationsets |
Create an enumeration set on the Data Server. |
| DataServerApi |
GetPoints |
GET /dataservers/{webId}/points |
Retrieve a list of points on a specified Data Server. |
| DataServerApi |
CreatePoint |
POST /dataservers/{webId}/points |
Create a point in the specified Data Server. |
| ElementCategoryApi |
GetByPath |
GET /elementcategories |
Retrieve an element category by path. |
| ElementCategoryApi |
Get |
GET /elementcategories/{webId} |
Retrieve an element category. |
| ElementCategoryApi |
Update |
PATCH /elementcategories/{webId} |
Update an element category by replacing items in its definition. |
| ElementCategoryApi |
Delete |
DELETE /elementcategories/{webId} |
Delete an element category. |
| ElementCategoryApi |
GetSecurity |
GET /elementcategories/{webId}/security |
Get the security information of the specified security item associated with the element category for a specified user. |
| ElementCategoryApi |
GetSecurityEntries |
GET /elementcategories/{webId}/securityentries |
Retrieve the security entries associated with the element category based on the specified criteria. By default, all security entries for this element category are returned. |
| ElementCategoryApi |
CreateSecurityEntry |
POST /elementcategories/{webId}/securityentries |
Create a security entry owned by the element category. |
| ElementCategoryApi |
GetSecurityEntryByName |
GET /elementcategories/{webId}/securityentries/{name} |
Retrieve the security entry associated with the element category with the specified name. |
| ElementCategoryApi |
UpdateSecurityEntry |
PUT /elementcategories/{webId}/securityentries/{name} |
Update a security entry owned by the element category. |
| ElementCategoryApi |
DeleteSecurityEntry |
DELETE /elementcategories/{webId}/securityentries/{name} |
Delete a security entry owned by the element category. |
| ElementApi |
GetByPath |
GET /elements |
Retrieve an element by path. |
| ElementApi |
Get |
GET /elements/{webId} |
Retrieve an element. |
| ElementApi |
Update |
PATCH /elements/{webId} |
Update an element by replacing items in its definition. |
| ElementApi |
Delete |
DELETE /elements/{webId} |
Delete an element. |
| ElementApi |
GetAnalyses |
GET /elements/{webId}/analyses |
Retrieve analyses based on the specified conditions. |
| ElementApi |
CreateAnalysis |
POST /elements/{webId}/analyses |
Create an Analysis. |
| ElementApi |
GetAttributes |
GET /elements/{webId}/attributes |
Get the attributes of the specified element. |
| ElementApi |
CreateAttribute |
POST /elements/{webId}/attributes |
Create a new attribute of the specified element. |
| ElementApi |
GetCategories |
GET /elements/{webId}/categories |
Get an element's categories. |
| ElementApi |
CreateConfig |
POST /elements/{webId}/config |
Executes the create configuration function of the data references found within the attributes of the element, and optionally, its children. |
| ElementApi |
FindElementAttributes |
GET /elements/{webId}/elementattributes |
Retrieves a list of element attributes matching the specified filters from the specified element. |
| ElementApi |
GetElements |
GET /elements/{webId}/elements |
Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element. |
| ElementApi |
CreateElement |
POST /elements/{webId}/elements |
Create a child element. |
| ElementApi |
GetEventFrames |
GET /elements/{webId}/eventframes |
Retrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element with a start time in the past 8 hours. |
| ElementApi |
GetReferencedElements |
GET /elements/{webId}/referencedelements |
Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements of the current resource. |
| ElementApi |
AddReferencedElement |
POST /elements/{webId}/referencedelements |
Add a reference to an existing element to the child elements collection. |
| ElementApi |
RemoveReferencedElement |
DELETE /elements/{webId}/referencedelements |
Remove a reference to an existing element from the child elements collection. |
| ElementApi |
GetSecurity |
GET /elements/{webId}/security |
Get the security information of the specified security item associated with the element for a specified user. |
| ElementApi |
GetSecurityEntries |
GET /elements/{webId}/securityentries |
Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned. |
| ElementApi |
CreateSecurityEntry |
POST /elements/{webId}/securityentries |
Create a security entry owned by the element. |
| ElementApi |
GetSecurityEntryByName |
GET /elements/{webId}/securityentries/{name} |
Retrieve the security entry associated with the element with the specified name. |
| ElementApi |
UpdateSecurityEntry |
PUT /elements/{webId}/securityentries/{name} |
Update a security entry owned by the element. |
| ElementApi |
DeleteSecurityEntry |
DELETE /elements/{webId}/securityentries/{name} |
Delete a security entry owned by the element. |
| ElementApi |
GetMultiple |
GET /elements/multiple |
Retrieve multiple elements by web id or path. |
| ElementApi |
CreateSearchByAttribute |
POST /elements/searchbyattribute |
Create 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. |
| ElementApi |
ExecuteSearchByAttribute |
GET /elements/searchbyattribute/{searchId} |
Execute a "Search Elements By Attribute Value" operation. |
| ElementTemplateApi |
GetByPath |
GET /elementtemplates |
Retrieve an element template by path. |
| ElementTemplateApi |
Get |
GET /elementtemplates/{webId} |
Retrieve an element template. |
| ElementTemplateApi |
Update |
PATCH /elementtemplates/{webId} |
Update an element template by replacing items in its definition. |
| ElementTemplateApi |
Delete |
DELETE /elementtemplates/{webId} |
Delete an element template. |
| ElementTemplateApi |
GetAnalysisTemplates |
GET /elementtemplates/{webId}/analysistemplates |
Get analysis templates for an element template. |
| ElementTemplateApi |
GetAttributeTemplates |
GET /elementtemplates/{webId}/attributetemplates |
Get child attribute templates for an element template. |
| ElementTemplateApi |
CreateAttributeTemplate |
POST /elementtemplates/{webId}/attributetemplates |
Create an attribute template. |
| ElementTemplateApi |
GetCategories |
GET /elementtemplates/{webId}/categories |
Get an element template's categories. |
| ElementTemplateApi |
GetSecurity |
GET /elementtemplates/{webId}/security |
Get the security information of the specified security item associated with the element template for a specified user. |
| ElementTemplateApi |
GetSecurityEntries |
GET /elementtemplates/{webId}/securityentries |
Retrieve the security entries associated with the element template based on the specified criteria. By default, all security entries for this element template are returned. |
| ElementTemplateApi |
CreateSecurityEntry |
POST /elementtemplates/{webId}/securityentries |
Create a security entry owned by the element template. |
| ElementTemplateApi |
GetSecurityEntryByName |
GET /elementtemplates/{webId}/securityentries/{name} |
Retrieve the security entry associated with the element template with the specified name. |
| ElementTemplateApi |
UpdateSecurityEntry |
PUT /elementtemplates/{webId}/securityentries/{name} |
Update a security entry owned by the element template. |
| ElementTemplateApi |
DeleteSecurityEntry |
DELETE /elementtemplates/{webId}/securityentries/{name} |
Delete a security entry owned by the element template. |
| EnumerationSetApi |
GetByPath |
GET /enumerationsets |
Retrieve an enumeration set by path. |
| EnumerationSetApi |
Get |
GET /enumerationsets/{webId} |
Retrieve an enumeration set. |
| EnumerationSetApi |
Update |
PATCH /enumerationsets/{webId} |
Update an enumeration set by replacing items in its definition. |
| EnumerationSetApi |
Delete |
DELETE /enumerationsets/{webId} |
Delete an enumeration set. |
| EnumerationSetApi |
GetValues |
GET /enumerationsets/{webId}/enumerationvalues |
Retrieve an enumeration set's values. |
| EnumerationSetApi |
CreateValue |
POST /enumerationsets/{webId}/enumerationvalues |
Create an enumeration value for a enumeration set. |
| EnumerationSetApi |
GetSecurity |
GET /enumerationsets/{webId}/security |
Get the security information of the specified security item associated with the enumeration set for a specified user. |
| EnumerationSetApi |
GetSecurityEntries |
GET /enumerationsets/{webId}/securityentries |
Retrieve the security entries associated with the enumeration set based on the specified criteria. By default, all security entries for this enumeration set are returned. |
| EnumerationSetApi |
CreateSecurityEntry |
POST /enumerationsets/{webId}/securityentries |
Create a security entry owned by the enumeration set. |
| EnumerationSetApi |
GetSecurityEntryByName |
GET /enumerationsets/{webId}/securityentries/{name} |
Retrieve the security entry associated with the enumeration set with the specified name. |
| EnumerationSetApi |
UpdateSecurityEntry |
PUT /enumerationsets/{webId}/securityentries/{name} |
Update a security entry owned by the enumeration set. |
| EnumerationSetApi |
DeleteSecurityEntry |
DELETE /enumerationsets/{webId}/securityentries/{name} |
Delete a security entry owned by the enumeration set. |
| EnumerationValueApi |
GetByPath |
GET /enumerationvalues |
Retrieve an enumeration value by path. |
| EnumerationValueApi |
Get |
GET /enumerationvalues/{webId} |
Retrieve an enumeration value mapping |
| EnumerationValueApi |
UpdateEnumerationValue |
PATCH /enumerationvalues/{webId} |
Update an enumeration value by replacing items in its definition. |
| EnumerationValueApi |
DeleteEnumerationValue |
DELETE /enumerationvalues/{webId} |
Delete an enumeration value from an enumeration set. |
| EventFrameApi |
GetByPath |
GET /eventframes |
Retrieve an event frame by path. |
| EventFrameApi |
Get |
GET /eventframes/{webId} |
Retrieve an event frame. |
| EventFrameApi |
Update |
PATCH /eventframes/{webId} |
Update an event frame by replacing items in its definition. |
| EventFrameApi |
Delete |
DELETE /eventframes/{webId} |
Delete an event frame. |
| EventFrameApi |
Acknowledge |
PATCH /eventframes/{webId}/acknowledge |
Calls the EventFrame's Acknowledge method. |
| EventFrameApi |
GetAnnotations |
GET /eventframes/{webId}/annotations |
Get an event frame's annotations. |
| EventFrameApi |
CreateAnnotation |
POST /eventframes/{webId}/annotations |
Create an annotation on an event frame. |
| EventFrameApi |
GetAnnotationById |
GET /eventframes/{webId}/annotations/{id} |
Get a specific annotation on an event frame. |
| EventFrameApi |
UpdateAnnotation |
PATCH /eventframes/{webId}/annotations/{id} |
Update an annotation on an event frame by replacing items in its definition. |
| EventFrameApi |
DeleteAnnotation |
DELETE /eventframes/{webId}/annotations/{id} |
Delete an annotation on an event frame. |
| EventFrameApi |
GetAttributes |
GET /eventframes/{webId}/attributes |
Get the attributes of the specified event frame. |
| EventFrameApi |
CreateAttribute |
POST /eventframes/{webId}/attributes |
Create a new attribute of the specified event frame. |
| EventFrameApi |
CaptureValues |
POST /eventframes/{webId}/attributes/capture |
Calls the EventFrame's CaptureValues method. |
| EventFrameApi |
GetCategories |
GET /eventframes/{webId}/categories |
Get an event frame's categories. |
| EventFrameApi |
CreateConfig |
POST /eventframes/{webId}/config |
Executes the create configuration function of the data references found within the attributes of the event frame, and optionally, its children. |
| EventFrameApi |
FindEventFrameAttributes |
GET /eventframes/{webId}/eventframeattributes |
Retrieves a list of event frame attributes matching the specified filters from the specified event frame. |
| EventFrameApi |
GetEventFrames |
GET /eventframes/{webId}/eventframes |
Retrieve event frames based on the specified conditions. By default, returns all children of the specified root event frame with a start time in the past 8 hours. |
| EventFrameApi |
CreateEventFrame |
POST /eventframes/{webId}/eventframes |
Create an event frame as a child of the specified event frame. |
| EventFrameApi |
GetReferencedElements |
GET /eventframes/{webId}/referencedelements |
Retrieve the event frame's referenced elements. |
| EventFrameApi |
GetSecurity |
GET /eventframes/{webId}/security |
Get the security information of the specified security item associated with the event frame for a specified user. |
| EventFrameApi |
GetSecurityEntries |
GET /eventframes/{webId}/securityentries |
Retrieve the security entries associated with the event frame based on the specified criteria. By default, all security entries for this event frame are returned. |
| EventFrameApi |
CreateSecurityEntry |
POST /eventframes/{webId}/securityentries |
Create a security entry owned by the event frame. |
| EventFrameApi |
GetSecurityEntryByName |
GET /eventframes/{webId}/securityentries/{name} |
Retrieve the security entry associated with the event frame with the specified name. |
| EventFrameApi |
UpdateSecurityEntry |
PUT /eventframes/{webId}/securityentries/{name} |
Update a security entry owned by the event frame. |
| EventFrameApi |
DeleteSecurityEntry |
DELETE /eventframes/{webId}/securityentries/{name} |
Delete a security entry owned by the event frame. |
| EventFrameApi |
GetMultiple |
GET /eventframes/multiple |
Retrieve multiple event frames by web ids or paths. |
| EventFrameApi |
CreateSearchByAttribute |
POST /eventframes/searchbyattribute |
Create 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. |
| EventFrameApi |
ExecuteSearchByAttribute |
GET /eventframes/searchbyattribute/{searchId} |
Execute a "Search EventFrames By Attribute Value" operation. |
| PointApi |
GetByPath |
GET /points |
Get a point by path. |
| PointApi |
Get |
GET /points/{webId} |
Get a point. |
| PointApi |
Update |
PATCH /points/{webId} |
Update a point. |
| PointApi |
Delete |
DELETE /points/{webId} |
Delete a point. |
| PointApi |
GetAttributes |
GET /points/{webId}/attributes |
Get point attributes. |
| PointApi |
GetAttributeByName |
GET /points/{webId}/attributes/{name} |
Get a point attribute by name. |
| PointApi |
UpdateAttributeValue |
PUT /points/{webId}/attributes/{name} |
Update a point attribute value. |
| PointApi |
GetMultiple |
GET /points/multiple |
Retrieve multiple points by web id or path. |
| SecurityIdentityApi |
GetByPath |
GET /securityidentities |
Retrieve a security identity by path. |
| SecurityIdentityApi |
Get |
GET /securityidentities/{webId} |
Retrieve a security identity. |
| SecurityIdentityApi |
Update |
PATCH /securityidentities/{webId} |
Update a security identity by replacing items in its definition. |
| SecurityIdentityApi |
Delete |
DELETE /securityidentities/{webId} |
Delete a security identity. |
| SecurityIdentityApi |
GetSecurity |
GET /securityidentities/{webId}/security |
Get the security information of the specified security item associated with the security identity for a specified user. |
| SecurityIdentityApi |
GetSecurityEntries |
GET /securityidentities/{webId}/securityentries |
Retrieve the security entries associated with the security identity based on the specified criteria. By default, all security entries for this security identity are returned. |
| SecurityIdentityApi |
GetSecurityEntryByName |
GET /securityidentities/{webId}/securityentries/{name} |
Retrieve the security entry associated with the security identity with the specified name. |
| SecurityIdentityApi |
GetSecurityMappings |
GET /securityidentities/{webId}/securitymappings |
Get security mappings for the specified security identity. |
| SecurityMappingApi |
GetByPath |
GET /securitymappings |
Retrieve a security mapping by path. |
| SecurityMappingApi |
Get |
GET /securitymappings/{webId} |
Retrieve a security mapping. |
| SecurityMappingApi |
Update |
PATCH /securitymappings/{webId} |
Update a security mapping by replacing items in its definition. |
| SecurityMappingApi |
Delete |
DELETE /securitymappings/{webId} |
Delete a security mapping. |
| SecurityMappingApi |
GetSecurity |
GET /securitymappings/{webId}/security |
Get the security information of the specified security item associated with the security mapping for a specified user. |
| SecurityMappingApi |
GetSecurityEntries |
GET /securitymappings/{webId}/securityentries |
Retrieve the security entries associated with the security mapping based on the specified criteria. By default, all security entries for this security mapping are returned. |
| SecurityMappingApi |
GetSecurityEntryByName |
GET /securitymappings/{webId}/securityentries/{name} |
Retrieve the security entry associated with the security mapping with the specified name. |
| StreamApi |
GetChannel |
GET /streams/{webId}/channel |
Opens a channel that will send messages about any value changes for the specified stream. |
| StreamApi |
GetEnd |
GET /streams/{webId}/end |
Returns the end-of-stream value of the stream. |
| StreamApi |
GetInterpolated |
GET /streams/{webId}/interpolated |
Retrieves interpolated values over the specified time range at the specified sampling interval. |
| StreamApi |
GetInterpolatedAtTimes |
GET /streams/{webId}/interpolatedattimes |
Retrieves interpolated values over the specified time range at the specified sampling interval. |
| StreamApi |
GetPlot |
GET /streams/{webId}/plot |
Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels). |
| StreamApi |
GetRecorded |
GET /streams/{webId}/recorded |
Returns a list of compressed values for the requested time range from the source provider. |
| StreamApi |
UpdateValues |
POST /streams/{webId}/recorded |
Updates multiple values for the specified stream. |
| StreamApi |
GetRecordedAtTime |
GET /streams/{webId}/recordedattime |
Returns a single recorded value based on the passed time and retrieval mode from the stream. |
| StreamApi |
GetRecordedAtTimes |
GET /streams/{webId}/recordedattimes |
Retrieves recorded values at the specified times. |
| StreamApi |
GetSummary |
GET /streams/{webId}/summary |
Returns a summary over the specified time range for the stream. |
| StreamApi |
GetValue |
GET /streams/{webId}/value |
Returns the value of the stream at the specified time. By default, this is usually the current value. |
| StreamApi |
UpdateValue |
POST /streams/{webId}/value |
Updates a value for the specified stream. |
| StreamSetApi |
GetChannel |
GET /streamsets/{webId}/channel |
Opens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute. |
| StreamSetApi |
GetEnd |
GET /streamsets/{webId}/end |
Returns End of stream values of the attributes for an Element, Event Frame or Attribute |
| StreamSetApi |
GetInterpolated |
GET /streamsets/{webId}/interpolated |
Returns interpolated values of attributes for an element, event frame or attribute over the specified time range at the specified sampling interval. |
| StreamSetApi |
GetInterpolatedAtTimes |
GET /streamsets/{webId}/interpolatedattimes |
Returns interpolated values of attributes for an element, event frame or attribute at the specified times. |
| StreamSetApi |
GetPlot |
GET /streamsets/{webId}/plot |
Returns values of attributes for an element, event frame or attribute over the specified time range suitable for plotting over the number of intervals (typically represents pixels). |
| StreamSetApi |
GetRecorded |
GET /streamsets/{webId}/recorded |
Returns recorded values of the attributes for an element, event frame, or attribute. |
| StreamSetApi |
UpdateValues |
POST /streamsets/{webId}/recorded |
Updates multiple values for the specified streams. |
| StreamSetApi |
GetRecordedAtTime |
GET /streamsets/{webId}/recordedattime |
Returns recorded values of the attributes for an element, event frame, or attribute. |
| StreamSetApi |
GetRecordedAtTimes |
GET /streamsets/{webId}/recordedattimes |
Returns recorded values of attributes for an element, event frame or attribute at the specified times. |
| StreamSetApi |
GetSummaries |
GET /streamsets/{webId}/summary |
Returns summary values of the attributes for an element, event frame or attribute. |
| StreamSetApi |
GetValues |
GET /streamsets/{webId}/value |
Returns values of the attributes for an Element, Event Frame or Attribute at the specified time. |
| StreamSetApi |
UpdateValue |
POST /streamsets/{webId}/value |
Updates a single value for the specified streams. |
| StreamSetApi |
GetChannelAdHoc |
GET /streamsets/channel |
Opens a channel that will send messages about any value changes for the specified streams. |
| StreamSetApi |
GetEndAdHoc |
GET /streamsets/end |
Returns End Of Stream values for attributes of the specified streams |
| StreamSetApi |
GetInterpolatedAdHoc |
GET /streamsets/interpolated |
Returns interpolated values of the specified streams over the specified time range at the specified sampling interval. |
| StreamSetApi |
GetInterpolatedAtTimesAdHoc |
GET /streamsets/interpolatedattimes |
Returns interpolated values of the specified streams at the specified times. |
| StreamSetApi |
GetPlotAdHoc |
GET /streamsets/plot |
Returns values of attributes for the specified streams over the specified time range suitable for plotting over the number of intervals (typically represents pixels). |
| StreamSetApi |
GetRecordedAdHoc |
GET /streamsets/recorded |
Returns recorded values of the specified streams. |
| StreamSetApi |
UpdateValuesAdHoc |
POST /streamsets/recorded |
Updates multiple values for the specified streams. |
| StreamSetApi |
GetRecordedAtTimeAdHoc |
GET /streamsets/recordedattime |
Returns recorded values based on the passed time and retrieval mode. |
| StreamSetApi |
GetRecordedAtTimesAdHoc |
GET /streamsets/recordedattimes |
Returns recorded values of the specified streams at the specified times. |
| StreamSetApi |
GetSummariesAdHoc |
GET /streamsets/summary |
Returns summary values of the specified streams. |
| StreamSetApi |
GetValuesAdHoc |
GET /streamsets/value |
Returns values of the specified streams. |
| StreamSetApi |
UpdateValueAdHoc |
POST /streamsets/value |
Updates a single value for the specified streams. |
| SystemApi |
Landing |
GET /system |
Get system links for this PI System Web API instance. |
| SystemApi |
CacheInstances |
GET /system/cacheinstances |
Get AF cache instances currently in use by the system. These are caches from which user requests are serviced. The number of instances depends on the number of users connected to the service, the service's authentication method, and the cache instance configuration. |
| SystemApi |
Status |
GET /system/status |
Get the system uptime, the system state and the number of cache instances for this PI System Web API instance. |
| SystemApi |
UserInfo |
GET /system/userinfo |
Get information about the Windows identity used to fulfill the request. This depends on the service's authentication method and the credentials passed by the client. The impersonation level of the Windows identity is included. |
| SystemApi |
Versions |
GET /system/versions |
Get the current versions of the PI Web API instance and all external plugins. |
| ConfigurationApi |
List |
GET /system/configuration |
Get the current system configuration. |
| ConfigurationApi |
Get |
GET /system/configuration/{key} |
Get the value of a configuration item. |
| ConfigurationApi |
Delete |
DELETE /system/configuration/{key} |
Delete a configuration item. |
| ConfigurationApi |
Put |
PUT /system/configuration/{key} |
Create or update a configuration item. |
| TableCategoryApi |
GetByPath |
GET /tablecategories |
Retrieve a table category by path. |
| TableCategoryApi |
Get |
GET /tablecategories/{webId} |
Retrieve a table category. |
| TableCategoryApi |
Update |
PATCH /tablecategories/{webId} |
Update a table category by replacing items in its definition. |
| TableCategoryApi |
Delete |
DELETE /tablecategories/{webId} |
Delete a table category. |
| TableCategoryApi |
GetSecurity |
GET /tablecategories/{webId}/security |
Get the security information of the specified security item associated with the table category for a specified user. |
| TableCategoryApi |
GetSecurityEntries |
GET /tablecategories/{webId}/securityentries |
Retrieve the security entries associated with the table category based on the specified criteria. By default, all security entries for this table category are returned. |
| TableCategoryApi |
CreateSecurityEntry |
POST /tablecategories/{webId}/securityentries |
Create a security entry owned by the table category. |
| TableCategoryApi |
GetSecurityEntryByName |
GET /tablecategories/{webId}/securityentries/{name} |
Retrieve the security entry associated with the table category with the specified name. |
| TableCategoryApi |
UpdateSecurityEntry |
PUT /tablecategories/{webId}/securityentries/{name} |
Update a security entry owned by the table category. |
| TableCategoryApi |
DeleteSecurityEntry |
DELETE /tablecategories/{webId}/securityentries/{name} |
Delete a security entry owned by the table category. |
| TableApi |
GetByPath |
GET /tables |
Retrieve a table by path. |
| TableApi |
Get |
GET /tables/{webId} |
Retrieve a table. |
| TableApi |
Update |
PATCH /tables/{webId} |
Update a table by replacing items in its definition. |
| TableApi |
Delete |
DELETE /tables/{webId} |
Delete a table. |
| TableApi |
GetCategories |
GET /tables/{webId}/categories |
Get a table's categories. |
| TableApi |
GetData |
GET /tables/{webId}/data |
Get the table's data. |
| TableApi |
UpdateData |
PUT /tables/{webId}/data |
Update the table's data. |
| TableApi |
GetSecurity |
GET /tables/{webId}/security |
Get the security information of the specified security item associated with the table for a specified user. |
| TableApi |
GetSecurityEntries |
GET /tables/{webId}/securityentries |
Retrieve the security entries associated with the table based on the specified criteria. By default, all security entries for this table are returned. |
| TableApi |
CreateSecurityEntry |
POST /tables/{webId}/securityentries |
Create a security entry owned by the table. |
| TableApi |
GetSecurityEntryByName |
GET /tables/{webId}/securityentries/{name} |
Retrieve the security entry associated with the table with the specified name. |
| TableApi |
UpdateSecurityEntry |
PUT /tables/{webId}/securityentries/{name} |
Update a security entry owned by the table. |
| TableApi |
DeleteSecurityEntry |
DELETE /tables/{webId}/securityentries/{name} |
Delete a security entry owned by the table. |
| TimeRulePlugInApi |
GetByPath |
GET /timeruleplugins |
Retrieve a Time Rule Plug-in by path. |
| TimeRulePlugInApi |
Get |
GET /timeruleplugins/{webId} |
Retrieve a Time Rule Plug-in. |
| TimeRuleApi |
GetByPath |
GET /timerules |
Retrieve a Time Rule by path. |
| TimeRuleApi |
Get |
GET /timerules/{webId} |
Retrieve a Time Rule. |
| TimeRuleApi |
Update |
PATCH /timerules/{webId} |
Update a Time Rule by replacing items in its definition. |
| TimeRuleApi |
Delete |
DELETE /timerules/{webId} |
Delete a Time Rule. |
| UnitClassApi |
GetByPath |
GET /unitclasses |
Retrieve a unit class by path. |
| UnitClassApi |
Get |
GET /unitclasses/{webId} |
Retrieve a unit class. |
| UnitClassApi |
Update |
PATCH /unitclasses/{webId} |
Update a unit class. |
| UnitClassApi |
Delete |
DELETE /unitclasses/{webId} |
Delete a unit class. |
| UnitClassApi |
GetCanonicalUnit |
GET /unitclasses/{webId}/canonicalunit |
Get the canonical unit of a unit class. |
| UnitClassApi |
GetUnits |
GET /unitclasses/{webId}/units |
Get a list of all units belonging to the unit class. |
| UnitClassApi |
CreateUnit |
POST /unitclasses/{webId}/units |
Create a unit in the specified Unit Class. |
| UnitApi |
GetByPath |
GET /units |
Retrieve a unit by path. |
| UnitApi |
Get |
GET /units/{webId} |
Retrieve a unit. |
| UnitApi |
Update |
PATCH /units/{webId} |
Update a unit. |
| UnitApi |
Delete |
DELETE /units/{webId} |
Delete a unit. |