Upgrade to 2018

Author: osimloeff

DOCUMENTATION.md

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright 2018 OSIsoft, LLC
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

LICENSE.md

@@ -1,12 +1,12 @@
-PI Web API client library for Python (2017 R2)
+PI Web API client library for Python (2018)
 ===
 
 ## Overview
-This repository has the source code package of the PI Web API client libraries for Python. This version was developed on top of the PI Web API 2017 R2 swagger specification.
+This repository has the source code package of the PI Web API client libraries for Python. This version was developed on top of the PI Web API 2018 swagger specification.
 
 ## Requirements
 
- - PI Web API 2017 R2 installed within your domain using Kerberos or Basic Authentication. If you are using an older version, some methods might not work.
+ - PI Web API 2018 installed within your domain using Kerberos or Basic Authentication. If you are using an older version, some methods might not work.
  - Python 2.7 and 3.4+
 
 ## Installation
@@ -246,6 +246,25 @@ The path from the methods above should start with "pi:" (if your stream is a PI
     pi_attribute_web_id_info = client.webIdHelper.get_web_id_info(pi_attribute_web_id)
     pi_element_web_id_info= client.webIdHelper.get_web_id_info(pi_element_web_id)
     pi_dataServer_web_id_info = client.webIdHelper.get_web_id_info(pi_data_server_web_id)
+	
+### StreamUpdates
+
+
+```python
+    events = list()
+    piItemsStreamUpdatesRegister = client.streamSet.register_stream_set_updates(webIds)
+    markers = [i.latest_marker for i in piItemsStreamUpdatesRegister.items]
+    k = 3
+    while k > 0:
+		piItemsStreamUpdatesRetrieve = client.streamSet.retrieve_stream_set_updates(markers)
+		markers = [i.latest_marker for i in piItemsStreamUpdatesRetrieve.items]
+		for item in piItemsStreamUpdatesRetrieve.items:
+			for event in item.events:
+				events.append(event)
+		time.sleep(30)
+		k = k-1
+    self.assertTrue(events.__len__() > 0)
+	
 
 
 

README.md

@@ -42,6 +42,10 @@ Property | Controller
 **enumerationSet** | [**EnumerationSetApi**](/docs/api/EnumerationSetApi.md)
 **enumerationValue** | [**EnumerationValueApi**](/docs/api/EnumerationValueApi.md)
 **eventFrame** | [**EventFrameApi**](/docs/api/EventFrameApi.md)
+**notificationContactTemplate** | [**NotificationContactTemplateApi**](/docs/api/NotificationContactTemplateApi.md)
+**notificationRule** | [**NotificationRuleApi**](/docs/api/NotificationRuleApi.md)
+**notificationRuleSubscriber** | [**NotificationRuleSubscriberApi**](/docs/api/NotificationRuleSubscriberApi.md)
+**notificationRuleTemplate** | [**NotificationRuleTemplateApi**](/docs/api/NotificationRuleTemplateApi.md)
 **point** | [**PointApi**](/docs/api/PointApi.md)
 **securityIdentity** | [**SecurityIdentityApi**](/docs/api/SecurityIdentityApi.md)
 **securityMapping** | [**SecurityMappingApi**](/docs/api/SecurityMappingApi.md)

docs/PIWebApiClient.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**get_analysis_rule_plug_ins**](AssetServerApi.md#getanalysisruleplugins) | **GET** /assetservers/{webId}/analysisruleplugins | Retrieve a list of all Analysis Rule Plug-in's.
 [**get_databases**](AssetServerApi.md#getdatabases) | **GET** /assetservers/{webId}/assetdatabases | Retrieve a list of all Asset Databases on the specified Asset Server.
 [**create_asset_database**](AssetServerApi.md#createassetdatabase) | **POST** /assetservers/{webId}/assetdatabases | Create an asset database.
+[**get_notification_contact_templates**](AssetServerApi.md#getnotificationcontacttemplates) | **GET** /assetservers/{webId}/notificationcontacttemplates | Retrieve a list of all notification contact templates on the specified Asset Server.
 [**get_security**](AssetServerApi.md#getsecurity) | **GET** /assetservers/{webId}/security | Get the security information of the specified security item associated with the asset server for a specified user.
 [**get_security_entries**](AssetServerApi.md#getsecurityentries) | **GET** /assetservers/{webId}/securityentries | Retrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries for this asset server are returned.
 [**create_security_entry**](AssetServerApi.md#createsecurityentry) | **POST** /assetservers/{webId}/securityentries | Create a security entry owned by the asset server.
@@ -164,6 +165,26 @@ None
 
 [[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
 
+# **get_notification_contact_templates**
+> get_notification_contact_templates('web_id', 'selected_fields', 'web_id_type')
+
+Retrieve a list of all notification contact templates on the specified Asset Server.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **web_id** | **str**| The ID of the server.. | [required]
+ **selected_fields** | **str**| List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional]
+ **web_id_type** | **str**| Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional]
+
+
+### Return type
+
+[**PIItemsNotificationContactTemplate**](../models/PIItemsNotificationContactTemplate.md)
+
+[[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
+
 # **get_security**
 > get_security('web_id', 'security_item', 'user_identity', 'force_refresh', 'selected_fields', 'web_id_type')
 

docs/api/AssetServerApi.md

@@ -94,7 +94,7 @@ None
 [[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
 
 # **get_attributes**
-> get_attributes('web_id', 'category_name', 'max_count', 'name_filter', 'search_full_hierarchy', 'selected_fields', 'show_excluded', 'show_hidden', 'sort_field', 'sort_order', 'start_index', 'template_name', 'value_type', 'web_id_type')
+> get_attributes('web_id', 'category_name', 'max_count', 'name_filter', 'search_full_hierarchy', 'selected_fields', 'show_excluded', 'show_hidden', 'sort_field', 'sort_order', 'start_index', 'template_name', 'trait', 'trait_category', 'value_type', 'web_id_type')
 
 Get the child attributes of the specified attribute.
 
@@ -114,6 +114,8 @@ Name | Type | Description | Notes
  **sort_order** | **str**| The order that the returned collection is sorted. The default is 'Ascending'.. | [optional]
  **start_index** | **int**| The starting index (zero based) of the items to be returned. The default is 0.. | [optional]
  **template_name** | **str**| Specify that returned attributes must be members of this template. The default is no template filter.. | [optional]
+ **trait** | **list[str]**| The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.. | [optional]
+ **trait_category** | **list[str]**| 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.. | [optional]
  **value_type** | **str**| Specify that returned attributes' value type must be the given value type. The default is no value type filter.. | [optional]
  **web_id_type** | **str**| Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional]
 

docs/api/AttributeApi.md

@@ -142,7 +142,7 @@ Retrieves the specified license for the given Data Server. The fields of the res
 Name | Type | Description | Notes
 ------------- | ------------- | ------------- | -------------
  **web_id** | **str**| The ID of the server.. | [required]
- **module** | **str**| The case-sensitive name of the module.. | [required]
+ **module** | **str**| The case-sensitive name of the module.. | [optional]
  **selected_fields** | **str**| List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional]
  **web_id_type** | **str**| Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional]
 

docs/api/DataServerApi.md

@@ -16,6 +16,8 @@ Method | HTTP request | Description
 [**get_elements**](ElementApi.md#getelements) | **GET** /elements/{webId}/elements | Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element.
 [**create_element**](ElementApi.md#createelement) | **POST** /elements/{webId}/elements | Create a child element.
 [**get_event_frames**](ElementApi.md#geteventframes) | **GET** /elements/{webId}/eventframes | Retrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element that have been active in the past 8 hours.
+[**get_notification_rules**](ElementApi.md#getnotificationrules) | **GET** /elements/{webId}/notificationrules | Retrieve notification rules for an element
+[**get_paths**](ElementApi.md#getpaths) | **GET** /elements/{webId}/paths | Get a list of the full or relative paths to this element.
 [**get_referenced_elements**](ElementApi.md#getreferencedelements) | **GET** /elements/{webId}/referencedelements | Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements of the current resource.
 [**add_referenced_element**](ElementApi.md#addreferencedelement) | **POST** /elements/{webId}/referencedelements | Add a reference to an existing element to the child elements collection.
 [**remove_referenced_element**](ElementApi.md#removereferencedelement) | **DELETE** /elements/{webId}/referencedelements | Remove a reference to an existing element from the child elements collection.
@@ -153,7 +155,7 @@ None
 [[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
 
 # **get_attributes**
-> get_attributes('web_id', 'category_name', 'max_count', 'name_filter', 'search_full_hierarchy', 'selected_fields', 'show_excluded', 'show_hidden', 'sort_field', 'sort_order', 'start_index', 'template_name', 'value_type', 'web_id_type')
+> get_attributes('web_id', 'category_name', 'max_count', 'name_filter', 'search_full_hierarchy', 'selected_fields', 'show_excluded', 'show_hidden', 'sort_field', 'sort_order', 'start_index', 'template_name', 'trait', 'trait_category', 'value_type', 'web_id_type')
 
 Get the attributes of the specified element.
 
@@ -173,6 +175,8 @@ Name | Type | Description | Notes
  **sort_order** | **str**| The order that the returned collection is sorted. The default is 'Ascending'.. | [optional]
  **start_index** | **int**| The starting index (zero based) of the items to be returned. The default is 0.. | [optional]
  **template_name** | **str**| Specify that returned attributes must be members of this template. The default is no template filter.. | [optional]
+ **trait** | **list[str]**| The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter.. | [optional]
+ **trait_category** | **list[str]**| 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.. | [optional]
  **value_type** | **str**| Specify that returned attributes' value type must be the given value type. The default is no value type filter.. | [optional]
  **web_id_type** | **str**| Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional]
 
@@ -359,6 +363,45 @@ Name | Type | Description | Notes
 
 [[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
 
+# **get_notification_rules**
+> get_notification_rules('web_id', 'selected_fields', 'web_id_type')
+
+Retrieve notification rules for an element
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **web_id** | **str**| The ID of the resource to use as the root of the search.. | [required]
+ **selected_fields** | **str**| List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional]
+ **web_id_type** | **str**| Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional]
+
+
+### Return type
+
+[**PIItemsNotificationRule**](../models/PIItemsNotificationRule.md)
+
+[[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
+
+# **get_paths**
+> get_paths('web_id', 'relative_path')
+
+Get a list of the full or relative paths to this element.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **web_id** | **str**| The ID of the element.. | [required]
+ **relative_path** | **str**| 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.. | [optional]
+
+
+### Return type
+
+[**PIItemsstring**](../models/PIItemsstring.md)
+
+[[Back to top]](#) [[Back to API list]](../../DOCUMENTATION.md#documentation-for-api-endpoints) [[Back to Model list]](../../DOCUMENTATION.md#documentation-for-models) [[Back to DOCUMENTATION]](../../DOCUMENTATION.md)
+
 # **get_referenced_elements**
 > get_referenced_elements('web_id', 'category_name', 'description_filter', 'element_type', 'max_count', 'name_filter', 'selected_fields', 'sort_field', 'sort_order', 'start_index', 'template_name', 'web_id_type')