V.1.3.0 adds the export_fqn= option to the /metadata/tml/export methods, and an override to turn it off if you are on an older cluster (feature starts in 8.9)

Author: bryanthowell-ts

README.md

@@ -123,6 +123,14 @@ You create a TSRestApiV2 object with the `server_url` argument, then use the `se
 ## TML operations
 One primary use case of the REST APIs is to import and export ThoughtSpot Modeling Language (TML) files.
 
+### Disabling FQN export
+ThoughtSpot 8.9 adds the 'export_fqn' option to the `/metadata/tml/export` endpoint, which includes the GUID references to all related objects in an exported TML file. Because this is very useful, the library defaults to including the argument set to true in all TML Export methods.
+
+Older versions of ThoughtSpot will not support this option, so there is a global `can_export_fqn` flag to disable it. Set it to False if you are encountering errors and are on a version prior to 8.9:
+    
+    ts: TSRestApiV1 = TSRestApiV1(server_url=server)
+    ts.can_export_fqn = False
+
 ### Retrieving the TML as a Python OrderedDict from REST API
 If you want to use the TML classes to programmatically adjust the returned TML, there is a `export_tml(guid)` method which retrieves the TML from the API in JSON format and then returns it as a Python OrderedDict.
 

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = thoughtspot_rest_api_v1
-version = 1.2.6
+version = 1.3.0
 description = Library implementing the ThoughtSpot V1 REST API
 long_description = file: README.md
 long_description_content_type = text/markdown

src/thoughtspot_rest_api_v1/_version.py

@@ -1 +1 @@
-__version__ = '1.2.6'
+__version__ = '1.3.0'

src/thoughtspot_rest_api_v1/tsrestapiv1.py

@@ -176,6 +176,9 @@ def __init__(self, server_url: str):
         # V2 REST API for basic implementation
         self.v2_base_url = '{server}/tspublic/rest/v2/'.format(server=self.server)
 
+        # Flag for whether the version implements the export_fqn option of metadata/tml/export
+        self.can_export_fqn = True
+
     #
     # Session management calls
     # - up here vs. in the SESSION section below (because these two are required)
@@ -963,7 +966,7 @@ def raise_tml_errors(response: requests.Response) -> Dict:
             else:
                 return response.json()
 
-    def metadata_tml_export(self, guid: str, export_associated=False) -> OrderedDict:
+    def metadata_tml_export(self, guid: str, export_associated=False, export_fqn=True) -> OrderedDict:
         # Always returns a Python Dict, converted from a request to the API to receive in JSON
         endpoint = 'metadata/tml/export'
 
@@ -972,6 +975,9 @@ def metadata_tml_export(self, guid: str, export_associated=False) -> OrderedDict
             'formattype': 'JSON',
             'export_associated': str(export_associated).lower()
         }
+        # Added in version 8.9, can be set to skip for older releases
+        if self.can_export_fqn is True:
+            post_data['export_fqn'] = str(export_fqn).lower()
 
         url = self.base_url + endpoint
         # TML import is distinguished by having an {'Accept': 'text/plain'} header on the POST
@@ -997,7 +1003,7 @@ def metadata_tml_export(self, guid: str, export_associated=False) -> OrderedDict
         return tml_obj
 
     # Method to retrieve the all of the associate objects and retrieve original object and a dict of name:guid mapping
-    def metadata_tml_export_with_associations_map(self, guid: str) -> (OrderedDict, Dict):
+    def metadata_tml_export_with_associations_map(self, guid: str, export_fqn=True) -> (OrderedDict, Dict):
         # Always returns a Python Dict, converted from a request to the API to receive in JSON
         endpoint = 'metadata/tml/export'
 
@@ -1006,6 +1012,9 @@ def metadata_tml_export_with_associations_map(self, guid: str) -> (OrderedDict,
             'formattype': 'JSON',
             'export_associated': 'true'
         }
+        # Added in version 8.9, can be set to skip for older releases
+        if self.can_export_fqn is True:
+            post_data['export_fqn'] = str(export_fqn).lower()
 
         url = self.base_url + endpoint
         # TML import is distinguished by having an {'Accept': 'text/plain'} header on the POST
@@ -1030,7 +1039,8 @@ def metadata_tml_export_with_associations_map(self, guid: str) -> (OrderedDict,
 
         return tml_obj, name_guid_map
 
-    def metadata_tml_export_string(self, guid: str, formattype: str = 'YAML', export_associated=False) -> str:
+    def metadata_tml_export_string(self, guid: str, formattype: str = 'YAML',
+                                   export_associated=False, export_fqn=True) -> str:
         # Intended for a direct pull with no conversion
         endpoint = 'metadata/tml/export'
         # allow JSON or YAML in any casing
@@ -1040,6 +1050,9 @@ def metadata_tml_export_string(self, guid: str, formattype: str = 'YAML', export
             'formattype': formattype,
             'export_associated': str(export_associated).lower()
         }
+        # Added in version 8.9, can be set to skip for older releases
+        if self.can_export_fqn is True:
+            post_data['export_fqn'] = str(export_fqn).lower()
         url = self.base_url + endpoint
 
         # TML import is distinguished by having an {'Accept': 'text/plain'} header on the POST
@@ -1062,7 +1075,8 @@ def metadata_tml_export_string(self, guid: str, formattype: str = 'YAML', export
         else:
             raise Exception()
 
-    def metadata_tml_export_string_with_associations_map(self, guid: str, formattype: str = 'YAML') -> (str, Dict):
+    def metadata_tml_export_string_with_associations_map(self, guid: str, formattype: str = 'YAML',
+                                                         export_fqn=True) -> (str, Dict):
         # Intended for a direct pull with no conversion
         endpoint = 'metadata/tml/export'
         # allow JSON or YAML in any casing
@@ -1072,6 +1086,9 @@ def metadata_tml_export_string_with_associations_map(self, guid: str, formattype
             'formattype': formattype,
             'export_associated': 'true'
         }
+        # Added in version 8.9, can be set to skip for older releases
+        if self.can_export_fqn is True:
+            post_data['export_fqn'] = str(export_fqn).lower()
         url = self.base_url + endpoint
 
         # TML import is distinguished by having an {'Accept': 'text/plain'} header on the POST