Upgrade to 2017 R2

Author: Marcos Vainer Loeff

.idea/PI-Web-API-Client-Python.iml

@@ -1,13 +1,13 @@
-PI Web API Client libraries for Python
+PI Web API client library for Python (2017 R2)
 ===
 
 ## Overview
-This repository has the source code package of the PI Web API Client libraries for Python.
+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.
 
 ## Requirements.
 
-Python 2.7 and 3.4+
-
+ - 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.
+ - Python 2.7 and 3.4+
 
 ## Installation
 ### pip install
@@ -44,6 +44,10 @@ This library was tested using PyCharm 2017.1.5 and Anaconda3 5.0.0
 
 All classes and methods are described on the [DOCUMENTATION](DOCUMENTATION.md). 
 
+## Notes
+
+ - Is is highly recommended to turn debug mode on in case you are using PI Web API 2017 R2+ in order to receive more detailed exception errors. This can be achieved by creating or editing the DebugMode attribute's value to TRUE from the System Configuration element.
+ - The X-Requested-With header is added to work with CSRF defences.
 
 ## Examples
 
@@ -64,16 +68,16 @@ Only Basic Authentication is available in this version. Therefore, the variable
 
 
 ```python
-    df1 = client.data.get_recorded_values("pi:\\\\JUPITER001\\cdt158", None, None, "*-9d", None, None, None, None, "*-10d", None)df4 = client.data.get_multiple_recorded_values(["pi:\\JUPITER001\sinusoid", "pi:\\JUPITER001\sinusoidu", "pi:\\JUPITER001\cdt158"],None, "*", None, None, None, None, "*-1d", None)
-    df2 = client.data.get_interpolated_values("pi:\\JUPITER001\\sinusoidu",None, "*", None, None, "2h", None, "*-1d", None)
-    df3 = client.data.get_plot_values("pi:\\\\JUPITER001\\sinusoidu", None, "*", 10, None, "*-3d", None)
-    df4 = client.data.get_recorded_values("pi:\\\\PISRV1\\sinusoid", None, None, "*", None, None, None, "items.value;items.timestamp", "*-1d", None)
-    df5 = client.data.get_recorded_values("pi:\\\\PISRV1\\sinusoid", None, None, "*", None, None, None, "items.good;items.questionable;items.substituted", "*-1d", None)
-	dfs1 = client.data.get_multiple_recorded_values(["pi:\\\\JUPITER001\\sinusoid", "pi:\\\\JUPITER001\\sinusoidu", "pi:\\\\JUPITER001\\cdt158", "af:\\\\JUPITER001\\Vitens\\Vitens\\Friesland province\\01 Production sites\\Production Site Noordbergum\\Distribution\\Quality|pH"],None, "*", None, None, None, None, "*-1d", None)
-    dfs2 = client.data.get_multiple_interpolated_values(["pi:\\\\JUPITER001\\sinusoid", "pi:\\\\JUPITER001\\sinusoidu", "pi:\\\\JUPITER001\\cdt158", "af:\\\\JUPITER001\\Vitens\\Vitens\\Friesland province\\01 Production sites\\Production Site Noordbergum\\Distribution\\Quality|pH"], "*", None, None, "1d", None, "*-5d", None)
-    dfs3 = client.data.get_multiple_plot_values(["pi:\\\\JUPITER001\\sinusoid", "pi:\\\\JUPITER001\\sinusoidu", "pi:\\\\JUPITER001\\cdt158", "af:\\\\JUPITER001\\Vitens\\Vitens\\Friesland province\\01 Production sites\\Production Site Noordbergum\\Distribution\\Quality|pH"], "*", 10, None, "*-1d", None)
-    dfs4 = client.data.get_multiple_recorded_values(paths, None, "*", None, None, None, "items.items.value;items.items.timestamp", "*-1d", None)
-    dfs5 = client.data.get_multiple_interpolated_values(paths, "*", None, None, "1h", "items.items.value;items.items.timestamp", "*-5d", None)
+	df1 = client.data.get_recorded_values("pi:\\\\PISRV1\\sinusoid",None, None, "*", None, None, None, None, "*-1d", None)
+    df2 = client.data.get_interpolated_values("pi:\\PISRV1\\sinusoid", None, "*", None, None, "1h", None, "*-1d", None, None, None)
+	df3 = client.data.get_plot_values("pi:\\\\PISRV1\\sinusoid", None, "*", 15, None, "*-1d", None)
+	df4 = client.data.get_recorded_values("pi:\\\\PISRV1\\sinusoid", None, None, "*", None, None, None, "items.value;items.timestamp", "*-1d", None)
+	
+	paths  = ["pi:\\\\PISRV1\\sinusoid", "pi:\\\\PISRV1\\sinusoidu", "pi:\\\\PISRV1\\cdt158"];
+    dfs1 = client.data.get_multiple_recorded_values(paths, None, "*", None, None, None, None, None, None, "*-1d", None, None)
+    dfs2 = client.data.get_multiple_interpolated_values(paths, "*", None, None, "1d", None, None, None, "*-5d", None, None, None, None)
+    dfs3 = client.data.get_multiple_plot_values(paths, "*", 10, None, None, None, "*-1d", None, None)
+ 	dfs4 = client.data.get_multiple_recorded_values(paths, None, "*", None, None, None, "items.items.value;items.items.timestamp", None, None, "*-1d", None, None)
 ```
 
 The path from the methods above should start with "pi:" (if your stream is a PI Point) or "af:" (if your stream is an AF attribute).
