[client] Add pagination + examples

Author: Samuel Hassine

examples/get_all_indicators.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+from pycti import OpenCTIApiClient
+
+# Variables
+api_url = "https://demo.opencti.io"
+api_token = "2b4f29e3-5ea8-4890-8cf5-a76f61f1e2b2"
+
+# OpenCTI initialization
+opencti_api_client = OpenCTIApiClient(api_url, api_token)
+
+# Get all reports using the pagination
+custom_attributes = """
+    id
+    indicator_pattern
+    created
+"""
+
+final_indicators = []
+data = opencti_api_client.indicator.list(
+    first=50, customAttributes=custom_attributes, withPagination=True
+)
+final_indicators = final_indicators + data["entities"]
+
+while data["pagination"]["hasNextPage"]:
+    after = data["pagination"]["endCursor"]
+    print("Listing reports after " + after)
+    data = opencti_api_client.indicator.list(
+        first=50, after=after, customAttributes=custom_attributes, withPagination=True
+    )
+    final_indicators = final_indicators + data["entities"]
+
+# Print
+for indicator in final_indicators:
+    print("[" + indicator["created"] + "] " + indicator["indicator_pattern"])

examples/get_all_indicators_using_pagination.py

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+from pycti import OpenCTIApiClient
+
+# Variables
+api_url = "https://demo.opencti.io"
+api_token = "2b4f29e3-5ea8-4890-8cf5-a76f61f1e2b2"
+
+# OpenCTI initialization
+opencti_api_client = OpenCTIApiClient(api_url, api_token)
+
+# Get all reports using the pagination
+custom_attributes = """
+    id
+    name
+    published
+    description   
+"""
+
+final_reports = []
+data = opencti_api_client.report.list(
+    first=50, customAttributes=custom_attributes, withPagination=True
+)
+final_reports = final_reports + data["entities"]
+
+while data["pagination"]["hasNextPage"]:
+    after = data["pagination"]["endCursor"]
+    print("Listing reports after " + after)
+    data = opencti_api_client.report.list(
+        first=50, after=after, customAttributes=custom_attributes, withPagination=True
+    )
+    final_reports = final_reports + data["entities"]
+
+# Print
+for report in final_reports:
+    print("[" + report["published"] + "] " + report["name"])

examples/get_all_reports_using_pagination.py

@@ -278,8 +278,11 @@ def not_empty(self, value):
         else:
             return False
 
-    def process_multiple(self, data):
-        result = []
+    def process_multiple(self, data, with_pagination=False):
+        if with_pagination:
+            result = {"entities": [], "pagination": {}}
+        else:
+            result = []
         if data is None:
             return result
         for edge in (
@@ -293,7 +296,13 @@ def process_multiple(self, data):
                 and "id" in edge["relation"]
             ):
                 row["remote_relation_id"] = edge["relation"]["id"]
-            result.append(self.process_multiple_fields(row))
+            if with_pagination:
+                result["entities"].append(self.process_multiple_fields(row))
+            else:
+                result.append(self.process_multiple_fields(row))
+
+        if with_pagination and "pageInfo" in data:
+            result["pagination"] = data["pageInfo"]
         return result
 
     def process_multiple_ids(self, data):

pycti/api/opencti_api_client.py

@@ -133,6 +133,7 @@ def list(self, **kwargs):
         order_mode = kwargs.get("orderMode", None)
         custom_attributes = kwargs.get("customAttributes", None)
         get_all = kwargs.get("getAll", False)
+        with_pagination = kwargs.get("withPagination", False)
         if get_all:
             first = 500
 
@@ -194,7 +195,9 @@ def list(self, **kwargs):
                 final_data = final_data + data
             return final_data
         else:
-            return self.opencti.process_multiple(result["data"]["attackPatterns"])
+            return self.opencti.process_multiple(
+                result["data"]["attackPatterns"], with_pagination
+            )
 
     """
         Read a Attack-Pattern object

pycti/entities/opencti_attack_pattern.py

@@ -116,6 +116,7 @@ def list(self, **kwargs):
         order_mode = kwargs.get("orderMode", None)
         custom_attributes = kwargs.get("customAttributes", None)
         get_all = kwargs.get("getAll", False)
+        with_pagination = kwargs.get("withPagination", False)
         if get_all:
             first = 500
 
@@ -155,7 +156,9 @@ def list(self, **kwargs):
                 "orderMode": order_mode,
             },
         )
-        return self.opencti.process_multiple(result["data"]["campaigns"])
+        return self.opencti.process_multiple(
+            result["data"]["campaigns"], with_pagination
+        )
 
     """
         Read a Campaign object

pycti/entities/opencti_campaign.py

@@ -113,6 +113,7 @@ def list(self, **kwargs):
         order_mode = kwargs.get("orderMode", None)
         custom_attributes = kwargs.get("customAttributes", None)
         get_all = kwargs.get("getAll", False)
+        with_pagination = kwargs.get("withPagination", False)
         if get_all:
             first = 500
 
@@ -153,7 +154,9 @@ def list(self, **kwargs):
                 "orderMode": order_mode,
             },
         )
-        return self.opencti.process_multiple(result["data"]["courseOfActions"])
+        return self.opencti.process_multiple(
+            result["data"]["courseOfActions"], with_pagination
+        )
 
     """
         Read a Course-Of-Action object

pycti/entities/opencti_course_of_action.py

@@ -37,6 +37,7 @@ def list(self, **kwargs):
         order_by = kwargs.get("orderBy", None)
         order_mode = kwargs.get("orderMode", None)
         get_all = kwargs.get("getAll", False)
+        with_pagination = kwargs.get("withPagination", False)
         if get_all:
             first = 500
 
@@ -76,7 +77,9 @@ def list(self, **kwargs):
                 "orderMode": order_mode,
             },
         )
-        return self.opencti.process_multiple(result["data"]["externalReferences"])
+        return self.opencti.process_multiple(
+            result["data"]["externalReferences"], with_pagination
+        )
 
     """
         Read a External-Reference object

pycti/entities/opencti_external_reference.py

@@ -116,6 +116,7 @@ def list(self, **kwargs):
         order_mode = kwargs.get("orderMode", None)
         custom_attributes = kwargs.get("customAttributes", None)
         get_all = kwargs.get("getAll", False)
+        with_pagination = kwargs.get("withPagination", False)
         if get_all:
             first = 500
 
@@ -156,7 +157,9 @@ def list(self, **kwargs):
                 "orderMode": order_mode,
             },
         )
-        return self.opencti.process_multiple(result["data"]["identities"])
+        return self.opencti.process_multiple(
+            result["data"]["identities"], with_pagination
+        )
 
     """
         Read a Identity object

pycti/entities/opencti_identity.py

@@ -125,6 +125,7 @@ def list(self, **kwargs):
         order_mode = kwargs.get("orderMode", None)
         custom_attributes = kwargs.get("customAttributes", None)
         get_all = kwargs.get("getAll", False)
+        with_pagination = kwargs.get("withPagination", False)
         if get_all:
             first = 500
 
@@ -164,7 +165,9 @@ def list(self, **kwargs):
                 "orderMode": order_mode,
             },
         )
-        return self.opencti.process_multiple(result["data"]["incidents"])
+        return self.opencti.process_multiple(
+            result["data"]["incidents"], with_pagination
+        )
 
     """
         Read a Incident object