@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 `s