@datafire/osisoft

Client library for PI Web API 2018 SP1 Swagger Spec

Installation and Usage

npm install --save @datafire/osisoft

let osisoft = require('@datafire/osisoft').create();

.then(data => {
  console.log(data);
});

Description

Swagger Spec file that describes PI Web API

Actions

Home_Get

Get top level links for this PI System Web API instance.

osisoft.Home_Get(null, context)

Input

This action has no parameters

Output

• output Landing

Analysis_GetByPath

This 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 the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.Analysis_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the Analysis.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Analysis

Analysis_GetAnalysesQuery

Retrieve analyses based on the specified conditions. By default, returns all analyses.

osisoft.Analysis_GetAnalysesQuery({}, context)

Input

• input object
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the analyses in the asset database. An example would be: "query= Name:=MyAnalysis1* Template:=AnalysisTemplate".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Analysis]

Analysis_Delete

Delete an Analysis.

osisoft.Analysis_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Analysis to delete.

Output

Output schema unknown

Analysis_Get

Retrieve an Analysis.

osisoft.Analysis_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Analysis.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Analysis

Analysis_Update

Update an Analysis.

osisoft.Analysis_Update({
  "webId": "",
  "analysis": {}
}, context)

Input

• input object
  • webId required string: The ID of the Analysis to update.
  • analysis required Analysis

Output

Output schema unknown

Analysis_GetCategories

Get an Analysis' categories.

osisoft.Analysis_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Analysis.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisCategory]

Analysis_GetSecurity

Get the security information of the specified security item associated with the Analysis for a specified user.

osisoft.Analysis_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the Analysis for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

Analysis_GetSecurityEntries

Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned.

osisoft.Analysis_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

Analysis_CreateSecurityEntry

Create a security entry owned by the analysis.

osisoft.Analysis_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the analysis, where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Analysis_DeleteSecurityEntry

Delete a security entry owned by the analysis.

osisoft.Analysis_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the analysis, where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Analysis_GetSecurityEntryByName

Retrieve the security entry associated with the analysis with the specified name.

osisoft.Analysis_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the analysis.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

Analysis_UpdateSecurityEntry

Update a security entry owned by the analysis.

osisoft.Analysis_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the analysis, where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

AnalysisCategory_GetByPath

Retrieve an analysis category by path.

osisoft.AnalysisCategory_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the target analysis category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisCategory

AnalysisCategory_Delete

Delete an analysis category.

osisoft.AnalysisCategory_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis category to delete.

Output

Output schema unknown

AnalysisCategory_Get

Retrieve an analysis category.

osisoft.AnalysisCategory_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisCategory

AnalysisCategory_Update

Update an analysis category by replacing items in its definition.

osisoft.AnalysisCategory_Update({
  "webId": "",
  "category": {}
}, context)

Input

• input object
  • webId required string: The ID of the analysis category to update.
  • category required AnalysisCategory

Output

Output schema unknown

AnalysisCategory_GetSecurity

Get the security information of the specified security item associated with the analysis category for a specified user.

osisoft.AnalysisCategory_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the analysis category for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

AnalysisCategory_GetSecurityEntries

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.

osisoft.AnalysisCategory_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis category.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

AnalysisCategory_CreateSecurityEntry

Create a security entry owned by the analysis category.

osisoft.AnalysisCategory_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the analysis category, where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AnalysisCategory_DeleteSecurityEntry

Delete a security entry owned by the analysis category.

osisoft.AnalysisCategory_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the analysis category, where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

AnalysisCategory_GetSecurityEntryByName

Retrieve the security entry associated with the analysis category with the specified name.

osisoft.AnalysisCategory_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the analysis category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

AnalysisCategory_UpdateSecurityEntry

Update a security entry owned by the analysis category.

osisoft.AnalysisCategory_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the analysis category, where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

AnalysisRulePlugIn_GetByPath

This 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 separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.AnalysisRulePlugIn_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the Analysis Rule Plug-in.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisRulePlugIn

AnalysisRulePlugIn_Get

Retrieve an Analysis Rule Plug-in.

osisoft.AnalysisRulePlugIn_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Analysis Rule Plug-in.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisRulePlugIn

AnalysisRule_GetByPath

This 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 of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.AnalysisRule_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the Analysis Rule.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisRule

AnalysisRule_Delete

Delete an Analysis Rule.

osisoft.AnalysisRule_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Analysis Rule.

Output

Output schema unknown

AnalysisRule_Get

Retrieve an Analysis Rule.

osisoft.AnalysisRule_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Analysis Rule.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisRule

AnalysisRule_Update

Update an Analysis Rule by replacing items in its definition.

osisoft.AnalysisRule_Update({
  "webId": "",
  "analysisRule": {}
}, context)

Input

• input object
  • webId required string: The ID of the Analysis Rule.
  • analysisRule required AnalysisRule

Output

Output schema unknown

AnalysisRule_GetAnalysisRules

Get the child Analysis Rules of the Analysis Rule.

osisoft.AnalysisRule_GetAnalysisRules({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the parent Analysis Rule.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding Analysis Rules. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisRule]

AnalysisRule_CreateAnalysisRule

Create a new Analysis Rule as a child of an existing Analysis Rule.

osisoft.AnalysisRule_CreateAnalysisRule({
  "webId": "",
  "analysisRule": {}
}, context)

Input

• input object
  • webId required string: The ID of the parent Analysis Rule, on which to create the child Analysis Rule.
  • analysisRule required AnalysisRule
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AnalysisTemplate_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.AnalysisTemplate_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the analysis template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisTemplate

AnalysisTemplate_CreateFromAnalysis

Create an Analysis template based upon a specified Analysis.

osisoft.AnalysisTemplate_CreateFromAnalysis({
  "analysisWebId": ""
}, context)

Input

• input object
  • analysisWebId required string: The ID of the Analysis, on which the template is created.
  • name string: The name for the created template, which must be unique within the database's AnalysisTemplate collection. If the name ends with an asterisk (), then a unique name will be generated based on the supplied name. The default is the specified Analysis' name suffixed with an asterisk ().
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AnalysisTemplate_GetAnalysisTemplatesQuery

Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates.

osisoft.AnalysisTemplate_GetAnalysisTemplatesQuery({}, context)

Input

• input object
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the analyses in the asset database. An example would be: "query= Name:=MyAnalysisTemplate1*".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisTemplate]

AnalysisTemplate_Delete

Deleting an analysis template will delete any analysis which was created from it, unless the analysis is tied to a notification.

osisoft.AnalysisTemplate_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis template to update.

Output

Output schema unknown

AnalysisTemplate_Get

Retrieve an analysis template.

osisoft.AnalysisTemplate_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AnalysisTemplate

AnalysisTemplate_Update

Update an analysis template by replacing items in its definition.