@@ -84,7 +88,7 @@ The path from the methods above should start with "pi:" (if your stream is a PI
 ### Get the PI Data Archive WebId
 
 ```python
-    dataServer = client.dataServer.get_by_path("\\\\JUPITER001", None);
+	dataServer = client.dataServer.get_by_path("\\\\PISRV1", None, None);
 ```
 
 ### Create a new PI Point
@@ -96,15 +100,15 @@ The path from the methods above should start with "pi:" (if your stream is a PI
     newPoint.point_class = "classic"
     newPoint.point_type = "float32"
     newPoint.future = False
-    res = client.dataServer.create_point_with_http_info(dataServer.web_id, newPoint);         
+    res = client.dataServer.create_point_with_http_info(dataServer.web_id, newPoint, None);         
 ```
 
 ### Get PI Points WebIds
 
 ```python
-    point1 = client.point.get_by_path("\\\\JUPITER001\\sinusoid", None)
-    point2 = client.point.get_by_path("\\\\JUPITER001\\cdt158", None)
-    point3 = client.point.get_by_path("\\\\JUPITER001\\sinusoidu", None)
+    point1 = client.point.get_by_path("\\\\PISRV1\\sinusoid", None, None);
+    point2 = client.point.get_by_path("\\\\PISRV1\\cdt158", None, None);
+    point3 = client.point.get_by_path("\\\\PISRV1\\sinusoidu", None, None);
 ```
 
 ### Get recorded values in bulk using the StreamSet/GetRecordedAdHoc
@@ -114,7 +118,7 @@ The path from the methods above should start with "pi:" (if your stream is a PI
     webIds.append(point1.web_id);
     webIds.append(point2.web_id);
     webIds.append(point3.web_id);
-    piItemsStreamValues = client.streamSet.get_recorded_ad_hoc(webIds, None, "*", None, True, 1000, None, "*-3d", None);
+	piItemsStreamValues = client.streamSet.get_recorded_ad_hoc(webIds, None, "*", None, True, 1000, None, None, None, "*-3d", None, None);
 
 ```
 
@@ -176,8 +180,8 @@ The path from the methods above should start with "pi:" (if your stream is a PI
 ### Get an element and an attribute by path
 
 ```python
-    element = client.element.get_by_path("\\\\JUPITER001\\Universities\\UC Davis", None)
-    attribute = client.attribute.get_by_path("\\\\JUPITER001\\Universities\\UC Davis\\Buildings|Campus Average EUI", "Name")
+	element = client.element.get_by_path("\\\\PISRV1\\City Bikes\\(TO)BIKE", None, None)
+	attribute = client.attribute.get_by_path("\\\\PISRV1\\City Bikes\\(TO)BIKE\\01. Certosa   P.le Avis|Empty Slots", "Name", None)
 
 ```
 
@@ -186,7 +190,7 @@ The path from the methods above should start with "pi:" (if your stream is a PI
 
 
 ## Licensing
-Copyright 2017 OSIsoft, LLC.
+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.

.idea/misc.xml

@@ -13,10 +13,11 @@ Method | HTTP request | Description
 [**get_security_entry_by_name**](AnalysisApi.md#getsecurityentrybyname) | **GET** /analyses/{webId}/securityentries/{name} | Retrieve the security entry associated with the analysis with the specified name.
 [**update_security_entry**](AnalysisApi.md#updatesecurityentry) | **PUT** /analyses/{webId}/securityentries/{name} | Update a security entry owned by the analysis.
 [**delete_security_entry**](AnalysisApi.md#deletesecurityentry) | **DELETE** /analyses/{webId}/securityentries/{name} | Delete a security entry owned by the analysis.
+[**get_analyses_query**](AnalysisApi.md#getanalysesquery) | **GET** /analyses/search | Retrieve analyses based on the specified conditions. By default, returns all analyses.
 
 
 # **get_by_path**
-> get_by_path('path', 'selected_fields')
+> get_by_path('path', 'selected_fields', 'web_id_type')
 
 Retrieve an Analysis by path.
 
@@ -26,6 +27,7 @@ Name | Type | Description | Notes
 ------------- | ------------- | ------------- | -------------
  **path** | **str**| The path to the Analysis.. | [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
@@ -35,7 +37,7 @@ 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**
-> get('web_id', 'selected_fields')
+> get('web_id', 'selected_fields', 'web_id_type')
 
 Retrieve an Analysis.
 
@@ -45,6 +47,7 @@ Name | Type | Description | Notes
 ------------- | ------------- | ------------- | -------------
  **web_id** | **str**| The ID of the Analysis.. | [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
@@ -91,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_categories**
-> get_categories('web_id', 'selected_fields')
+> get_categories('web_id', 'selected_fields', 'web_id_type')
 
 Get an Analysis' categories.
 
@@ -101,6 +104,7 @@ Name | Type | Description | Notes
 ------------- | ------------- | ------------- | -------------
  **web_id** | **str**| The ID of the Analysis.. | [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
@@ -110,7 +114,7 @@ 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_security**
-> get_security('web_id', 'user_identity', 'force_refresh', 'selected_fields')
+> get_security('web_id', 'user_identity', 'force_refresh', 'selected_fields', 'web_id_type')
 
 Get the security information of the specified security item associated with the Analysis for a specified user.
 
@@ -122,6 +126,7 @@ Name | Type | Description | Notes
  **user_identity** | **list[str]**| 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.. | [required]
  **force_refresh** | **bool**| Indicates if the security cache should be refreshed before getting security information. The default is 'false'.. | [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]
 
 
 ### Return type
@@ -131,7 +136,7 @@ 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_security_entries**
-> get_security_entries('web_id', 'name_filter', 'selected_fields')
+> get_security_entries('web_id', 'name_filter', 'selected_fields', 'web_id_type')
 
 Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned.
 
@@ -142,6 +147,7 @@ Name | Type | Description | Notes
  **web_id** | **str**| The ID of the analysis.. | [required]
  **name_filter** | **str**| The name query string used for filtering security entries. The default is no filter.. | [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]
 
 
 ### Return type
@@ -151,7 +157,7 @@ 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)
 
 # **create_security_entry**
-> create_security_entry('web_id', 'security_entry', 'apply_to_children')
+> create_security_entry('web_id', 'security_entry', 'apply_to_children', 'web_id_type')
 
 Create a security entry owned by the analysis.
 
@@ -162,6 +168,7 @@ Name | Type | Description | Notes
  **web_id** | **str**| The ID of the analysis, where the security entry will be created.. | [required]
  **security_entry** | **PISecurityEntry**| The new security entry definition. The full list of allow and deny rights must be supplied.. | [required]
  **apply_to_children** | **bool**| 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.. | [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
@@ -171,7 +178,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_security_entry_by_name**
-> get_security_entry_by_name('name', 'web_id', 'selected_fields')
+> get_security_entry_by_name('name', 'web_id', 'selected_fields', 'web_id_type')
 
 Retrieve the security entry associated with the analysis with the specified name.
 
@@ -182,6 +189,7 @@ Name | Type | Description | Notes
  **name** | **str**| The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\username.. | [required]
  **web_id** | **str**| The ID of the analysis.. | [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
@@ -230,3 +238,26 @@ Name | Type | Description | Notes
 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_analyses_query**
+> get_analyses_query('database_web_id', 'max_count', 'query', 'selected_fields', 'start_index', 'web_id_type')
+
+Retrieve analyses based on the specified conditions. By default, returns all analyses.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **database_web_id** | **str**| The ID of the asset database to use as the root of the query.. | [optional]
+ **max_count** | **int**| The maximum number of objects to be returned per call (page size). The default is 1000.. | [optional]
+ **query** | **str**| 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*".. | [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]
+ **start_index** | **int**| The starting index (zero based) of the items to be returned. The default is 0.. | [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
+
+[**PIItemsAnalysis**](../models/PIItemsAnalysis.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)