Add Retrieve Data Extension Row using the REST API

Sebastien.Dangelo · Sebastien.Dangelo · commit 1bc09e0d6bd1 · 2020-02-28T04:41:15.000-06:00
diff --git a/FuelSDKWrapper.py b/FuelSDKWrapper.py
@@ -290,6 +290,32 @@ def complex_filter(left_operand, logical_operator, right_operand):
     }
 
 
+def search_filter_for_rest_call(search_filter):
+    if 'LeftOperand' in search_filter:  # Complex Filter
+        left_operand = search_filter_for_rest_call(search_filter['LeftOperand'])
+        logical_operator = search_filter['LogicalOperator']
+        right_operand = search_filter_for_rest_call(search_filter['RightOperand'])
+        return "{}%20{}%20{}".format(left_operand, logical_operator, right_operand)
+    else:  # Simple Filter
+        prop = search_filter['Property']
+        operator = operator_for_rest_call(search_filter['SimpleOperator'])
+        value = search_filter.get('Value', search_filter.get('DateValue'))
+        return "{}%20{}%20'{}'".format(prop, operator, value)
+
+
+def operator_for_rest_call(operator):
+    operators = {
+        'equals': 'eq',
+        'notEquals': 'neq',
+        'greaterThan': 'gt',
+        'greaterThanOrEqual': 'gte',
+        'lessThan': 'lt',
+        'lessThanOrEqual': 'lte',
+        'like': 'like'
+    }
+    return operators[operator]
+
+
 class ET_API:
 
     client = None
@@ -422,6 +448,36 @@ def get_data_extension_columns(self, customer_key, property_list=None):
     def get_list_subscriber(self, search_filter=None, property_list=None):
         return self.get_objects(ObjectType.LIST_SUBSCRIBER, search_filter, property_list)
 
+    def get_data_extension_rows_rest(self, customer_key, search_filter=None, property_list=None, order_by=None, page_size=None, page=None):
+        headers = {'content-type': 'application/json', 'Authorization': 'Bearer {}'.format(self.client.authToken)}
+        endpoint = "{}data/v1/customobjectdata/key/{}/rowset?".format(self.client.base_api_url, customer_key)
+
+        if search_filter:
+            endpoint += "&$filter={}".format(search_filter_for_rest_call(search_filter))
+
+        if property_list:
+            endpoint += "&$fields={}".format(",".join(property_list))
+
+        if order_by:
+            endpoint += "&$orderBy={}".format(order_by)
+
+        if page_size:
+            endpoint += "&$pagesize={}".format(page_size)
+
+        if page:
+            endpoint += "&$page={}".format(page)
+
+        result = []
+        r = requests.get(endpoint, headers=headers)
+        if r.status_code == 200 and r.json()['count']:
+            result = r.json()['items']
+            while 'next' in r.json()['links']:
+                endpoint = '{}data{}'.format(self.client.base_api_url, r.json()['links']['next'])
+                r = requests.get(endpoint, headers=headers)
+                if r.status_code == 200 and r.json()['count']:
+                    result += r.json()['items']
+        return result
+
     def get_data_extension_rows(self, customer_key, search_filter=None, property_list=None):
         de_row = FuelSDK.ET_DataExtension_Row()
         de_row.auth_stub = self.get_client()
diff --git a/README.md b/README.md
@@ -148,6 +148,20 @@ values_list = [
     ["Row3_Value1", "Row3_Value2", "Row3_Value3"]
 ]
 response = api.create_data_extension_rows("DE_Key", keys_list, values_list)
+
+# Retrieve Data Extension Rows via REST API for more advanced parameters
+response = api.get_data_extension_rows_rest(
+    customer_key="DE_CUSTOMER_KEY",
+    search_filter=complex_filter(
+        simple_filter("first_name", Operator.EQUALS, "John"),
+        'AND',
+        simple_filter("last_name", Operator.EQUALS, "Doe")
+    ),
+    property_list=["email_address", "first_name", "last_name"],
+    order_by="first_name ASC,last_name DESC",
+    page_size=100,
+    page=5
+)
 ```
 
 ### Get More Results
@@ -223,7 +237,7 @@ Python 2.7.x
 
 Libraries:
 
-* FuelSDK>=0.9.3
+* Salesforce-FuelSDK>=1.3.0
 * PyJWT>=0.1.9
 * requests>=2.18.4
 * suds>=0.4
diff --git a/__init__.py b/__init__.py
@@ -1,4 +1,4 @@
 __title__ = 'FuelSDKWrapper'
-__version__ = '1.1.3'
+__version__ = '1.1.4'
 __author__ = 'Seb Angel'
 __license__ = 'MIT'
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
     readme = f.read()
 
 setup(
-    version='1.1.3',
+    version='1.1.4',
     name='FuelSDKWrapper',
     description='Simplify and enhance the FuelSDK for Salesforce Marketing Cloud (ExactTarget)',
     long_description=readme,