osisoft.AnalysisTemplate_Update({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the analysis template to update.
  • template required AnalysisTemplate

Output

Output schema unknown

AnalysisTemplate_GetCategories

Get an analysis template's categories.

osisoft.AnalysisTemplate_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisCategory]

AnalysisTemplate_GetSecurity

Get the security information of the specified security item associated with the analysis template for a specified user.

osisoft.AnalysisTemplate_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the analysis template for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

AnalysisTemplate_GetSecurityEntries

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.

osisoft.AnalysisTemplate_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the analysis template.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

AnalysisTemplate_CreateSecurityEntry

Create a security entry owned by the analysis template.

osisoft.AnalysisTemplate_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the analysis template, where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AnalysisTemplate_DeleteSecurityEntry

Delete a security entry owned by the analysis template.

osisoft.AnalysisTemplate_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the analysis template, where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

AnalysisTemplate_GetSecurityEntryByName

Retrieve the security entry associated with the analysis template with the specified name.

osisoft.AnalysisTemplate_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the analysis template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

AnalysisTemplate_UpdateSecurityEntry

Update a security entry owned by the analysis template.

osisoft.AnalysisTemplate_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the analysis template, where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

AssetDatabase_GetByPath

This 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 of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.AssetDatabase_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AssetDatabase

AssetDatabase_Delete

Delete an asset database.

osisoft.AssetDatabase_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.

Output

Output schema unknown

AssetDatabase_Get

Retrieve an Asset Database.

osisoft.AssetDatabase_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AssetDatabase

AssetDatabase_Update

Update an asset database by replacing items in its definition.

osisoft.AssetDatabase_Update({
  "webId": "",
  "database": {}
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • database required AssetDatabase

Output

Output schema unknown

AssetDatabase_FindAnalyses

Users can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the analyses that match the default search.

osisoft.AssetDatabase_FindAnalyses({
  "webId": "",
  "field": []
}, context)

Input

• input object
  • webId required string: The ID of the database to search for the analyses.
  • field required array: Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string used for finding analyses. The default is null.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Analysis]

AssetDatabase_GetAnalysisCategories

Retrieve analysis categories for a given Asset Database.

osisoft.AssetDatabase_GetAnalysisCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisCategory]

AssetDatabase_CreateAnalysisCategory

Create an analysis category at the Asset Database root.

osisoft.AssetDatabase_CreateAnalysisCategory({
  "webId": "",
  "analysisCategory": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the analysis category.
  • analysisCategory required AnalysisCategory
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_GetAnalysisTemplates

Users can search for the analysis templates based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the templates that match the default search.

osisoft.AssetDatabase_GetAnalysisTemplates({
  "webId": "",
  "field": []
}, context)

Input

• input object
  • webId required string: The ID of the database to search.
  • field required array: Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string used for finding objects. The default is no query string.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisTemplate]

AssetDatabase_CreateAnalysisTemplate

Analyses that are based on an analysis template will inherit characteristics defined in the template.

osisoft.AssetDatabase_CreateAnalysisTemplate({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the analysis template.
  • template required AnalysisTemplate
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_GetAttributeCategories

Retrieve attribute categories for a given Asset Database.

osisoft.AssetDatabase_GetAttributeCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AttributeCategory]

AssetDatabase_CreateAttributeCategory

Create an attribute category at the Asset Database root.

osisoft.AssetDatabase_CreateAttributeCategory({
  "webId": "",
  "attributeCategory": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the attribute category.
  • attributeCategory required AttributeCategory
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_FindElementAttributes

Retrieves a list of element attributes matching the specified filters from the specified asset database.

osisoft.AssetDatabase_FindElementAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset database to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • attributeCategory string: Specify that returned attributes must have this category. The default is no filter.
  • attributeDescriptionFilter string: The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • attributeNameFilter string: The attribute name filter string used for finding objects. The default is no filter.
  • attributeType string: Specify that returned attributes' value type must be this value type. The default is no filter.
  • elementCategory string: Specify that the owner of the returned attributes must have this category. The default is no filter.
  • elementDescriptionFilter string: The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • elementNameFilter string: The element name filter string used for finding objects. The default is no filter.
  • elementTemplate string: Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
  • elementType string: Specify that the element of the returned attributes must have this AFElementType. The default is no filter.
  • maxCount integer: The maximum number of objects to be returned (the page size). The default is 1000.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

AssetDatabase_GetElementCategories

Retrieve element categories for a given Asset Database.

osisoft.AssetDatabase_GetElementCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementCategory]

AssetDatabase_CreateElementCategory

Create an element category at the Asset Database root.

osisoft.AssetDatabase_CreateElementCategory({
  "webId": "",
  "elementCategory": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the element category.
  • elementCategory required ElementCategory
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_GetElements

Users can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search.

osisoft.AssetDatabase_GetElements({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • categoryName string: Specify that returned elements must have this category. The default is no category filter.
  • descriptionFilter string: Specify that returned elements must have this description. The default is no description filter.
  • elementType string: Specify that returned elements must have this type. The default type is 'Any'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding objects. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

AssetDatabase_CreateElement

Create a child element.

osisoft.AssetDatabase_CreateElement({
  "webId": "",
  "element": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset database on which to create the element.
  • element required Element
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_GetElementTemplates

Users can search for the element and event frame template based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the templates that match the default search.

osisoft.AssetDatabase_GetElementTemplates({
  "webId": "",
  "field": []
}, context)

Input

• input object
  • webId required string: The ID of the database to search.
  • field required array: Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string used for finding objects. The default is no query string.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementTemplate]

AssetDatabase_CreateElementTemplate

Elements and event frames that are based on an element template will inherit characteristics defined in the template.

osisoft.AssetDatabase_CreateElementTemplate({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the element template.
  • template required ElementTemplate
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_GetEnumerationSets

Retrieve enumeration sets for given asset database.

osisoft.AssetDatabase_GetEnumerationSets({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EnumerationSet]

AssetDatabase_CreateEnumerationSet

Create an enumeration set at the Asset Database.

osisoft.AssetDatabase_CreateEnumerationSet({
  "webId": "",
  "enumerationSet": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the enumeration set.
  • enumerationSet required EnumerationSet
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_FindEventFrameAttributes

Retrieves a list of event frame attributes matching the specified filters from the specified asset database.

osisoft.AssetDatabase_FindEventFrameAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset database to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • attributeCategory string: Specify that returned attributes must have this category. The default is no filter.
  • attributeDescriptionFilter string: The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • attributeNameFilter string: The attribute name filter string used for finding objects. The default is no filter.
  • attributeType string: Specify that returned attributes' value type must be this value type. The default is no filter.
  • endTime string: A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the startTime. The default is '*'.
  • eventFrameCategory string: Specify that the owner of the returned attributes must have this category. The default is no filter.
  • eventFrameDescriptionFilter string: The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • eventFrameNameFilter string: The event frame name filter string used for finding objects. The default is no filter.
  • eventFrameTemplate string: Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
  • maxCount integer: The maximum number of objects to be returned (the page size). The default is 1000.
  • referencedElementNameFilter string: The name query string which must match the name of a referenced element. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
  • searchMode string: Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • startTime string: A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime. The default is '*-8h'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

AssetDatabase_GetEventFrames

Retrieve 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.

osisoft.AssetDatabase_GetEventFrames({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset database to use as the root of the search.
  • canBeAcknowledged boolean: Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
  • categoryName string: Specify that returned event frames must have this category. The default is no category filter.
  • endTime string: The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '' if searchMode is not one of the 'Backward' or 'Forward*' values.
  • isAcknowledged boolean: Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding event frames. The default is no filter.
  • referencedElementNameFilter string: The name query string which must match the name of a referenced element. The default is no filter.
  • referencedElementTemplateName string: Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the template. Specify this parameter by name.
  • searchFullHierarchy boolean: Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.
  • searchMode string: Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • severity array: Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • startTime string: The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
  • templateName string: Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EventFrame]

AssetDatabase_CreateEventFrame

Create an event frame.

osisoft.AssetDatabase_CreateEventFrame({
  "webId": "",
  "eventFrame": {}
}, context)

Input

• input object
  • webId required string: The ID of the database on which to create the event frame.
  • eventFrame required EventFrame
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_Export

Export the asset database.

osisoft.AssetDatabase_Export({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • endTime string: The latest ending time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*'.
  • exportMode array: Indicates the type of export to perform. The default is 'StrongReferences'. Multiple export modes may be specified by using multiple instances of exportMode.
  • startTime string: The earliest starting time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*-30d'.

Output

Output schema unknown

AssetDatabase_Import

Import an asset database.

osisoft.AssetDatabase_Import({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset database.
  • importMode array: Indicates the type of import to perform. The default is 'AllowCreate | AllowUpdate | AutoCheckIn'. Multiple import modes may be specified by using multiple instances of importMode.

Output

Output schema unknown

AssetDatabase_RemoveReferencedElement

Remove a reference to an existing element from the specified database.

osisoft.AssetDatabase_RemoveReferencedElement({
  "webId": "",
  "referencedElementWebId": []
}, context)

Input

• input object
  • webId required string: The ID of the database which the referenced element will be removed from.
  • referencedElementWebId required array: The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter.

Output

Output schema unknown

AssetDatabase_GetReferencedElements

Users can search for the referenced elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search.

osisoft.AssetDatabase_GetReferencedElements({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • categoryName string: Specify that returned elements must have this category. The default is no category filter.
  • descriptionFilter string: Specify that returned elements must have this description. The default is no description filter.
  • elementType string: Specify that returned elements must have this type. The default type is 'Any'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding objects. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

AssetDatabase_AddReferencedElement

Add a reference to an existing element to the specified database.

osisoft.AssetDatabase_AddReferencedElement({
  "webId": "",
  "referencedElementWebId": []
}, context)

Input

• input object
  • webId required string: The ID of the database which the referenced element will be added to.
  • referencedElementWebId required array: The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter.
  • referenceType string: The name of the reference type between the parent and the referenced element. This must be a "strong" reference type. The default is "parent-child".

Output

Output schema unknown

AssetDatabase_GetSecurity

Get the security information of the specified security item associated with the asset database for a specified user.

osisoft.AssetDatabase_GetSecurity({
  "webId": "",
  "securityItem": [],
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the asset database for the security to be checked.
  • securityItem required array: The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of the parameter. If the parameter is not specified, only 'Default' security item of the security information will be returned.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

AssetDatabase_GetSecurityEntries

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.

osisoft.AssetDatabase_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset database.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • securityItem string: The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

AssetDatabase_CreateSecurityEntry

Create a security entry owned by the asset database.

osisoft.AssetDatabase_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset database where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • securityItem string: The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default' security item will be created.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_DeleteSecurityEntry

Delete a security entry owned by the asset database.

osisoft.AssetDatabase_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the asset database where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • securityItem string: The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default' security item will be deleted.

Output

Output schema unknown

AssetDatabase_GetSecurityEntryByName

Retrieve the security entry of the specified security item associated with the asset database with the specified name.

osisoft.AssetDatabase_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the asset database.
  • securityItem string: The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

AssetDatabase_UpdateSecurityEntry

Update a security entry owned by the asset database.

osisoft.AssetDatabase_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the asset database where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • securityItem string: The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default' security item will be updated.

Output

Output schema unknown

AssetDatabase_GetTableCategories

Retrieve table categories for a given Asset Database.

osisoft.AssetDatabase_GetTableCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[TableCategory]

AssetDatabase_CreateTableCategory

Create a table category on the Asset Database.

osisoft.AssetDatabase_CreateTableCategory({
  "webId": "",
  "tableCategory": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the table category.
  • tableCategory required TableCategory
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetDatabase_GetTables

Retrieve tables for given Asset Database.

osisoft.AssetDatabase_GetTables({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the database.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Table]

AssetDatabase_CreateTable

Create a table on the Asset Database.

osisoft.AssetDatabase_CreateTable({
  "webId": "",
  "table": {}
}, context)

Input

• input object
  • webId required string: The ID of the database in which to create the table.
  • table required Table
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetServer_List

Retrieve a list of all Asset Servers known to this service.

osisoft.AssetServer_List({}, context)

Input

• input object
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AssetServer]

AssetServer_GetByName

This method returns an asset server based on the name associated with it. Users should primarily search with the WebID when available.

osisoft.AssetServer_GetByName({
  "name": ""
}, context)

Input

• input object
  • name required string: The name of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AssetServer

AssetServer_GetByPath

This 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 of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.AssetServer_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AssetServer

AssetServer_Get

Retrieve an Asset Server.

osisoft.AssetServer_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AssetServer

AssetServer_GetAnalysisRulePlugIns

Retrieve a list of all Analysis Rule Plug-in's.

osisoft.AssetServer_GetAnalysisRulePlugIns({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset server, where the Analysis Rule Plug-in's are installed.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisRulePlugIn]

AssetServer_GetDatabases

Retrieve a list of all Asset Databases on the specified Asset Server.

osisoft.AssetServer_GetDatabases({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AssetDatabase]

AssetServer_CreateAssetDatabase

Create an asset database.

osisoft.AssetServer_CreateAssetDatabase({
  "webId": "",
  "database": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset server on which to create the database.
  • database required AssetDatabase
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetServer_GetNotificationContactTemplates

Retrieve a list of all notification contact templates on the specified Asset Server.

osisoft.AssetServer_GetNotificationContactTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationContactTemplate]

AssetServer_CreateNotificationContactTemplate

Create a notification contact template.

osisoft.AssetServer_CreateNotificationContactTemplate({
  "webId": "",
  "notificationContactTemplate": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset server on which to create the notification contact template.
  • notificationContactTemplate required NotificationContactTemplate
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetServer_GetNotificationPlugIns

Retrieve a list of all notification plugins on the specified Asset Server.

osisoft.AssetServer_GetNotificationPlugIns({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationPlugIn]

AssetServer_GetSecurity

Get the security information of the specified security item associated with the asset server for a specified user.

osisoft.AssetServer_GetSecurity({
  "webId": "",
  "securityItem": [],
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the asset server for the security to be checked.
  • securityItem required array: The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of the parameter. If the parameter is not specified, only 'Default' security item of the security information will be returned.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

AssetServer_GetSecurityEntries

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.

osisoft.AssetServer_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset server.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • securityItem string: The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

AssetServer_CreateSecurityEntry

Create a security entry owned by the asset server.

osisoft.AssetServer_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset server where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • securityItem string: The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default' security item will be created.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetServer_DeleteSecurityEntry

Delete a security entry owned by the asset server.

osisoft.AssetServer_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the asset server where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • securityItem string: The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default' security item will be deleted.

Output

Output schema unknown

AssetServer_GetSecurityEntryByName

Retrieve the security entry of the specified security item associated with the asset server with the specified name.

osisoft.AssetServer_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the asset server.
  • securityItem string: The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

AssetServer_UpdateSecurityEntry

Update a security entry owned by the asset server.

osisoft.AssetServer_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the asset server where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • securityItem string: The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default' security item will be updated.

Output

Output schema unknown

AssetServer_GetSecurityIdentities

Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned.

osisoft.AssetServer_GetSecurityIdentities({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset server to search.
  • field string: Specifies which of the object's properties are searched. The default is 'Name'.
  • maxCount integer: The maximum number of objects to be returned. The default is 1000.
  • query string: The query string used for finding objects. The default is no query string.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityIdentity]

AssetServer_CreateSecurityIdentity

Create a security identity.

osisoft.AssetServer_CreateSecurityIdentity({
  "webId": "",
  "securityIdentity": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset server on which to create the security identity.
  • securityIdentity required SecurityIdentity
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetServer_GetSecurityIdentitiesForUser

Retrieve security identities for a specific user.

osisoft.AssetServer_GetSecurityIdentitiesForUser({
  "webId": "",
  "userIdentity": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • userIdentity required string: The user identity to search for.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityIdentity]

AssetServer_GetSecurityMappings

Retrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned.

osisoft.AssetServer_GetSecurityMappings({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset server to search.
  • field string: Specifies which of the object's properties are searched. The default is 'Name'.
  • maxCount integer: The maximum number of objects to be returned. The default is 1000.
  • query string: The query string used for finding objects. The default is no query string.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityMapping]

AssetServer_CreateSecurityMapping

Create a security mapping.

osisoft.AssetServer_CreateSecurityMapping({
  "webId": "",
  "securityMapping": {}
}, context)

Input

• input object
  • webId required string: The ID of the asset server on which to create the security mapping.
  • securityMapping required SecurityMapping
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AssetServer_GetTimeRulePlugIns

Retrieve a list of all Time Rule Plug-in's.

osisoft.AssetServer_GetTimeRulePlugIns({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the asset server, where the Time Rule Plug-in's are installed.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[TimeRulePlugIn]

AssetServer_GetUnitClasses

Retrieve a list of all unit classes on the specified Asset Server.

osisoft.AssetServer_GetUnitClasses({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[UnitClass]

AssetServer_CreateUnitClass

Create a unit class in the specified Asset Server.

osisoft.AssetServer_CreateUnitClass({
  "webId": "",
  "unitClass": {}
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • unitClass required UnitClass
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AttributeCategory_GetByPath

Retrieve an attribute category by path.

osisoft.AttributeCategory_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the target attribute category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AttributeCategory

AttributeCategory_Delete

Delete an attribute category.

osisoft.AttributeCategory_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute category to delete.

Output

Output schema unknown

AttributeCategory_Get

Retrieve an attribute category.

osisoft.AttributeCategory_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The id of the attribute category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AttributeCategory

AttributeCategory_Update

Update an attribute category by replacing items in its definition.

osisoft.AttributeCategory_Update({
  "webId": "",
  "category": {}
}, context)

Input

• input object
  • webId required string: The ID of the attribute category to update.
  • category required AttributeCategory

Output

Output schema unknown

AttributeCategory_GetSecurity

Get the security information of the specified security item associated with the attribute category for a specified user.

osisoft.AttributeCategory_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the attribute category for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

AttributeCategory_GetSecurityEntries

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.

osisoft.AttributeCategory_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute category.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

AttributeCategory_CreateSecurityEntry

Create a security entry owned by the attribute category.

osisoft.AttributeCategory_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the attribute category where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AttributeCategory_DeleteSecurityEntry

Delete a security entry owned by the attribute category.

osisoft.AttributeCategory_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the attribute category where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

AttributeCategory_GetSecurityEntryByName

Retrieve the security entry associated with the attribute category with the specified name.

osisoft.AttributeCategory_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the attribute category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

AttributeCategory_UpdateSecurityEntry

Update a security entry owned by the attribute category.

osisoft.AttributeCategory_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the attribute category where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Attribute_GetByPath

This 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 the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.Attribute_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the attribute.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Attribute

Attribute_GetMultiple

Retrieve multiple attributes by web id or path.

osisoft.Attribute_GetMultiple({}, context)

Input

• input object
  • asParallel boolean: Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • includeMode string: The include mode for the return list. The default is 'All'.
  • path array: The path of an attribute. Multiple attributes may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webId array: The ID of an attribute. Multiple attributes may be specified with multiple instances of the parameter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Item[Attribute]]

Attribute_GetAttributesQuery

Retrieve attributes based on the specified conditions. Returns attributes using the specified search query string.

osisoft.Attribute_GetAttributesQuery({}, context)

Input

• input object
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the attributes in the asset database. An example would be: "query=Element:{ Name:='MyElement' } Type:=Int32".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

Attribute_Delete

Delete an attribute.

osisoft.Attribute_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute.

Output

Output schema unknown

Attribute_Get

Retrieve an attribute.

osisoft.Attribute_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Attribute

Attribute_Update

If 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. Once a template is applied to an attribute, it can not be changed.

osisoft.Attribute_Update({
  "webId": "",
  "attribute": {}
}, context)

Input

• input object
  • webId required string: The ID of the attribute.
  • attribute required Attribute

Output

Output schema unknown

Attribute_GetAttributes

Get the child attributes of the specified attribute.

osisoft.Attribute_GetAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the parent attribute.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • categoryName string: Specify that returned attributes must have this category. The default is no category filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned attributes must be members of this template. The default is no template filter.
  • trait array: The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.
  • traitCategory array: The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is "all", then all attribute traits of all categories will be returned.
  • valueType string: Specify that returned attributes' value type must be the given value type. The default is no value type filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

Attribute_CreateAttribute

Create a new attribute as a child of the specified attribute.

osisoft.Attribute_CreateAttribute({
  "webId": "",
  "attribute": {}
}, context)

Input

• input object
  • webId required string: The ID of the parent attribute on which to create the attribute.
  • attribute required Attribute
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Attribute_GetCategories

Get an attribute's categories.

osisoft.Attribute_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AttributeCategory]

Attribute_CreateConfig

Create or update an attribute's DataReference configuration (Create/Update PI point for PI Point DataReference).

osisoft.Attribute_CreateConfig({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Attribute_GetValue

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.

osisoft.Attribute_GetValue({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.

Output

• output TimedValue

Attribute_SetValue

Users 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 expressed in the attribute, it will not work or it will return an error. Users should also be careful of what the value type means, for instance, if a value type accepts strings and the user enters a number, the attribute will interpret it as a string of characters and not as the integer value that the user may have wanted.

osisoft.Attribute_SetValue({
  "webId": "",
  "value": {}
}, context)

Input

• input object
  • webId required string: The ID of the attribute.
  • value required TimedValue

Output

Output schema unknown

AttributeTemplate_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.AttributeTemplate_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the attribute template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AttributeTemplate

AttributeTemplate_Delete

Deleting an attribute template will delete the attributes that were created based on the template

osisoft.AttributeTemplate_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute template.

Output

Output schema unknown

AttributeTemplate_Get

Retrieve an attribute template.

osisoft.AttributeTemplate_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output AttributeTemplate

AttributeTemplate_Update

Updating an attribute template will propagate changes to the attributes that were created based on the template

osisoft.AttributeTemplate_Update({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the attribute template.
  • template required AttributeTemplate

Output

Output schema unknown

AttributeTemplate_GetAttributeTemplates

Retrieve an attribute template's child attribute templates.

osisoft.AttributeTemplate_GetAttributeTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AttributeTemplate]

AttributeTemplate_CreateAttributeTemplate

Create an attribute template as a child of another attribute template.

osisoft.AttributeTemplate_CreateAttributeTemplate({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the parent attribute template on which to create the attribute template.
  • template required AttributeTemplate
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

AttributeTemplate_GetCategories

Get an attribute template's categories.

osisoft.AttributeTemplate_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the attribute template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AttributeCategory]

AttributeTrait_GetByCategory

Retrieve all attribute traits of the specified category/categories.

osisoft.AttributeTrait_GetByCategory({
  "category": []
}, context)

Input

• input object
  • category required array: The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is "all", then all attribute traits of all categories will be returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.

Output

• output Items[AttributeTrait]

AttributeTrait_Get

Retrieve an attribute trait.

osisoft.AttributeTrait_Get({
  "name": ""
}, context)

Input

• input object
  • name required string: The name or abbreviation of the attribute trait.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.

Output

• output AttributeTrait

Batch_Execute

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.

osisoft.Batch_Execute({
  "batch": {}
}, context)

Input

• input object
  • batch required object

Output

• output object

Calculation_GetAtIntervals

Returns results of evaluating the expression over the time range from the start time to the end time at a defined interval.

osisoft.Calculation_GetAtIntervals({
  "expression": ""
}, context)

Input

• input object
  • expression required string: A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • sampleInterval string: A time span specifies how often the filter expression is evaluated when computing the summary for an interval.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • webId string: The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

Output

• output TimedValues

Calculation_GetAtRecorded

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.

osisoft.Calculation_GetAtRecorded({
  "expression": ""
}, context)

Input

• input object
  • expression required string: A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • webId string: The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

Output

• output TimedValues

Calculation_GetSummary

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.

osisoft.Calculation_GetSummary({
  "expression": ""
}, context)

Input

• input object
  • expression required string: A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
  • calculationBasis string: Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • sampleInterval string: A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.
  • sampleType string: A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • summaryDuration string: The duration of each summary interval.
  • summaryType array: Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
  • timeType string: Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
  • webId string: The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

Output

• output Items[SummaryValue]

Calculation_GetAtTimes

Returns the result of evaluating the expression at the specified timestamps.

osisoft.Calculation_GetAtTimes({
  "expression": "",
  "time": []
}, context)

Input

• input object
  • expression required string: A string containing the expression to be evaluated. The syntax for the expression generally follows the Performance Equation syntax as described in the PI Server documentation, with the exception that expressions which target AF objects use attribute names in place of tag names in the equation.
  • time required array: A list of timestamps at which to calculate the expression.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • webId string: The ID of the target object of the expression. A target object can be a Data Server, a database, an element, an event frame or an attribute. References to attributes or points are based on the target. If this parameter is not provided, the target object is set to null.

Output

• output TimedValues

Channel_Instances

Retrieves a list of currently running channel instances.

osisoft.Channel_Instances(null, context)

Input

This action has no parameters

Output

• output Items[ChannelInstance]

DataServer_List

This 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 not have permission to access it.

osisoft.DataServer_List({}, context)

Input

• input object
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[DataServer]

DataServer_GetByName

This method returns a data server based on the name. Users should primarily search with the WebID when available.

osisoft.DataServer_GetByName({
  "name": ""
}, context)

Input

• input object
  • name required string: The name of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output DataServer

DataServer_GetByPath

This 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 the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.DataServer_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the server. Note that the path supplied to this method must be of the form '\servername'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output DataServer

DataServer_Get

Retrieve a Data Server.

osisoft.DataServer_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output DataServer

DataServer_GetEnumerationSets

Retrieve enumeration sets for given Data Server.

osisoft.DataServer_GetEnumerationSets({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EnumerationSet]

DataServer_CreateEnumerationSet

Create an enumeration set on the Data Server.

osisoft.DataServer_CreateEnumerationSet({
  "webId": "",
  "enumerationSet": {}
}, context)

Input

• input object
  • webId required string: The ID of the server on which to create the enumeration set.
  • enumerationSet required EnumerationSet
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

DataServer_GetLicense

Retrieves 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.

osisoft.DataServer_GetLicense({
  "webId": "",
  "module": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • module required string: The case-sensitive name of the module.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output DataServerLicense

DataServer_GetPoints

Users 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 will be used and will return the data servers that match the default search.

osisoft.DataServer_GetPoints({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: A query string for filtering by point name. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is '0'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Point]

DataServer_CreatePoint

Create a point in the specified Data Server.

osisoft.DataServer_CreatePoint({
  "webId": "",
  "pointDTO": {}
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • pointDTO required Point
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

ElementCategory_GetByPath

Retrieve an element category by path.

osisoft.ElementCategory_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the target element category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output ElementCategory

ElementCategory_Delete

Delete an element category.

osisoft.ElementCategory_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element category to delete.

Output

Output schema unknown

ElementCategory_Get

Retrieve an element category.

osisoft.ElementCategory_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The id of the element category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output ElementCategory

ElementCategory_Update

Update an element category by replacing items in its definition.

osisoft.ElementCategory_Update({
  "webId": "",
  "elementCategory": {}
}, context)

Input

• input object
  • webId required string: The ID of the element category to update.
  • elementCategory required ElementCategory

Output

Output schema unknown

ElementCategory_GetSecurity

Get the security information of the specified security item associated with the element category for a specified user.

osisoft.ElementCategory_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the element category for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

ElementCategory_GetSecurityEntries

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.

osisoft.ElementCategory_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element category.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

ElementCategory_CreateSecurityEntry

Create a security entry owned by the element category.

osisoft.ElementCategory_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the element category where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

ElementCategory_DeleteSecurityEntry

Delete a security entry owned by the element category.

osisoft.ElementCategory_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the element category where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

ElementCategory_GetSecurityEntryByName

Retrieve the security entry associated with the element category with the specified name.

osisoft.ElementCategory_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the element category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

ElementCategory_UpdateSecurityEntry

Update a security entry owned by the element category.

osisoft.ElementCategory_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the element category where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Element_GetByPath

This 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 PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.Element_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the element.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Element

Element_GetMultiple

Retrieve multiple elements by web id or path.

osisoft.Element_GetMultiple({}, context)

Input

• input object
  • asParallel boolean: Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • includeMode string: The include mode for the return list. The default is 'All'.
  • path array: The path of an element. Multiple elements may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webId array: The ID of an element. Multiple elements may be specified with multiple instances of the parameter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Item[Element]]

Element_GetElementsQuery

Retrieve elements based on the specified conditions. By default, returns all the elements.

osisoft.Element_GetElementsQuery({}, context)

Input

• input object
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the elements in the asset database. An example would be: "query=Name:=MyElement* Template:=ElementTemplate".
  • queryDate string: Optional parameter. Used to retrieve the relative the version of an object. A value of null or AFTime.MaxValue initializes the query date so the latest versions of sub-objects are retrieved. The value may be an AFTime, DateTime, PITime, String, or numeric. An integer numeric represents the number of ticks (100-nanosecond intervals) since January 1, 0001. A floating point numeric represents the number of seconds since January 1, 1970 UTC. A String is interpreted as local time, unless it contains a time zone indicator such as a trailing "Z" or "GMT".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

Element_CreateSearchByAttribute

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.

osisoft.Element_CreateSearchByAttribute({
  "query": {}
}, context)

Input

• input object
  • query required SearchByAttribute
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • noResults boolean: If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default is false.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

Element_ExecuteSearchByAttribute

Execute a "Search Elements By Attribute Value" operation.

osisoft.Element_ExecuteSearchByAttribute({
  "searchId": ""
}, context)

Input

• input object
  • searchId required string: The encoded search Id of the "Search Elements By Attribute Value" operation.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • categoryName string: Specify that the owner of the returned attributes must have this category. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • descriptionFilter string: The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • maxCount integer: The maximum number of objects to be returned. The default is 1000.
  • nameFilter string: The name query string used for finding objects. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

Element_Delete

Delete an element.

osisoft.Element_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.

Output

Output schema unknown

Element_Get

Retrieve an element.

osisoft.Element_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Element

Element_Update

Update an element by replacing items in its definition.

osisoft.Element_Update({
  "webId": "",
  "element": {}
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • element required Element

Output

Output schema unknown

Element_GetAnalyses

Users can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the analyses that match the default search.

osisoft.Element_GetAnalyses({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element, which is the Target of the analyses.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Analysis]

Element_CreateAnalysis

Create an Analysis.

osisoft.Element_CreateAnalysis({
  "webId": "",
  "analysis": {}
}, context)

Input

• input object
  • webId required string: The ID of the element on which to create the Analysis.
  • analysis required Analysis
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Element_GetAttributes

Get the attributes of the specified element.

osisoft.Element_GetAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • categoryName string: Specify that returned attributes must have this category. The default is no category filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned attributes must be members of this template. The default is no template filter.
  • trait array: The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.
  • traitCategory array: The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is "all", then all attribute traits of all categories will be returned.
  • valueType string: Specify that returned attributes' value type must be the given value type. The default is no value type filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

Element_CreateAttribute

Create a new attribute of the specified element.

osisoft.Element_CreateAttribute({
  "webId": "",
  "attribute": {}
}, context)

Input

• input object
  • webId required string: The ID of the element on which to create the attribute.
  • attribute required Attribute
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Element_GetCategories

Get an element's categories.

osisoft.Element_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementCategory]

Element_CreateConfig

Executes the create configuration function of the data references found within the attributes of the element, and optionally, its children.

osisoft.Element_CreateConfig({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • includeChildElements boolean: If true, includes the child elements of the specified element.

Output

Output schema unknown

Element_FindElementAttributes

Retrieves a list of element attributes matching the specified filters from the specified element.

osisoft.Element_FindElementAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • attributeCategory string: Specify that returned attributes must have this category. The default is no filter.
  • attributeDescriptionFilter string: The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • attributeNameFilter string: The attribute name filter string used for finding objects. The default is no filter.
  • attributeType string: Specify that returned attributes' value type must be this value type. The default is no filter.
  • elementCategory string: Specify that the owner of the returned attributes must have this category. The default is no filter.
  • elementDescriptionFilter string: The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • elementNameFilter string: The element name filter string used for finding objects. The default is no filter.
  • elementTemplate string: Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
  • elementType string: Specify that the element of the returned attributes must have this AFElementType. The default is no filter.
  • maxCount integer: The maximum number of objects to be returned (the page size). The default is 1000.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

Element_GetElements

Users can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search.

osisoft.Element_GetElements({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • categoryName string: Specify that returned elements must have this category. The default is no category filter.
  • descriptionFilter string: Specify that returned elements must have this description. The default is no description filter.
  • elementType string: Specify that returned elements must have this type. The default type is 'Any'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding objects. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than the immediate children of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

Element_CreateElement

Create a child element.

osisoft.Element_CreateElement({
  "webId": "",
  "element": {}
}, context)

Input

• input object
  • webId required string: The ID of the parent element on which to create the element.
  • element required Element
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Element_GetEventFrames

Retrieve 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.

osisoft.Element_GetEventFrames({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element whose related event frames are sought.
  • canBeAcknowledged boolean: Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
  • categoryName string: Specify that returned event frames must have this category. The default is no category filter.
  • endTime string: The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '' if searchMode is not one of the 'Backward' or 'Forward*' values.
  • isAcknowledged boolean: Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding event frames. The default is no filter.
  • searchMode string: Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • severity array: Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • startTime string: The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
  • templateName string: Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EventFrame]

Element_GetNotificationRules

Retrieve notification rules for an element

osisoft.Element_GetNotificationRules({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRule]

Element_CreateNotificationRule

Create a notification rule.

osisoft.Element_CreateNotificationRule({
  "webId": "",
  "notificationRule": {}
}, context)

Input

• input object
  • webId required string: The ID of the element on which to create the notification rule.
  • notificationRule required NotificationRule
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Element_GetPaths

This 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 specified but does not exist, null will be returned at the first index.

osisoft.Element_GetPaths({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • relativePath string: The full path in ShortName format to the parent object that the returned paths should be relative. For example, "\Server1\Database2" would return all the paths to the element relative to the database. A path of "\Server1\Database2\RootElement" would return all paths to the element relative to "RootElement". If null, then all the full paths to the element will be returned.

Output

• output Items[string]

Element_RemoveReferencedElement

Remove a reference to an existing element from the child elements collection.

osisoft.Element_RemoveReferencedElement({
  "webId": "",
  "referencedElementWebId": []
}, context)

Input

• input object
  • webId required string: The ID of the element which the referenced element will be removed from.
  • referencedElementWebId required array: The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter.

Output

Output schema unknown

Element_GetReferencedElements

Users can search for the referenced elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search.

osisoft.Element_GetReferencedElements({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • categoryName string: Specify that returned elements must have this category. The default is no category filter.
  • descriptionFilter string: Specify that returned elements must have this description. The default is no description filter.
  • elementType string: Specify that returned elements must have this type. The default type is 'Any'.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding objects. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned elements must have this template or a template derived from this template. The default is no template filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

Element_AddReferencedElement

Add a reference to an existing element to the child elements collection.

osisoft.Element_AddReferencedElement({
  "webId": "",
  "referencedElementWebId": []
}, context)

Input

• input object
  • webId required string: The ID of the element which the referenced element will be added to.
  • referencedElementWebId required array: The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter.
  • referenceType string: The name of the reference type between the parent and the referenced element. The default is "parent-child".

Output

Output schema unknown

Element_GetSecurity

Get the security information of the specified security item associated with the element for a specified user.

osisoft.Element_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the element for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

Element_GetSecurityEntries

Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned.

osisoft.Element_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

Element_CreateSecurityEntry

Create a security entry owned by the element.

osisoft.Element_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the element where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Element_DeleteSecurityEntry

Delete a security entry owned by the element.

osisoft.Element_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the element where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Element_GetSecurityEntryByName

Retrieve the security entry associated with the element with the specified name.

osisoft.Element_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the element.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

Element_UpdateSecurityEntry

Update a security entry owned by the element.

osisoft.Element_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the element where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

ElementTemplate_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.ElementTemplate_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the element template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output ElementTemplate

ElementTemplate_Delete

Deleting an element template will delete all associated templated data from elements which were created from it.

osisoft.ElementTemplate_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template to update.

Output

Output schema unknown

ElementTemplate_Get

Retrieve an element template.

osisoft.ElementTemplate_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output ElementTemplate

ElementTemplate_Update

Updating the InstanceType property of an element template will not affect any elements that have already been created from this template; it will only affect any future elements created from this template. All other changes will be propagated to elements based on this template.

osisoft.ElementTemplate_Update({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the element template to update.
  • template required ElementTemplate

Output

Output schema unknown

ElementTemplate_GetAnalysisTemplates

Get analysis templates for an element template.

osisoft.ElementTemplate_GetAnalysisTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AnalysisTemplate]

ElementTemplate_GetAttributeTemplates

If 'showInherited' and 'showDescendants' are 'true', it returns all the attribute templates from current element template and the base template. If 'showInherited' is 'false', it returns all the attribute templates from the current element template.

osisoft.ElementTemplate_GetAttributeTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • depthFirstTraverse boolean: When 'true', a Depth First traversal will be performed; this starts at the root and explores as far as possible along each branch before backtracking. When 'false', a Breadth First traversal will be performed; this starts at the tree root and explores the neighbor nodes first, then moves onto the next level of neighbors. The default is 'false' (Breadth First).
  • maxCount integer: The maximum number of objects to be returned. The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showDescendants boolean: Specifies if the result should include all descendant attribute templates from the current element template, even indirect ones. The default is 'false'.
  • showInherited boolean: Specifies if the result should include attribute templates inherited from base element templates. The default is 'false'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[AttributeTemplate]

ElementTemplate_CreateAttributeTemplate

Create an attribute template.

osisoft.ElementTemplate_CreateAttributeTemplate({
  "webId": "",
  "template": {}
}, context)

Input

• input object
  • webId required string: The ID of the element template on which to create the attribute template.
  • template required AttributeTemplate
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

ElementTemplate_GetBaseElementTemplates

The root template will be returned first, followed by successive templates in the inheritance chain.

osisoft.ElementTemplate_GetBaseElementTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • maxCount integer: The maximum number of objects to be returned. The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementTemplate]

ElementTemplate_GetCategories

Get an element template's categories.

osisoft.ElementTemplate_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showInherited boolean: Specifies if the result should include categories inherited from base element templates. The default is 'false'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementCategory]

ElementTemplate_GetDerivedElementTemplates

Get derived element templates for an element template.

osisoft.ElementTemplate_GetDerivedElementTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • maxCount integer: The maximum number of objects to be returned. The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showDescendants boolean: Specifies if the result should include all descendant element templates from the current element template, even indirect ones. The default is 'false'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementTemplate]

ElementTemplate_GetNotificationRuleTemplates

Get notification rule templates for an element template

osisoft.ElementTemplate_GetNotificationRuleTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRuleTemplate]

ElementTemplate_CreateNotificationRuleTemplate

Create a notification rule template.

osisoft.ElementTemplate_CreateNotificationRuleTemplate({
  "webId": "",
  "notificationRuleTemplate": {}
}, context)

Input

• input object
  • webId required string: The ID of the element on which to create the notification rule template.
  • notificationRuleTemplate required NotificationRuleTemplate
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

ElementTemplate_GetSecurity

Get the security information of the specified security item associated with the element template for a specified user.

osisoft.ElementTemplate_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the element template for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

ElementTemplate_GetSecurityEntries

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.

osisoft.ElementTemplate_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the element template.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

ElementTemplate_CreateSecurityEntry

Create a security entry owned by the element template.

osisoft.ElementTemplate_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the element template where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

ElementTemplate_DeleteSecurityEntry

Delete a security entry owned by the element template.

osisoft.ElementTemplate_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the element template where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

ElementTemplate_GetSecurityEntryByName

Retrieve the security entry associated with the element template with the specified name.

osisoft.ElementTemplate_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the element template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

ElementTemplate_UpdateSecurityEntry

Update a security entry owned by the element template.

osisoft.ElementTemplate_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the element template where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

EnumerationSet_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.EnumerationSet_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the target enumeration set.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output EnumerationSet

EnumerationSet_Delete

Delete an enumeration set.

osisoft.EnumerationSet_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set to delete.

Output

Output schema unknown

EnumerationSet_Get

Retrieve an enumeration set.

osisoft.EnumerationSet_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output EnumerationSet

EnumerationSet_Update

Update an enumeration set by replacing items in its definition.

osisoft.EnumerationSet_Update({
  "webId": "",
  "enumerationSet": {}
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set to update.
  • enumerationSet required EnumerationSet

Output

Output schema unknown

EnumerationSet_GetValues

Retrieve an enumeration set's values.

osisoft.EnumerationSet_GetValues({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EnumerationValue]

EnumerationSet_CreateValue

Create an enumeration value for a enumeration set.

osisoft.EnumerationSet_CreateValue({
  "webId": "",
  "enumerationValue": {}
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set on which to create the enumeration value.
  • enumerationValue required EnumerationValue
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

EnumerationSet_GetSecurity

Get the security information of the specified security item associated with the enumeration set for a specified user.

osisoft.EnumerationSet_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

EnumerationSet_GetSecurityEntries

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.

osisoft.EnumerationSet_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

EnumerationSet_CreateSecurityEntry

Create a security entry owned by the enumeration set.

osisoft.EnumerationSet_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the enumeration set where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

EnumerationSet_DeleteSecurityEntry

Delete a security entry owned by the enumeration set.

osisoft.EnumerationSet_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the enumeration set where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

EnumerationSet_GetSecurityEntryByName

Retrieve the security entry associated with the enumeration set with the specified name.

osisoft.EnumerationSet_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the enumeration set.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

EnumerationSet_UpdateSecurityEntry

Update a security entry owned by the enumeration set.

osisoft.EnumerationSet_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the enumeration set where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

EnumerationValue_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.EnumerationValue_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the target enumeration value.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output EnumerationValue

EnumerationValue_DeleteEnumerationValue

Deleting a value will remove it from the enumeration set along with any value references within the PI Web API system.

osisoft.EnumerationValue_DeleteEnumerationValue({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the enumeration value.

Output

Output schema unknown

EnumerationValue_Get

Retrieve an enumeration value mapping

osisoft.EnumerationValue_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the enumeration value.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output EnumerationValue

EnumerationValue_UpdateEnumerationValue

Update an enumeration value by replacing items in its definition.

osisoft.EnumerationValue_UpdateEnumerationValue({
  "webId": "",
  "enumerationValue": {}
}, context)

Input

• input object
  • webId required string: The ID of the enumeration value to update.
  • enumerationValue required EnumerationValue

Output

Output schema unknown

EventFrame_GetByPath

This 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 the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.EventFrame_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output EventFrame

EventFrame_GetMultiple

Retrieve multiple event frames by web ids or paths.

osisoft.EventFrame_GetMultiple({}, context)

Input

• input object
  • asParallel boolean: Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.
  • includeMode string: The include mode for the return list. The default is 'All'.
  • path array: The path of an event frame. Multiple event frames may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webId array: The ID of an event frame. Multiple event frames may be specified with multiple instances of the parameter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Item[EventFrame]]

EventFrame_GetEventFramesQuery

Retrieve event frames based on the specified conditions. Returns event frames using the specified search query string.

osisoft.EventFrame_GetEventFramesQuery({}, context)

Input

• input object
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the eventframes in the asset database. An example would be: "query=Name:=MyEventFrame* Category:=MyCategory Template:=EFTemplate".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EventFrame]

EventFrame_CreateSearchByAttribute

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.

osisoft.EventFrame_CreateSearchByAttribute({
  "query": {}
}, context)

Input

• input object
  • query required SearchByAttribute
  • noResults boolean: If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default is false.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EventFrame]

EventFrame_ExecuteSearchByAttribute

Execute a "Search EventFrames By Attribute Value" operation.

osisoft.EventFrame_ExecuteSearchByAttribute({
  "searchId": ""
}, context)

Input

• input object
  • searchId required string: The encoded search Id of the "Search EventFrames By Attribute Value" operation.
  • canBeAcknowledged boolean: Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
  • endTime string: The ending time for the search. endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*'.
  • isAcknowledged boolean: Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding event frames. The default is no filter.
  • referencedElementNameFilter string: The name query string which must match the name of a referenced element. The default is no filter.
  • searchFullHierarchy boolean: Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.
  • searchMode string: Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. The default is 'Overlapped'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • severity array: Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • startTime string: The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EventFrame]

EventFrame_Delete

Delete an event frame.

osisoft.EventFrame_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame to delete.

Output

Output schema unknown

EventFrame_Get

Retrieve an event frame.

osisoft.EventFrame_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output EventFrame

EventFrame_Update

Update an event frame by replacing items in its definition.

osisoft.EventFrame_Update({
  "webId": "",
  "eventFrame": {}
}, context)

Input

• input object
  • webId required string: The ID of the event frame to update.
  • eventFrame required EventFrame

Output

Output schema unknown

EventFrame_Acknowledge

Calls the EventFrame's Acknowledge method.

osisoft.EventFrame_Acknowledge({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.

Output

Output schema unknown

EventFrame_GetAnnotations

Get an event frame's annotations.

osisoft.EventFrame_GetAnnotations({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the owner event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Annotation]

EventFrame_CreateAnnotation

Create an annotation on an event frame.

osisoft.EventFrame_CreateAnnotation({
  "webId": "",
  "annotation": {}
}, context)

Input

• input object
  • webId required string: The ID of the owner event frame on which to create the annotation.
  • annotation required Annotation
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

EventFrame_DeleteAnnotation

Delete an annotation on an event frame. If the annotation has attached media, the attached media will also be deleted.

osisoft.EventFrame_DeleteAnnotation({
  "id": "",
  "webId": ""
}, context)

Input

• input object
  • id required string: The Annotation identifier of the annotation to be deleted.
  • webId required string: The ID of the owner event frame of the annotation to delete.

Output

Output schema unknown

EventFrame_GetAnnotationById

Get a specific annotation on an event frame.

osisoft.EventFrame_GetAnnotationById({
  "id": "",
  "webId": ""
}, context)

Input

• input object
  • id required string: The Annotation identifier of the specific annotation.
  • webId required string: The ID of the owner event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Annotation

EventFrame_UpdateAnnotation

Update an annotation on an event frame by replacing items in its definition.

osisoft.EventFrame_UpdateAnnotation({
  "id": "",
  "webId": "",
  "annotation": {}
}, context)

Input

• input object
  • id required string: The Annotation identifier of the annotation to be updated.
  • webId required string: The ID of the owner event frame of the annotation to update.
  • annotation required Annotation

Output

Output schema unknown

EventFrame_DeleteAnnotationAttachmentMediaById

Delete attached media from an annotation on an event frame.

osisoft.EventFrame_DeleteAnnotationAttachmentMediaById({
  "id": "",
  "webId": ""
}, context)

Input

• input object
  • id required string: The Annotation identifier of the annotation to delete the attached media of.
  • webId required string: The ID of the owner event frame of the annotation to delete the attached media of.

Output

Output schema unknown

EventFrame_GetAnnotationAttachmentMediaMetadataById

Gets the metadata of the media attached to the specified annotation.

osisoft.EventFrame_GetAnnotationAttachmentMediaMetadataById({
  "id": "",
  "webId": ""
}, context)

Input

• input object
  • id required string: The Annotation identifier of the specific annotation.
  • webId required string: The ID of the owner event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output MediaMetadata

EventFrame_GetAttributes

Get the attributes of the specified event frame.

osisoft.EventFrame_GetAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • categoryName string: Specify that returned attributes must have this category. The default is no category filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • templateName string: Specify that returned attributes must be members of this template. The default is no template filter.
  • trait array: The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.
  • traitCategory array: The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is "all", then all attribute traits of all categories will be returned.
  • valueType string: Specify that returned attributes' value type must be the given value type. The default is no value type filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

EventFrame_CreateAttribute

Create a new attribute of the specified event frame.

osisoft.EventFrame_CreateAttribute({
  "webId": "",
  "attribute": {}
}, context)

Input

• input object
  • webId required string: The ID of the event frame on which to create the attribute.
  • attribute required Attribute
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

EventFrame_CaptureValues

Calls the EventFrame's CaptureValues method.

osisoft.EventFrame_CaptureValues({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.

Output

Output schema unknown

EventFrame_GetCategories

Get an event frame's categories.

osisoft.EventFrame_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[ElementCategory]

EventFrame_CreateConfig

Executes the create configuration function of the data references found within the attributes of the event frame, and optionally, its children.

osisoft.EventFrame_CreateConfig({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.
  • includeChildElements boolean: If true, includes the child event frames of the specified event frame.

Output

Output schema unknown

EventFrame_FindEventFrameAttributes

Retrieves a list of event frame attributes matching the specified filters from the specified event frame.

osisoft.EventFrame_FindEventFrameAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame to use as the root of the search.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned.
  • attributeCategory string: Specify that returned attributes must have this category. The default is no filter.
  • attributeDescriptionFilter string: The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • attributeNameFilter string: The attribute name filter string used for finding objects. The default is no filter.
  • attributeType string: Specify that returned attributes' value type must be this value type. The default is no filter.
  • endTime string: A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the startTime. The default is '*'.
  • eventFrameCategory string: Specify that the owner of the returned attributes must have this category. The default is no filter.
  • eventFrameDescriptionFilter string: The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter.
  • eventFrameNameFilter string: The event frame name filter string used for finding objects. The default is no filter.
  • eventFrameTemplate string: Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter.
  • maxCount integer: The maximum number of objects to be returned (the page size). The default is 1000.
  • referencedElementNameFilter string: The name query string which must match the name of a referenced element. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'.
  • searchMode string: Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • startTime string: A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime. The default is '*-8h'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Attribute]

EventFrame_GetEventFrames

Retrieve 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.

osisoft.EventFrame_GetEventFrames({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame to use as the root of the search.
  • canBeAcknowledged boolean: Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.
  • categoryName string: Specify that returned event frames must have this category. The default is no category filter.
  • endTime string: The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '' if searchMode is not one of the 'Backward' or 'Forward*' values.
  • isAcknowledged boolean: Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • nameFilter string: The name query string used for finding event frames. The default is no filter.
  • referencedElementNameFilter string: The name query string which must match the name of a referenced element. The default is no filter.
  • referencedElementTemplateName string: Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the template. Specify this parameter by name.
  • searchFullHierarchy boolean: Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.
  • searchMode string: Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • severity array: Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter.
  • sortField string: The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • startTime string: The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'.
  • templateName string: Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[EventFrame]

EventFrame_CreateEventFrame

Create an event frame as a child of the specified event frame.

osisoft.EventFrame_CreateEventFrame({
  "webId": "",
  "eventFrame": {}
}, context)

Input

• input object
  • webId required string: The ID of the parent event frame on which to create the event frame.
  • eventFrame required EventFrame
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

EventFrame_GetReferencedElements

Retrieve the event frame's referenced elements.

osisoft.EventFrame_GetReferencedElements({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame whose referenced elements should be retrieved.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Element]

EventFrame_GetSecurity

Get the security information of the specified security item associated with the event frame for a specified user.

osisoft.EventFrame_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the event frame for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

EventFrame_GetSecurityEntries

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.

osisoft.EventFrame_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the event frame.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

EventFrame_CreateSecurityEntry

Create a security entry owned by the event frame.

osisoft.EventFrame_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the event frame where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

EventFrame_DeleteSecurityEntry

Delete a security entry owned by the event frame.

osisoft.EventFrame_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the event frame where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

EventFrame_GetSecurityEntryByName

Retrieve the security entry associated with the event frame with the specified name.

osisoft.EventFrame_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the event frame.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

EventFrame_UpdateSecurityEntry

Update a security entry owned by the event frame.

osisoft.EventFrame_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the event frame where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

NotificationContactTemplate_GetByPath

Retrieve a notification contact template by path.

osisoft.NotificationContactTemplate_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the notification contact template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationContactTemplate

NotificationContactTemplate_GetNotificationContactTemplatesQuery

Retrieve notification contact templates based on the specified conditions. Returns notification contact templates using the specified search query string.

osisoft.NotificationContactTemplate_GetNotificationContactTemplatesQuery({}, context)

Input

• input object
  • assetServerWebId string: The ID of the asset server to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the Notification Contact Templates in the asset database. An example would be: "query=Name:='MyNotificationContactTemplate'".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationContactTemplate]

NotificationContactTemplate_Delete

Delete a notification contact template.

osisoft.NotificationContactTemplate_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template to be deleted.

Output

Output schema unknown

NotificationContactTemplate_Get

Retrieve a notification contact template.

osisoft.NotificationContactTemplate_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationContactTemplate

NotificationContactTemplate_Update

Update a notification contact template by replacing items in its definition.

osisoft.NotificationContactTemplate_Update({
  "webId": "",
  "notificationContactTemplate": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template to update.
  • notificationContactTemplate required NotificationContactTemplate

Output

Output schema unknown

NotificationContactTemplate_GetNotificationContactTemplates

Retrieve notification contact template's child templates.

osisoft.NotificationContactTemplate_GetNotificationContactTemplates({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationContactTemplate

NotificationContactTemplate_GetSecurity

Get the security information of the specified security item associated with the notification contact template for a specified user.

osisoft.NotificationContactTemplate_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

NotificationContactTemplate_GetSecurityEntries

Retrieve 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.

osisoft.NotificationContactTemplate_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

NotificationContactTemplate_CreateSecurityEntry

Create a security entry owned by the notification contact template.

osisoft.NotificationContactTemplate_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification contact template, where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

NotificationContactTemplate_DeleteSecurityEntry

Delete a security entry owned by the notification contact template.

osisoft.NotificationContactTemplate_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the notification contact template, where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

NotificationContactTemplate_GetSecurityEntryByName

Retrieve the security entry associated with the notification contact template with the specified name.

osisoft.NotificationContactTemplate_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the notification contact template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

NotificationContactTemplate_UpdateSecurityEntry

Update a security entry owned by the notification contact template.

osisoft.NotificationContactTemplate_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the notification contact template, where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

NotificationPlugIn_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.NotificationPlugIn_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the notification plugin.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationPlugIn

NotificationPlugIn_Get

Retrieve a notification plugin.

osisoft.NotificationPlugIn_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification plugin.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationPlugIn

NotificationRule_GetByPath

This 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 part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.NotificationRule_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the notification rule.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationRule

NotificationRule_GetNotificationRulesQuery

Retrieve notification rules based on the specified conditions. Returns notification rules using the specified search query string.

osisoft.NotificationRule_GetNotificationRulesQuery({}, context)

Input

• input object
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the Notification rules in the asset database. An example would be: "query=Name:=MyNotificationRule* Template:=NoteRuleTemplate".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRule]

NotificationRule_Delete

Delete a notification rule.

osisoft.NotificationRule_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification rule.

Output

Output schema unknown

NotificationRule_Get

Retrieve a notification rule.

osisoft.NotificationRule_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationRule

NotificationRule_Update

Update a notification rule by replacing items in its definition.

osisoft.NotificationRule_Update({
  "webId": "",
  "notificationRule": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule to update.
  • notificationRule required NotificationRule

Output

Output schema unknown

NotificationRule_GetNotificationRuleSubscribers

Retrieve notification rule subscribers.

osisoft.NotificationRule_GetNotificationRuleSubscribers({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRuleSubscriber]

NotificationRule_CreateNotificationRuleSubscriber

Create a notification rule subscriber.

osisoft.NotificationRule_CreateNotificationRuleSubscriber({
  "webId": "",
  "notificationRuleSubscriber": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule on which to create the notification rule subscriber.
  • notificationRuleSubscriber required NotificationRuleSubscriber
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

NotificationRule_GetSecurity

Get the security information of the specified security item associated with the notification rule for a specified user.

osisoft.NotificationRule_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the notification rule for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

NotificationRule_GetSecurityEntries

Retrieve the security entries associated with the notification rule based on the specified criteria. By default, all security entries for this notification rule are returned.

osisoft.NotificationRule_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification rule.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

NotificationRule_CreateSecurityEntry

Create a security entry owned by the notification rule.

osisoft.NotificationRule_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule, where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

NotificationRule_DeleteSecurityEntry

Delete a security entry owned by the notification rule.

osisoft.NotificationRule_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the notification rule, where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

NotificationRule_GetSecurityEntryByName

Retrieve the security entry associated with the notification rule with the specified name.

osisoft.NotificationRule_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the notification rule.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

NotificationRule_UpdateSecurityEntry

Update a security entry owned by the notification rule.

osisoft.NotificationRule_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the notification rule, where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

NotificationRuleSubscriber_GetByPath

This 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 separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.NotificationRuleSubscriber_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the notification rule subscriber.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationRuleSubscriber

NotificationRuleSubscriber_Delete

Delete a notification rule subscriber.

osisoft.NotificationRuleSubscriber_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification rule subscriber.

Output

Output schema unknown

NotificationRuleSubscriber_Get

Retrieve a notification rule subscriber.

osisoft.NotificationRuleSubscriber_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationRuleSubscriber

NotificationRuleSubscriber_Update

Update a notification rule subscriber.

osisoft.NotificationRuleSubscriber_Update({
  "webId": "",
  "notificationRuleSubscriber": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule subscriber.
  • notificationRuleSubscriber required NotificationRuleSubscriber

Output

Output schema unknown

NotificationRuleSubscriber_GetNotificationRuleSubscribers

Retrieve notification rule subscriber subscribers.

osisoft.NotificationRuleSubscriber_GetNotificationRuleSubscribers({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRuleSubscriber]

NotificationRuleTemplate_GetByPath

This 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 separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.NotificationRuleTemplate_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the notification rule template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationRuleTemplate

NotificationRuleTemplate_GetNotificationRuleTemplatesQuery

Retrieve Notification rule templates based on the specified conditions. Returns Notification rule templates using the specified search query string.

osisoft.NotificationRuleTemplate_GetNotificationRuleTemplatesQuery({}, context)

Input

• input object
  • databaseWebId string: The ID of the asset database to use as the root of the query.
  • maxCount integer: The maximum number of objects to be returned per call (page size). The default is 1000.
  • query string: The query string is a list of filters used to perform an AFSearch for the Notification rule templates in the asset database. An example would be: "query=NotificationRuleTemplate:{ Name:='MyNotificationRuleTemplate' } Type:=Int32".
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startIndex integer: The starting index (zero based) of the items to be returned. The default is 0.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRuleTemplate]

NotificationRuleTemplate_Delete

Delete a notification rule template.

osisoft.NotificationRuleTemplate_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template.

Output

Output schema unknown

NotificationRuleTemplate_Get

Get the specified notification rule template.

osisoft.NotificationRuleTemplate_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output NotificationRuleTemplate

NotificationRuleTemplate_Update

Update a notification rule template by replacing items in its definition.

osisoft.NotificationRuleTemplate_Update({
  "webId": "",
  "notificationRuleTemplate": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template to update.
  • notificationRuleTemplate required NotificationRuleTemplate

Output

Output schema unknown

NotificationRuleTemplate_GetNotificationRuleTemplateSubscribers

Retrieve notification rule template subscribers.

osisoft.NotificationRuleTemplate_GetNotificationRuleTemplateSubscribers({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the resource to use as the root of the search.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[NotificationRuleSubscriber]

NotificationRuleTemplate_CreateNotificationRuleTemplateSubscriber

Create a notification rule subscriber.

osisoft.NotificationRuleTemplate_CreateNotificationRuleTemplateSubscriber({
  "webId": "",
  "notificationRuleSubscriber": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template on which to create the notification rule subscriber.
  • notificationRuleSubscriber required NotificationRuleSubscriber
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

NotificationRuleTemplate_GetSecurity

Get the security information of the specified security item associated with the notification rule template for a specified user.

osisoft.NotificationRuleTemplate_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

NotificationRuleTemplate_GetSecurityEntries

Retrieve 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.

osisoft.NotificationRuleTemplate_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

NotificationRuleTemplate_CreateSecurityEntry

Create a security entry owned by the notification rule template.

osisoft.NotificationRuleTemplate_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the notification rule template, where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

NotificationRuleTemplate_DeleteSecurityEntry

Delete a security entry owned by the notification rule template.

osisoft.NotificationRuleTemplate_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the notification rule template, where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

NotificationRuleTemplate_GetSecurityEntryByName

Retrieve the security entry associated with the notification rule template with the specified name.

osisoft.NotificationRuleTemplate_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the notification rule template.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

NotificationRuleTemplate_UpdateSecurityEntry

Update a security entry owned by the notification rule template.

osisoft.NotificationRuleTemplate_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the notification rule template, where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Point_GetByPath

This method returns a PI Point based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.Point_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the point.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Point

Point_GetMultiple

Retrieve multiple points by web id or path.

osisoft.Point_GetMultiple({}, context)

Input

• input object
  • asParallel boolean: Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested points. The default is 'false'.
  • includeMode string: The include mode for the return list. The default is 'All'.
  • path array: The path of a point. Multiple points may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webId array: The ID of a point. Multiple points may be specified with multiple instances of the parameter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[Item[Point]]

Point_Delete

Delete a point.

osisoft.Point_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the point.

Output

Output schema unknown

Point_Get

Get a point.

osisoft.Point_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the point.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Point

Point_Update

Update a point. The only PI Point attributes that can be updated include: Name, Descriptor, EngineeringUnits, Step, and DisplayDigits. Other PI Point attributes cannot be updated through PI Web API.

osisoft.Point_Update({
  "webId": "",
  "pointDTO": {}
}, context)

Input

• input object
  • webId required string: The ID of the point.
  • pointDTO required Point

Output

Output schema unknown

Point_GetAttributes

Get point attributes.

osisoft.Point_GetAttributes({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the point.
  • name array: The name of a point attribute to be returned. Multiple attributes may be specified with multiple instances of the parameter.
  • nameFilter string: The filter to the names of the list of point attributes to be returned. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[PointAttribute]

Point_GetAttributeByName

Get a point attribute by name.

osisoft.Point_GetAttributeByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the attribute.
  • webId required string: The ID of the point.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output PointAttribute

SecurityIdentity_GetByPath

This method returns a security identity based on the path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.SecurityIdentity_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the security identity.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityIdentity

SecurityIdentity_Delete

Delete a security identity.

osisoft.SecurityIdentity_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security identity.

Output

Output schema unknown

SecurityIdentity_Get

Retrieve a security identity.

osisoft.SecurityIdentity_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security identity.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityIdentity

SecurityIdentity_Update

Update a security identity by replacing items in its definition.

osisoft.SecurityIdentity_Update({
  "webId": "",
  "securityIdentity": {}
}, context)

Input

• input object
  • webId required string: The ID of the security identity.
  • securityIdentity required SecurityIdentity

Output

Output schema unknown

SecurityIdentity_GetSecurity

Get the security information of the specified security item associated with the security identity for a specified user.

osisoft.SecurityIdentity_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the security identity for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

SecurityIdentity_GetSecurityEntries

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.

osisoft.SecurityIdentity_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security identity.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

SecurityIdentity_GetSecurityEntryByName

Retrieve the security entry associated with the security identity with the specified name.

osisoft.SecurityIdentity_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the security identity.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

SecurityIdentity_GetSecurityMappings

Get security mappings for the specified security identity.

osisoft.SecurityIdentity_GetSecurityMappings({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security identity.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityMapping]

SecurityMapping_GetByPath

This method returns a security mapping based on the path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.SecurityMapping_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the security mapping.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityMapping

SecurityMapping_Delete

Delete a security mapping.

osisoft.SecurityMapping_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security mapping.

Output

Output schema unknown

SecurityMapping_Get

Retrieve a security mapping.

osisoft.SecurityMapping_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security mapping.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityMapping

SecurityMapping_Update

Update a security mapping by replacing items in its definition.

osisoft.SecurityMapping_Update({
  "webId": "",
  "securityMapping": {}
}, context)

Input

• input object
  • webId required string: The ID of the security mapping.
  • securityMapping required SecurityMapping

Output

Output schema unknown

SecurityMapping_GetSecurity

Get the security information of the specified security item associated with the security mapping for a specified user.

osisoft.SecurityMapping_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the security mapping for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

SecurityMapping_GetSecurityEntries

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.

osisoft.SecurityMapping_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the security mapping.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

SecurityMapping_GetSecurityEntryByName

Retrieve the security entry associated with the security mapping with the specified name.

osisoft.SecurityMapping_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the security mapping.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

Stream_RetrieveStreamUpdate

The supplied marker will identify the set of stream updates to retrieve. For a 200 response, the returned location header will contain the url for retrieving the stream updates.

osisoft.Stream_RetrieveStreamUpdate({
  "marker": ""
}, context)

Input

• input object
  • marker required string: Identifier of stream source and current position
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output StreamUpdatesRetrieve

Stream_GetChannel

Opens a channel that will send messages about any value changes for the specified stream.

osisoft.Stream_GetChannel({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • heartbeatRate integer: HeartbeatRate is an integer multiple of the Polling Interval. It specifies the rate at which a client will receive an empty message if there are no data updates. It can be used to check that the connection is still alive. Zero/negative values correspond to no heartbeat. By default, no empty messages will be sent to the user.
  • includeInitialValues boolean: Specified if the channel should send a message with the current value of the stream after the connection is opened. The default is 'false'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

Stream_GetEnd

Returns the end-of-stream value of the stream.

osisoft.Stream_GetEnd({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.

Output

• output TimedValue

Stream_GetInterpolated

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.Stream_GetInterpolated({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • interval string: The sampling interval, in AFTimeSpan format.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • syncTime string: An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.
  • syncTimeBoundaryType string: An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output TimedValues

Stream_GetInterpolatedAtTimes

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.Stream_GetInterpolatedAtTimes({
  "webId": "",
  "time": []
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • time required array: The timestamp at which to retrieve an interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output TimedValues

Stream_GetPlot

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.Stream_GetPlot({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • intervals integer: The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output TimedValues

Stream_GetRecorded

Returned times are affected by the specified boundary type. If no values are found for the time range and conditions specified then the HTTP response will be success, with a body containing an empty array of Items. When specifying true for the includeFilteredValues parameter, consecutive filtered events are not returned. The first value that would be filtered out is returned with its time and the enumeration value "Filtered". The next value in the collection will be the next compressed value in the specified direction that passes the filter criteria - if any. When both boundaryType and a filterExpression are specified, the events returned for the boundary condition specified are passed through the filter. If the includeFilteredValues parameter is true, the boundary values will be reported at the proper timestamps with the enumeration value "Filtered" when the filter conditions are not met at the boundary time. If the includeFilteredValues parameter is false for this case, no event is returned for the boundary time. Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. If only recorded values with annotations are desired, the filterExpression parameter should include the filter IsSet('.', "a").

osisoft.Stream_GetRecorded({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation values. If this parameter is not specified, annotation values are not returned.
  • boundaryType string: An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • maxCount integer: The maximum number of values to be returned. The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output ExtendedTimedValues

Stream_UpdateValues

Updates multiple values for the specified stream.

osisoft.Stream_UpdateValues({
  "webId": "",
  "values": []
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • values required array
    • items TimedValue
  • bufferOption string: The desired AFBufferOption. The default is 'BufferIfPossible'.
  • updateOption string: The desired AFUpdateOption. The default is 'Replace'.

Output

• output Items[Substatus]

Stream_GetRecordedAtTime

If only recorded values with annotations are desired, the filterExpression parameter should include the filter IsSet('.', "a").

osisoft.Stream_GetRecordedAtTime({
  "webId": "",
  "time": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • time required string: The timestamp at which the value is desired.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation values. If this parameter is not specified, annotation values are not returned.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • retrievalMode string: An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output ExtendedTimedValue

Stream_GetRecordedAtTimes

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. If only recorded values with annotations are desired, the filterExpression parameter should include the filter IsSet('.', "a").

osisoft.Stream_GetRecordedAtTimes({
  "webId": "",
  "time": []
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • time required array: The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.
  • associations string: Associated values to return in the response, separated by semicolons (;). This call supports Annotations to return events with annotation values. If this parameter is not specified, annotation values are not returned.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • retrievalMode string: An optional value that determines the value to return when a value doesn't exist at the exact time specified. The default is 'Auto'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output ExtendedTimedValues

Stream_GetSummary

Count is the only summary type supported on non-numeric streams. Requesting a summary for any other type will generate an error. Time-weighted totals are computed by integrating the rate tag values over the requested time range. If some of the data are bad in the time range, the calculated total is divided by the fraction of the time period for which there are good values. This approach is equivalent to assuming that during the period of bad data, the tag takes on the average values for the entire calculation time range. The PercentGood summary may be used to determine if the calculation results are suitable for the application's purposes. For time-weighted totals, if the time unit rate of the stream cannot be determined, then the value will be totaled assuming a unit of "per day" and no unit of measure will be assigned to the value. If the measured time component of the tag is not based on a day, the user of the data must convert the totalized value to the correct units.

osisoft.Stream_GetSummary({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • calculationBasis string: Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute.
  • sampleInterval string: When the sampleType is Interval, sampleInterval specifies how often the filter expression is evaluated when computing the summary for an interval.
  • sampleType string: Defines the evaluation of an expression over a time range. The default is 'ExpressionRecordedValues'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • summaryDuration string: The duration of each summary interval. If specified in hours, minutes, seconds, or milliseconds, the summary durations will be evenly spaced UTC time intervals. Longer interval types are interpreted using wall clock rules and are time zone dependent.
  • summaryType array: Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
  • timeType string: Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output Items[SummaryValue]

Stream_RegisterStreamUpdate

The supplied webId will register for stream updates. For a 201 or 204 response, the returned location header will contain the url for retrieving the next set of stream updates.

osisoft.Stream_RegisterStreamUpdate({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output StreamUpdatesRegister

Stream_GetValue

Returns the value of the stream at the specified time. By default, this is usually the current value.

osisoft.Stream_GetValue({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • desiredUnits string: The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • time string: An optional time. The default time context is determined from the owning object - for example, the time range of the event frame or transfer which holds this attribute. Otherwise, the implementation of the Data Reference determines the meaning of no context. For Points or simply configured PI Point Data References, this means the snapshot value of the PI Point on the Data Server.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.

Output

• output TimedValue

Stream_UpdateValue

Updates a value for the specified stream.

osisoft.Stream_UpdateValue({
  "webId": "",
  "value": {}
}, context)

Input

• input object
  • webId required string: The ID of the stream.
  • value required TimedValue
  • bufferOption string: The desired AFBufferOption. The default is 'BufferIfPossible'.
  • updateOption string: The desired AFUpdateOption. The default is 'Replace'. This parameter is ignored if the attribute is a configuration item.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

StreamSet_GetChannelAdHoc

Opens a channel that will send messages about any value changes for the specified streams.

osisoft.StreamSet_GetChannelAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • heartbeatRate integer: Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which the client receives an empty payload. It helps to check if the connection is still alive. Zero/negative values correspond to no heartbeat, and the default value is no heartbeat.
  • includeInitialValues boolean: Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is 'false'.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_GetEndAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetEndAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetInterpolatedAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetInterpolatedAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • endTime string: An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • interval string: The sampling interval, in AFTimeSpan format.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • startTime string: An optional start time. The default is '*-1d'.
  • syncTime string: An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.
  • syncTimeBoundaryType string: An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetInterpolatedAtTimesAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetInterpolatedAtTimesAdHoc({
  "time": [],
  "webId": []
}, context)

Input

• input object
  • time required array: The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetJoined

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. The first stream in the response is always the X-Axis.

osisoft.StreamSet_GetJoined({
  "baseWebId": "",
  "subordinateWebId": []
}, context)

Input

• input object
  • baseWebId required string: The ID of the base stream which is used for retrieving the recorded values.
  • subordinateWebId required array: The ID of a stream whose values will be joined on the times with the values of the base stream. Multiple streams may be specified with multiple instances of the parameter.
  • boundaryType string: An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • maxCount integer: The maximum number of values to be returned. The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either place, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetPlotAdHoc

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetPlotAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • endTime string: An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • intervals integer: The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • startTime string: An optional start time. The default is '*-1d'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetRecordedAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetRecordedAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • boundaryType string: An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
  • endTime string: An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • maxCount integer: The maximum number of values to be returned. The default is 1000.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • startTime string: An optional start time. The default is '*-1d'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_UpdateValuesAdHoc

Updates multiple values for the specified streams.

osisoft.StreamSet_UpdateValuesAdHoc({
  "values": []
}, context)

Input

• input object
  • values required array
    • items StreamValues
  • bufferOption string: The desired AFBufferOption. The default is 'BufferIfPossible'.
  • updateOption string: The desired AFUpdateOption. The default is 'Replace'.

Output

• output Items[Items[Substatus]]

StreamSet_GetRecordedAtTimeAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetRecordedAtTimeAdHoc({
  "time": "",
  "webId": []
}, context)

Input

• input object
  • time required string: The timestamp at which the values are desired.
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • retrievalMode string: An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_GetRecordedAtTimesAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetRecordedAtTimesAdHoc({
  "time": [],
  "webId": []
}, context)

Input

• input object
  • time required array: The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • retrievalMode string: An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetSummariesAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetSummariesAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • calculationBasis string: Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
  • endTime string: An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. The default is no filtering.
  • sampleInterval string: A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.
  • sampleType string: A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • startTime string: An optional start time. The default is '*-1d'.
  • summaryDuration string: The duration of each summary interval.
  • summaryType array: Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
  • timeType string: Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamSummaries]

StreamSet_RetrieveStreamSetUpdates

The supplied markers will identify the set of stream updates to retrieve. For a 200 response, the returned location header will contain the url for retrieving the stream updates.

osisoft.StreamSet_RetrieveStreamSetUpdates({
  "marker": []
}, context)

Input

• input object
  • marker required array: Identifier of stream source and current position. Multiple markers may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamUpdatesRetrieve]

StreamSet_RegisterStreamSetUpdates

The supplied webIds will register for stream updates. For a 200 response, the returned location header will contain the url for retrieving the next set of stream updates.

osisoft.StreamSet_RegisterStreamSetUpdates({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamUpdatesRegister]

StreamSet_GetValuesAdHoc

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetValuesAdHoc({
  "webId": []
}, context)

Input

• input object
  • webId required array: The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • time string: An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the default time context of the AF object will be used.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_UpdateValueAdHoc

Updates a single value for the specified streams.

osisoft.StreamSet_UpdateValueAdHoc({
  "values": []
}, context)

Input

• input object
  • values required array
    • items StreamValue
  • bufferOption string: The desired AFBufferOption. The default is 'BufferIfPossible'.
  • updateOption string: The desired AFUpdateOption. The default is 'Replace'.

Output

• output Items[Substatus]

StreamSet_GetChannel

Opens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute.

osisoft.StreamSet_GetChannel({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • heartbeatRate integer: Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which the client receives an empty payload. It helps to check if the connection is still alive. Zero/negative values correspond to no heartbeat, and the default value is no heartbeat.
  • includeInitialValues boolean: Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is 'false'.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_GetEnd

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetEnd({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_GetInterpolated

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetInterpolated({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • interval string: The sampling interval, in AFTimeSpan format.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • syncTime string: An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.
  • syncTimeBoundaryType string: An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetInterpolatedAtTimes

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetInterpolatedAtTimes({
  "webId": "",
  "time": []
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • time required array: The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetPlot

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetPlot({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • intervals integer: The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetRecorded

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetRecorded({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • boundaryType string: An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.
  • includeFilteredValues boolean: Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.
  • maxCount integer: The maximum number of values to be returned. The default is 1000.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_UpdateValues

Updates multiple values for the specified streams.

osisoft.StreamSet_UpdateValues({
  "webId": "",
  "values": []
}, context)

Input

• input object
  • webId required string: The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object.
  • values required array
    • items StreamValues
  • bufferOption string: The desired AFBufferOption. The default is 'BufferIfPossible'.
  • updateOption string: The desired AFUpdateOption. The default is 'Replace'.

Output

• output Items[Items[Substatus]]

StreamSet_GetRecordedAtTime

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetRecordedAtTime({
  "webId": "",
  "time": ""
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • time required string: The timestamp at which the values are desired.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • retrievalMode string: An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_GetRecordedAtTimes

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetRecordedAtTimes({
  "webId": "",
  "time": []
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • time required array: The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • retrievalMode string: An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValues]

StreamSet_GetSummaries

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetSummaries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.
  • calculationBasis string: Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • endTime string: An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.
  • filterExpression string: A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. The default is no filtering.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • sampleInterval string: A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.
  • sampleType string: A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • startTime string: An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.
  • summaryDuration string: The duration of each summary interval.
  • summaryType array: Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • timeType string: Specifies how to calculate the timestamp for each interval. The default is 'Auto'.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamSummaries]

StreamSet_GetValues

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream.

osisoft.StreamSet_GetValues({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.
  • categoryName string: Specify that included attributes must have this category. The default is no category filter.
  • nameFilter string: The name query string used for filtering attributes. The default is no filter.
  • searchFullHierarchy boolean: Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • showExcluded boolean: Specified if the search should include attributes with the Excluded property set. The default is 'false'.
  • showHidden boolean: Specified if the search should include attributes with the Hidden property set. The default is 'false'.
  • sortField string: The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort.
  • sortOrder string: The order that the returned collection is sorted. The default is 'Ascending'
  • templateName string: Specify that included attributes must be members of this template. The default is no template filter.
  • time string: An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the default time context of the AF object will be used.
  • timeZone string: The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[StreamValue]

StreamSet_UpdateValue

Updates a single value for the specified streams.

osisoft.StreamSet_UpdateValue({
  "webId": "",
  "values": []
}, context)

Input

• input object
  • webId required string: The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object.
  • values required array
    • items StreamValue
  • bufferOption string: The desired AFBufferOption. The default is 'BufferIfPossible'.
  • updateOption string: The desired AFUpdateOption. The default is 'Replace'.

Output

• output Items[Substatus]

System_Landing

Get system links for this PI System Web API instance.

osisoft.System_Landing(null, context)

Input

This action has no parameters

Output

• output SystemLanding

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.

osisoft.System_CacheInstances(null, context)

Input

This action has no parameters

Output

• output Items[CacheInstance]

Configuration_List

Get the current system configuration.

osisoft.Configuration_List(null, context)

Input

This action has no parameters

Output

• output object

Configuration_Delete

Delete a configuration item.

osisoft.Configuration_Delete({
  "key": ""
}, context)

Input

• input object
  • key required string: The key of the configuration item to remove.

Output

Output schema unknown

Configuration_Get

The response content may vary based on the configuration item's data type.

osisoft.Configuration_Get({
  "key": ""
}, context)

Input

• input object
  • key required string: The key of the configuration item.

Output

• output object

System_Status

Get information about this PI Web API instance. Examples of information returned include the system uptime, the number of cache instances for this PI System Web API instance, and the system run state.

osisoft.System_Status(null, context)

Input

This action has no parameters

Output

• output SystemStatus

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.

osisoft.System_UserInfo(null, context)

Input

This action has no parameters

Output

• output UserInfo

System_Versions

Get the current versions of the PI Web API instance and all external plugins.

osisoft.System_Versions(null, context)

Input

This action has no parameters

Output

• output object

TableCategory_GetByPath

This method returns a Table Category based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.TableCategory_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the target table category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output TableCategory

TableCategory_Delete

Delete a table category.

osisoft.TableCategory_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table category to delete.

Output

Output schema unknown

TableCategory_Get

Retrieve a table category.

osisoft.TableCategory_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The id of the table category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output TableCategory

TableCategory_Update

Update a table category by replacing items in its definition.

osisoft.TableCategory_Update({
  "webId": "",
  "tableCategory": {}
}, context)

Input

• input object
  • webId required string: The ID of the table category to update.
  • tableCategory required TableCategory

Output

Output schema unknown

TableCategory_GetSecurity

Get the security information of the specified security item associated with the table category for a specified user.

osisoft.TableCategory_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the table category for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

TableCategory_GetSecurityEntries

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.

osisoft.TableCategory_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table category.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

TableCategory_CreateSecurityEntry

Create a security entry owned by the table category.

osisoft.TableCategory_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the table category where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

TableCategory_DeleteSecurityEntry

Delete a security entry owned by the table category.

osisoft.TableCategory_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the table category where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

TableCategory_GetSecurityEntryByName

Retrieve the security entry associated with the table category with the specified name.

osisoft.TableCategory_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the table category.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

TableCategory_UpdateSecurityEntry

Update a security entry owned by the table category.

osisoft.TableCategory_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the table category where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Table_GetByPath

Retrieve a table by path.

osisoft.Table_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the table.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Table

Table_Delete

Delete a table.

osisoft.Table_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table to delete.

Output

Output schema unknown

Table_Get

Retrieve a table.

osisoft.Table_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Table

Table_Update

Update a table by replacing items in its definition.

osisoft.Table_Update({
  "webId": "",
  "table": {}
}, context)

Input

• input object
  • webId required string: The ID of the table to update.
  • table required Table

Output

Output schema unknown

Table_GetCategories

Get a table's categories.

osisoft.Table_GetCategories({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[TableCategory]

Table_GetData

Get the table's data.

osisoft.Table_GetData({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.

Output

• output TableData

Table_UpdateData

Update the table's data.

osisoft.Table_UpdateData({
  "webId": "",
  "data": {}
}, context)

Input

• input object
  • webId required string: The ID of the table on which to update the data.
  • data required TableData

Output

Output schema unknown

Table_GetSecurity

Get the security information of the specified security item associated with the table for a specified user.

osisoft.Table_GetSecurity({
  "webId": "",
  "userIdentity": []
}, context)

Input

• input object
  • webId required string: The ID of the table for the security to be checked.
  • userIdentity required array: The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.
  • forceRefresh boolean: Indicates if the security cache should be refreshed before getting security information. The default is 'false'.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityRights]

Table_GetSecurityEntries

Retrieve the security entries associated with the table based on the specified criteria. By default, all security entries for this table are returned.

osisoft.Table_GetSecurityEntries({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the table.
  • nameFilter string: The name query string used for filtering security entries. The default is no filter.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Items[SecurityEntry]

Table_CreateSecurityEntry

Create a security entry owned by the table.

osisoft.Table_CreateSecurityEntry({
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • webId required string: The ID of the table where the security entry will be created.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Table_DeleteSecurityEntry

Delete a security entry owned by the table.

osisoft.Table_DeleteSecurityEntry({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the table where the security entry will be deleted.
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

Table_GetSecurityEntryByName

Retrieve the security entry associated with the table with the specified name.

osisoft.Table_GetSecurityEntryByName({
  "name": "",
  "webId": ""
}, context)

Input

• input object
  • name required string: The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.
  • webId required string: The ID of the table.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output SecurityEntry

Table_UpdateSecurityEntry

Update a security entry owned by the table.

osisoft.Table_UpdateSecurityEntry({
  "name": "",
  "webId": "",
  "securityEntry": {}
}, context)

Input

• input object
  • name required string: The name of the security entry.
  • webId required string: The ID of the table where the security entry will be updated.
  • securityEntry required SecurityEntry
  • applyToChildren boolean: If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change.

Output

Output schema unknown

TimeRulePlugIn_GetByPath

This method returns a Time Rule Plug-in based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.TimeRulePlugIn_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the Time Rule Plug-in.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output TimeRulePlugIn

TimeRulePlugIn_Get

Retrieve a Time Rule Plug-in.

osisoft.TimeRulePlugIn_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Time Rule Plug-in.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output TimeRulePlugIn

TimeRule_GetByPath

This method returns a Time Rule based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

osisoft.TimeRule_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the Time Rule.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output TimeRule

TimeRule_Delete

Delete a Time Rule.

osisoft.TimeRule_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Time Rule.

Output

Output schema unknown

TimeRule_Get

Retrieve a Time Rule.

osisoft.TimeRule_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the Time Rule.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output TimeRule

TimeRule_Update

Update a Time Rule by replacing items in its definition.

osisoft.TimeRule_Update({
  "webId": "",
  "timeRule": {}
}, context)

Input

• input object
  • webId required string: The ID of the Time Rule.
  • timeRule required TimeRule

Output

Output schema unknown

UnitClass_GetByPath

Retrieve a unit class by path.

osisoft.UnitClass_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the unit class.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output UnitClass

UnitClass_Delete

Delete a unit class.

osisoft.UnitClass_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the unit class.

Output

Output schema unknown

UnitClass_Get

Retrieve a unit class.

osisoft.UnitClass_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the unit class.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output UnitClass

UnitClass_Update

Update a unit class.

osisoft.UnitClass_Update({
  "webId": "",
  "unitClassDTO": {}
}, context)

Input

• input object
  • webId required string: The ID of the unit class.
  • unitClassDTO required UnitClass

Output

Output schema unknown

UnitClass_GetCanonicalUnit

Get the canonical unit of a unit class.

osisoft.UnitClass_GetCanonicalUnit({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of unit class.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Unit

UnitClass_GetUnits

Get a list of all units belonging to the unit class.

osisoft.UnitClass_GetUnits({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of unit class.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Unit

UnitClass_CreateUnit

Create a unit in the specified Unit Class.

osisoft.UnitClass_CreateUnit({
  "webId": "",
  "unitDTO": {}
}, context)

Input

• input object
  • webId required string: The ID of the server.
  • unitDTO required Unit
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

Output schema unknown

Unit_GetByPath

Retrieve a unit by path.

osisoft.Unit_GetByPath({
  "path": ""
}, context)

Input

• input object
  • path required string: The path to the unit.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Unit

Unit_Delete

Delete a unit.

osisoft.Unit_Delete({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the unit.

Output

Output schema unknown

Unit_Get

Retrieve a unit.

osisoft.Unit_Get({
  "webId": ""
}, context)

Input

• input object
  • webId required string: The ID of the unit.
  • selectedFields string: List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.
  • webIdType string: Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".

Output

• output Unit

Unit_Update

Update a unit.

osisoft.Unit_Update({
  "webId": "",
  "unitDTO": {}
}, context)

Input

• input object
  • webId required string: The ID of the unit.
  • unitDTO required Unit

Output

Output schema unknown

Definitions

Ambiguous

• Ambiguous object
  • Reason string

Analysis

• Analysis object
  • AnalysisRulePlugInName string
  • AutoCreated boolean
  • CategoryNames array
    • items string
  • Description string
  • GroupId integer
  • HasNotification boolean
  • HasTarget boolean
  • HasTemplate boolean
  • Id string
  • IsConfigured boolean
  • IsTimeRuleDefinedByTemplate boolean
  • Links AnalysisLinks
  • MaximumQueueSize integer
  • Name string
  • OutputTime string
  • Path string
  • Priority string
  • PublishResults boolean
  • Status string
  • TargetWebId string
  • TemplateName string
  • TimeRulePlugInName string
  • WebException WebException
  • WebId string

AnalysisCategory

• AnalysisCategory object
  • Description string
  • Id string
  • Links AnalysisCategoryLinks
  • Name string
  • Path string
  • WebException WebException
  • WebId string

AnalysisCategoryLinks

• AnalysisCategoryLinks object
  • Database string
  • Security string
  • SecurityEntries string
  • Self string

AnalysisLinks

• AnalysisLinks object
  • AnalysisRule string
  • AnalysisRulePlugIn string
  • Categories string
  • Database string
  • Security string
  • SecurityEntries string
  • Self string
  • Target string
  • Template string
  • TimeRule string
  • TimeRulePlugIn string

AnalysisRule

• AnalysisRule object
  • ConfigString string
  • Description string
  • DisplayString string
  • EditorType string
  • HasChildren boolean
  • Id string
  • IsConfigured boolean
  • IsInitializing boolean
  • Links AnalysisRuleLinks
  • Name string
  • Path string
  • PlugInName string
  • SupportedBehaviors array
    • items string
  • VariableMapping string
  • WebException WebException
  • WebId string

AnalysisRuleLinks

• AnalysisRuleLinks object
  • Analysis string
  • AnalysisRules string
  • AnalysisTemplate string
  • Parent string
  • PlugIn string
  • Self string

AnalysisRulePlugIn

• AnalysisRulePlugIn object
  • AssemblyFileName string
  • AssemblyID string
  • AssemblyLoadProperties array
    • items string
  • AssemblyTime string
  • CompatibilityVersion integer
  • Description string
  • Id string
  • IsBrowsable boolean
  • IsNonEditableConfig boolean
  • Links AnalysisRulePlugInLinks
  • LoadedAssemblyTime string
  • LoadedVersion string
  • Name string
  • Path string
  • Version string
  • WebException WebException
  • WebId string

AnalysisRulePlugInLinks

• AnalysisRulePlugInLinks object
  • AssetServer string
  • Self string

AnalysisTemplate

• AnalysisTemplate object
  • AnalysisRulePlugInName string
  • CategoryNames array
    • items string
  • CreateEnabled boolean
  • Description string
  • GroupId integer
  • HasNotificationTemplate boolean
  • HasTarget boolean
  • Id string
  • Links AnalysisTemplateLinks
  • Name string
  • OutputTime string
  • Path string
  • TargetName string
  • TimeRulePlugInName string
  • WebException WebException
  • WebId string

AnalysisTemplateLinks

• AnalysisTemplateLinks object
  • AnalysisRule string
  • AnalysisRulePlugIn string
  • Categories string
  • Database string
  • Security string
  • SecurityEntries string
  • Self string
  • Target string
  • TimeRule string
  • TimeRulePlugIn string

Annotation

• Annotation object
  • CreationDate string
  • Creator string
  • Description string
  • Errors array
    • items PropertyError
  • Id string
  • Links AnnotationLinks
  • Modifier string
  • ModifyDate string
  • Name string
  • Value object
  • WebException WebException

AnnotationLinks

• AnnotationLinks object
  • MediaData string
  • MediaMetadata string
  • Owner string
  • Self string

AssetDatabase

• AssetDatabase object
  • Description string
  • ExtendedProperties object
  • Id string
  • Links AssetDatabaseLinks
  • Name string
  • Path string
  • WebException WebException
  • WebId string

AssetDatabaseLinks

• AssetDatabaseLinks object
  • AnalysisCategories string
  • AnalysisTemplates string
  • AssetServer string
  • AttributeCategories string
  • ElementCategories string
  • ElementTemplates string
  • Elements string
  • EnumerationSets string
  • EventFrames string
  • Security string
  • SecurityEntries string
  • Self string
  • TableCategories string
  • Tables string

AssetServer

• AssetServer object
  • Description string
  • ExtendedProperties object
  • Id string
  • IsConnected boolean
  • Links AssetServerLinks
  • Name string
  • Path string
  • ServerTime string
  • ServerVersion string
  • WebException WebException
  • WebId string

AssetServerLinks

• AssetServerLinks object
  • AnalysisRulePlugIns string
  • Databases string
  • NotificationContactTemplates string
  • NotificationPlugIns string
  • Security string
  • SecurityEntries string
  • SecurityIdentities string
  • SecurityMappings string
  • Self string
  • TimeRulePlugIns string
  • UnitClasses string

Attribute

• Attribute object
  • CategoryNames array
    • items string
  • ConfigString string
  • DataReference DataReference
  • DataReferencePlugIn string
  • DefaultUnitsName string
  • DefaultUnitsNameAbbreviation string
  • Description string
  • DisplayDigits integer
  • HasChildren boolean
  • Id string
  • IsConfigurationItem boolean
  • IsExcluded boolean
  • IsHidden boolean
  • IsManualDataEntry boolean
  • Links AttributeLinks
  • Name string
  • Path string
  • Paths array
    • items string
  • Span number
  • Step boolean
  • TraitName string
  • Type string
  • TypeQualifier string
  • WebException WebException
  • WebId string
  • Zero number

AttributeCategory

• AttributeCategory object
  • Description string
  • Id string
  • Links AttributeCategoryLinks
  • Name string
  • Path string
  • WebException WebException
  • WebId string

AttributeCategoryLinks

• AttributeCategoryLinks object
  • Database string
  • Security string
  • SecurityEntries string
  • Self string

AttributeLinks

• AttributeLinks object
  • Attributes string
  • Categories string
  • Element string
  • EndValue string
  • EnumerationSet string
  • EnumerationValues string
  • EventFrame string
  • InterpolatedData string
  • Parent string
  • PlotData string
  • Point string
  • RecordedData string
  • Self string
  • SummaryData string
  • Template string
  • Trait string
  • Value string

AttributeTemplate

• AttributeTemplate object
  • CategoryNames array
    • items string
  • ConfigString string
  • DataReferencePlugIn string
  • DefaultUnitsName string
  • DefaultUnitsNameAbbreviation string
  • DefaultValue object
  • Description string
  • HasChildren boolean
  • Id string
  • IsConfigurationItem boolean
  • IsExcluded boolean
  • IsHidden boolean
  • IsManualDataEntry boolean
  • Links AttributeTemplateLinks
  • Name string
  • Path string
  • TraitName string
  • Type string
  • TypeQualifier string
  • WebException WebException
  • WebId string

AttributeTemplateLinks

• AttributeTemplateLinks object
  • AttributeTemplates string
  • Categories string
  • ElementTemplate string
  • Parent string
  • Self string
  • Trait string

AttributeTrait

• AttributeTrait object
  • Abbreviation string
  • AllowChildAttributes boolean
  • AllowDuplicates boolean
  • IsAllowedOnRootAttribute boolean
  • IsTypeInherited boolean
  • IsUOMInherited boolean
  • Links AttributeTraitLinks
  • Name string
  • RequireNumeric boolean
  • RequireString boolean
  • WebException WebException

AttributeTraitLinks

• AttributeTraitLinks object
  • Self string

CacheInstance

• CacheInstance object
  • Id string
  • LastRefreshTime string
  • ScheduledExpirationTime string
  • User string
  • WebException WebException
  • WillRefreshAfter string

ChannelInstance

• ChannelInstance object
  • Id string
  • LastMessageSentTime string
  • SentMessageCount integer
  • StartTime string
  • WebException WebException

DataPipeEvent

• DataPipeEvent object
  • Action string
  • Annotated boolean
  • Errors array
    • items PropertyError
  • Good boolean
  • PreviousEventAction string
  • Questionable boolean
  • Substituted boolean
  • Timestamp string
  • UnitsAbbreviation string
  • Value object
  • WebException WebException

DataReference

• DataReference object
  • PIPoint PIPointDataReference
  • Type string
  • WebException WebException

DataServer

• DataServer object
  • Id string
  • IsConnected boolean
  • Links DataServerLinks
  • Name string
  • Path string
  • ServerTime string
  • ServerVersion string
  • WebException WebException
  • WebId string

DataServerLicense

• DataServerLicense object
  • AmountLeft string
  • AmountUsed string
  • Links DataServerLicenseLinks
  • Name string
  • TotalAmount string
  • WebException WebException

DataServerLicenseLinks

• DataServerLicenseLinks object
  • Parent string
  • Self string

DataServerLinks

• DataServerLinks object
  • EnumerationSets string
  • Points string
  • Self string

DeliveryChannelPlugInLinks

• DeliveryChannelPlugInLinks object
  • AssetServer string
  • Self string

Element

• Element object
  • CategoryNames array
    • items string
  • Description string
  • Errors array
    • items PropertyError
  • ExtendedProperties object
  • HasChildren boolean
  • Id string
  • Links ElementLinks
  • Name string
  • Path string
  • Paths array
    • items string
  • TemplateName string
  • WebException WebException
  • WebId string

ElementCategory

• ElementCategory object
  • Description string
  • Id string
  • Links ElementCategoryLinks
  • Name string
  • Path string
  • WebException WebException
  • WebId string

ElementCategoryLinks

• ElementCategoryLinks object
  • Database string
  • Security string
  • SecurityEntries string
  • Self string

ElementLinks

• ElementLinks object
  • Analyses string
  • Attributes string
  • Categories string
  • Database string
  • DefaultAttribute string
  • Elements string
  • EndValue string
  • EventFrames string
  • InterpolatedData string
  • NotificationRules string
  • Parent string
  • PlotData string
  • RecordedData string
  • Security string
  • SecurityEntries string
  • Self string
  • SummaryData string
  • Template string
  • Value string

ElementTemplate

• ElementTemplate object
  • AllowElementToExtend boolean
  • BaseTemplate string
  • CanBeAcknowledged boolean
  • CategoryNames array
    • items string
  • Description `strin