diff --git a/api-playground/APIMATIC-BUILD.json b/api-playground/APIMATIC-BUILD.json
index d056ced1c..9990b9c08 100644
--- a/api-playground/APIMATIC-BUILD.json
+++ b/api-playground/APIMATIC-BUILD.json
@@ -2,7 +2,7 @@
"$schema": "https://titan.apimatic.io/api/build/schema",
"buildFileVersion": "1.0",
"generatePortal": {
- "filterByRole": ["9.0.0.cl", "9.2.0.cl"],
+ "filterByRole": ["9.0.0.cl", "9.2.0.cl", "10.4.0.cl", "10.7.0.cl"],
"pageTitle": "ThoughtSpot Public Rest APIs",
"languageConfig": {
"http": {}
diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json
index 4669a87bc..ffeb7b1ec 100644
--- a/api-spec/openapiSpecv3-2_0.json
+++ b/api-spec/openapiSpecv3-2_0.json
@@ -21,6 +21,14 @@
],
"description": "Roles for version 9.12.0.cl"
},
+ {
+ "name": "10.4.0.cl",
+ "id": "10.4.0.cl",
+ "tags": [
+ "10.4.0.cl"
+ ],
+ "description": "Roles for version 10.4.0.cl"
+ },
{
"name": "9.7.0.cl",
"id": "9.7.0.cl",
@@ -37,14 +45,6 @@
],
"description": "Roles for version 9.2.0.cl"
},
- {
- "name": "10.4.0.cl",
- "id": "10.4.0.cl",
- "tags": [
- "10.4.0.cl"
- ],
- "description": "Roles for version 10.4.0.cl"
- },
{
"name": "10.1.0.cl",
"id": "10.1.0.cl",
@@ -62,12 +62,12 @@
"description": "Roles for version 10.3.0.cl"
},
{
- "name": "10.0.0.cl",
- "id": "10.0.0.cl",
+ "name": "10.6.0.cl",
+ "id": "10.6.0.cl",
"tags": [
- "10.0.0.cl"
+ "10.6.0.cl"
],
- "description": "Roles for version 10.0.0.cl"
+ "description": "Roles for version 10.6.0.cl"
},
{
"name": "9.9.0.cl",
@@ -233,7 +233,7 @@
"/api/rest/2.0/users/search": {
"post": {
"operationId": "searchUsers",
- "description": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties.\n\n**NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available users, set `record_size` to `-1`.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n**NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available users, set `record_size` to `-1`.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -315,7 +315,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
}
},
@@ -338,7 +339,8 @@
"INACTIVE",
"EXPIRED",
"LOCKED",
- "PENDING"
+ "PENDING",
+ "SUSPENDED"
]
},
"notify_on_share": {
@@ -474,7 +476,7 @@
"/api/rest/2.0/system": {
"get": {
"operationId": "getSystemInformation",
- "description": "\n Version: 9.0.0.cl or later\n\nGets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n",
"tags": [
"System",
"9.0.0.cl"
@@ -566,7 +568,7 @@
"/api/rest/2.0/system/config": {
"get": {
"operationId": "getSystemConfig",
- "description": "\n Version: 9.0.0.cl or later\n\nRetrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster.\n\nRequires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster.\n\nThis API does not require any parameters to be passed in the request.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nRetrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster.\n\nRequires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required.\n\nThis API does not require any parameters to be passed in the request.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"System",
"9.0.0.cl"
@@ -636,7 +638,7 @@
"/api/rest/2.0/system/config-overrides": {
"get": {
"operationId": "getSystemOverrideInfo",
- "description": "\n Version: 9.2.0.cl or later\n\nGets a list of configuration overrides applied on the cluster. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets a list of configuration overrides applied on the cluster. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n",
"tags": [
"System",
"9.2.0.cl"
@@ -699,7 +701,7 @@
"/api/rest/2.0/orgs/search": {
"post": {
"operationId": "searchOrgs",
- "description": "\n Version: 9.0.0.cl or later\n\nGets a list of Orgs configured on the ThoughtSpot system. To get details of a specific Org, specify the Org ID or name. You can also pass parameters such as status, visibility, and user identifiers to get a specific list of Orgs.\n\nRequires cluster administration (**Can administer Org**) privileges.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets a list of Orgs configured on the ThoughtSpot system. To get details of a specific Org, specify the Org ID or name. You can also pass parameters such as status, visibility, and user identifiers to get a specific list of Orgs.\n\nRequires cluster administration (**Can administer Org**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Orgs",
"9.0.0.cl"
@@ -952,7 +954,7 @@
"/api/rest/2.0/groups/search": {
"post": {
"operationId": "searchUserGroups",
- "description": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties.\n\n**NOTE**: If you do not get precise results, try setting `record_size` to `-1` and `record_offset` to `0`.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets a list of user group objects from the ThoughtSpot system.\n\nTo get details of a specific user group, specify the user group GUID or name. You can also filter the API response based on User ID, Org ID, Role ID, type of group, sharing visibility, privileges assigned to the group, and the Liveboard IDs assigned to the users in the group.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n**NOTE**: If you do not get precise results, try setting `record_size` to `-1` and `record_offset` to `0`.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Groups",
"9.0.0.cl"
@@ -1033,7 +1035,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
}
},
@@ -1161,7 +1164,7 @@
"/api/rest/2.0/metadata/search": {
"post": {
"operationId": "searchMetadata",
- "description": "\n Version: 9.0.0.cl or later\n\nGets a list of metadata objects available on the ThoughtSpot system.\n\nThis API endpoint is available to all users who have view access to the object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view data for all metadata objects, including users and groups.\n\n#### Usage guidelines\n\n- To get all metadata objects, send the API request without any attributes.\n- To get metadata objects of a specific type, set the `type` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE`.\n- To get a specific metadata object, specify the GUID.\n- To customize your search and filter the API response, you can use several parameters.\n You can search for objects created or modified by specific users, by tags applied to the objects, or by using the include parameters like `include_auto_created_objects`, `include_dependent_objects`, `include_headers`, `include_incomplete_objects`, and so on.\n You can also define sorting options to sort the data retrieved in the API response.\n\n**NOTE**: The following parameters support pagination of metadata records:\n`tag_identifiers`\n`type`\n`created_by_user_identifiers`\n`modified_by_user_identifiers`\n`owned_by_user_identifiers`\n`exclude_objects`\n`include_auto_created_objects`\n`favorite_object_options`\nIf you are using other parameters to search metadata, set `record_size` to `-1` and `record_offset` to `0`.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets a list of metadata objects available on the ThoughtSpot system.\n\nThis API endpoint is available to all users who have view access to the object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view data for all metadata objects, including users and groups.\n\n#### Usage guidelines\n\n- To get all metadata objects, send the API request without any attributes.\n- To get metadata objects of a specific type, set the `type` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE`.\n- To get a specific metadata object, specify the GUID.\n- To customize your search and filter the API response, you can use several parameters.\n You can search for objects created or modified by specific users, by tags applied to the objects, or by using the include parameters like `include_auto_created_objects`, `include_dependent_objects`, `include_headers`, `include_incomplete_objects`, and so on.\n You can also define sorting options to sort the data retrieved in the API response.\n\n**NOTE**: The following parameters support pagination of metadata records:\n\n- `tag_identifiers`\n- `type`\n- `created_by_user_identifiers`\n- `modified_by_user_identifiers`\n- `owned_by_user_identifiers`\n- `exclude_objects`\n- `include_auto_created_objects`\n- `favorite_object_options`\nIf you are using other parameters to search metadata, set `record_size` to `-1` and `record_offset` to `0`.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"9.0.0.cl"
@@ -1377,7 +1380,7 @@
"/api/rest/2.0/metadata/tml/async/status": {
"post": {
"operationId": "fetchAsyncImportTaskStatus",
- "description": " Version: 10.4.0.cl or later",
+ "description": "\n Version: 10.4.0.cl or later\n\nGets information about the status of the TML async import task scheduled using the `/api/rest/2.0/metadata/tml/async/import` API call.\n\nTo fetch the task details, specify the ID of the TML async import task. \n\nRequires access to the task ID. The API allows users who initiated the asynchronous TML import via `/api/rest/2.0/metadata/tml/async/import` to view the status of their tasks. Users with administration privilege can view the status of all import tasks initiated by the users in their Org.\n\n#### Usage guidelines\n\nSee [TML API Documentation](https://developers.thoughtspot.com/docs/tml#_fetch_status_of_the_tml_import_task) for usage guidelines.\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"10.4.0.cl"
@@ -1409,7 +1412,7 @@
}
},
"author_identifier": {
- "description": "Author ID of async import tasks to filter on.",
+ "description": "Author GUID or name of async import tasks to filter on.",
"type": "string"
},
"record_offset": {
@@ -1665,7 +1668,7 @@
"/api/rest/2.0/report/liveboard": {
"post": {
"operationId": "exportLiveboardReport",
- "description": "\n Version: 9.0.0.cl or later\n\nExports the data from a Liveboard and its visualization in a given file format. You can download the Liveboard data as a PDF, PNG, CSV, or XLSX file.\n\nRequires `DATADOWNLOADING` (**Can download data**) privilege.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\nThe default `file_format` is CSV. For PDF file format, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are also available for PNG output.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nExports the data from a Liveboard and its visualization in a given file format. You can download the Liveboard data as a PDF, PNG, CSV, or XLSX file.\n\nRequires `DATADOWNLOADING` (**Can download data**) privilege and view access to the Liveboard.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\nThe default `file_format` is CSV. For PDF file format, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are also available for PNG output.\n\n**NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api).\n\n\n\n#### Endpoint URL\n",
"tags": [
"Reports",
"9.0.0.cl"
@@ -1693,12 +1696,10 @@
},
"file_format": {
"description": "Export file format.",
- "default": "CSV",
+ "default": "PDF",
"type": "string",
"enum": [
- "CSV",
"PDF",
- "XLSX",
"PNG"
]
},
@@ -1729,6 +1730,14 @@
"runtime_param_override": {
"description": "JSON object for setting values of parameters at runtime. For example, {\"param1\": \"Double List Param\", \"paramVal1\": 0.5}. You can add multiple keys by incrementing the number at the end, for example, param2, paramVal2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_parameters).",
"type": "object"
+ },
+ "regional_settings": {
+ "description": "Options for specific region speciic overrides to support date/number/string/currency formatting.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RegionalSettingsInput"
+ }
+ ]
}
},
"required": [
@@ -1793,7 +1802,7 @@
"/api/rest/2.0/report/answer": {
"post": {
"operationId": "exportAnswerReport",
- "description": "\n Version: 9.0.0.cl or later\n\nExports an Answer in the given file format. You can download the Answer data as a PDF, PNG, CSV, or XLSX file.\n\nRequires `DATADOWNLOADING` (**Can download data**) privilege.\n\n#### Usage guidelines\n\nIn the request body, the GUID or name of the Answer and set `file_format`. The default file format is CSV.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api). \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nExports an Answer in the given file format. You can download the Answer data as a PDF, PNG, CSV, or XLSX file.\n\nRequires `DATADOWNLOADING` (**Can download data**) privilege and view access to the Answer.\n\n#### Usage guidelines\n\nIn the request body, the GUID or name of the Answer and set `file_format`. The default file format is CSV.\n\n**NOTE**:\n* The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n* HTML rendering is not supported for PDF exports of Answers with tables.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api).\n\n\n\n#### Endpoint URL\n",
"tags": [
"Reports",
"9.0.0.cl"
@@ -1808,6 +1817,15 @@
"description": "Unique ID or name of the metadata object.",
"type": "string"
},
+ "session_identifier": {
+ "description": "Unique ID of the answer session.",
+ "type": "string"
+ },
+ "generation_number": {
+ "description": "Generation number of the answer session.",
+ "type": "integer",
+ "format": "int32"
+ },
"file_format": {
"description": "Export file format.",
"default": "CSV",
@@ -1830,11 +1848,16 @@
"runtime_param_override": {
"description": "JSON object for setting values of parameters in runtime.",
"type": "object"
+ },
+ "regional_settings": {
+ "description": "Options for specific region speciic overrides to support date/number/string/currency formatting.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RegionalSettingsInput"
+ }
+ ]
}
- },
- "required": [
- "metadata_identifier"
- ]
+ }
}
}
},
@@ -1894,7 +1917,7 @@
"/api/rest/2.0/security/principals/fetch-permissions": {
"post": {
"operationId": "fetchPermissionsOfPrincipals",
- "description": "\n Version: 9.0.0.cl or later\n\nFetches object permission details for a given principal object such as a user and group.\n\nRequires view access to the metadata object.\n\n#### Usage guidelines\n\n* To get a list of all metadata objects that a user or group can access, specify the `type` and GUID or name of the principal.\n* To get permission details for a specific object, add the `type` and GUID or name of the metadata object to your API request.\n\nUpon successful execution, the API returns a list of metadata objects and permission details for each object. \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nFetches object permission details for a given principal object such as a user and group.\n\nRequires view access to the metadata object. \n\n#### Usage guidelines\n\n* To get a list of all metadata objects that a user or group can access, specify the `type` and GUID or name of the principal.\n* To get permission details for a specific object, add the `type` and GUID or name of the metadata object to your API request.\n\nUpon successful execution, the API returns a list of metadata objects and permission details for each object. \n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Security",
"9.0.0.cl"
@@ -2216,7 +2239,7 @@
"/api/rest/2.0/searchdata": {
"post": {
"operationId": "searchData",
- "description": "\n Version: 9.0.0.cl or later\n\nGenerates an Answer from a given data source.\n\nRequires at least view access to the data source object.\n\n#### Usage guidelines\n\nTo search data, specify the data source GUID in `logical_table_identifier`. The data source can be a Worksheet, View, Table, or SQL view.\n\nPass search tokens in the `query_string` attribute in the API request as shown in the following example:\n\n```\n{\n \"query_string\": \"[sales] by [store]\",\n \"logical_table_identifier\": \"cd252e5c-b552-49a8-821d-3eadaa049cca\",\n}\n```\n\nFor more information about the `query_string` format and data source attribute, see [Search data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api). \n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api). \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGenerates an Answer from a given data source.\n\nRequires at least view access to the data source object (Worksheet or View) and the `DATADOWNLOADING` privilege.\n\n#### Usage guidelines\n\nTo search data, specify the data source GUID in `logical_table_identifier`. The data source can be a Worksheet, View, Table, or SQL view.\n\nPass search tokens in the `query_string` attribute in the API request as shown in the following example:\n\n```\n{\n \"query_string\": \"[sales] by [store]\",\n \"logical_table_identifier\": \"cd252e5c-b552-49a8-821d-3eadaa049cca\",\n}\n```\n\nFor more information about the `query_string` format and data source attribute, see [Search data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api). \n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api).\n\n\n\n#### Endpoint URL\n",
"tags": [
"Data",
"9.0.0.cl"
@@ -2336,7 +2359,7 @@
"/api/rest/2.0/metadata/liveboard/data": {
"post": {
"operationId": "fetchLiveboardData",
- "description": "\n Version: 9.0.0.cl or later\n\nGets data from a Liveboard object and its visualization. \n\nRequires at least view access to the Liveboard.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To get data for specific visualizations, add the GUIDs or names of the visualizations in the API request.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes. If the new Liveboard experience mode, the transient content includes ad hoc changes to visualizations such as sorting, toggling of legends, and data drill down.\n\nFor more information, and see [Liveboard data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_fetch_liveboard_data_api). \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets data from a Liveboard object and its visualization. \n\nRequires at least view access to the Liveboard and the `DATADOWNLOADING` privilege.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To get data for specific visualizations, add the GUIDs or names of the visualizations in the API request.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes. If the new Liveboard experience mode, the transient content includes ad hoc changes to visualizations such as sorting, toggling of legends, and data drill down.\n\nFor more information, and see [Liveboard data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_fetch_liveboard_data_api).\n\n\n\n#### Endpoint URL\n",
"tags": [
"Data",
"9.0.0.cl"
@@ -2462,7 +2485,7 @@
"/api/rest/2.0/metadata/answer/data": {
"post": {
"operationId": "fetchAnswerData",
- "description": "\n Version: 9.0.0.cl or later\n\nFetches data from a saved Answer.\n\nRequires at least view access to the saved Answer.\n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](For more information, and see [Liveboard data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_apis). \n). \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nFetches data from a saved Answer.\n\nRequires at least view access to the saved Answer and the `DATADOWNLOADING` privilege.\n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_apis).\n\n\n\n#### Endpoint URL\n",
"tags": [
"Data",
"9.0.0.cl"
@@ -2577,7 +2600,7 @@
"/api/rest/2.0/logs/fetch": {
"post": {
"operationId": "fetchLogs",
- "description": "\n Version: 9.0.0.cl or later\n\nFetches security audit logs. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Usage guidelines\n\nBy default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests.\n\nUpon successful execution, the API returns logs with the following information:\n* timestamp of the event\n* event ID\n* event type\n* name and GUID of the user\n* IP address of ThoughtSpot instance\n\nFor more information about security events returned in the API response, see [Security events](https://developers.thoughtspot.com/docs/audit-logs#_security_events).\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nFetches security audit logs. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the [Admin Control](https://developers.thoughtspot.com/docs/rbac#_admin_control) privileges are required.\n\n\n#### Usage guidelines\n\nBy default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests.\n\nUpon successful execution, the API returns logs with the following information:\n* timestamp of the event\n* event ID\n* event type\n* name and GUID of the user\n* IP address of ThoughtSpot instance\n\nFor more information see [Audit logs Documentation](https://developers.thoughtspot.com/docs/audit-logs).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Log",
"9.0.0.cl"
@@ -2681,7 +2704,7 @@
"/api/rest/2.0/vcs/git/config/search": {
"post": {
"operationId": "searchConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nGets Git repository connections configured on the ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets Git repository connections configured on the ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Version Control",
"9.2.0.cl"
@@ -2766,7 +2789,7 @@
"/api/rest/2.0/vcs/git/commits/search": {
"post": {
"operationId": "searchCommits",
- "description": "\n Version: 9.2.0.cl or later\n\nGets a list of commits for a given metadata object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets a list of commits for a given metadata object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Version Control",
"9.2.0.cl"
@@ -2875,7 +2898,7 @@
"/api/rest/2.0/connection/search": {
"post": {
"operationId": "searchConnection",
- "description": "\n Version: 9.2.0.cl or later\n\nGets connection objects.\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n- To get a list of all connections available in the ThoughtSpot system, send the API request without any attributes in the request body.\n- To get the connection objects for a specific type of data warehouse, specify the type in `data_warehouse_types`.\n- To fetch details of a connection object, specify the connection object GUID or name. The `name_pattern` attribute allows passing partial text with `%` for a wildcard match.\n- To get details of the database, schemas, tables, or columns from a data connection object, specify `data_warehouse_object_type`.\n- To get a specific database, schema, table, or column from a connection object, define the object type in `data_warehouse_object_type` and object properties in the `data_warehouse_objects` array. For example, to search for a column, you must pass the database, schema, and table names in the API request.\n Note that in the following example, object properties are set in a hierarchical order (`database` > `schema` > `table` > `column`).\n\n```\n{\n \"connections\": [\n {\n \"identifier\": \"b9d1f2ef-fa65-4a4b-994e-30fa2d57b0c2\",\n \"data_warehouse_objects\": [\n {\n \"database\": \"NEBULADEV\",\n \"schema\": \"INFORMATION_SCHEMA\",\n \"table\": \"APPLICABLE_ROLES\",\n \"column\": \"ROLE_NAME\"\n }\n ]\n }\n ],\n \"data_warehouse_object_type\": \"COLUMN\"\n}\n```\n\n- To fetch data by `configuration`, specify `data_warehouse_object_type`. For example, to fetch columns from the `DEVELOPMENT` database, specify the `data_warehouse_object_type` as `DATABASE` and define the `configuration` string as `{\"database\":\"DEVELOPMENT\"}`. To get column data for a specific table, specify the table, for example,`{\"database\":\"RETAILAPPAREL\",\"table\":\"PIPES\"}`.\n- To query connections by `authentication_type`, specify `data_warehouse_object_type`. Supported values for `authentication_type` are:\n - `SERVICE_ACCOUNT`: For connections that require service account credentials to authenticate to the Cloud Data Warehouse and fetch data.\n - `OAUTH`: For connections that require OAuth credentials to authenticate to the Cloud Data Warehouse and fetch data. Teradata, Oracle, and Presto Cloud Data Warehouses do not support the OAuth authentication type.\n - `IAM`: For connections that have the IAM OAuth set up. This authentication type is supported on Amazon Redshift connections only.\n - `EXTOAUTH`: For connections that have external OAuth set up. ThoughtSpot supports external [OAuth with Microsoft Azure Active Directory (AD)](https://docs.thoughtspot.com/cloud/latest/ connections-snowflake-azure-ad-oauth) and [Okta for Snowflake data connections](https://docs.thoughtspot.com/cloud/latest/connections-snowflake-okta-oauth).\n- To include more details about connection objects in the API response, set `include_details` to `true`.\n- You can also sort the output by field names and filter connections by tags.\n\n**NOTE**: When filtering connection records by parameters other than `data_warehouse_types` or `tag_identifiers`, ensure that you set `record_size` to `-1` and `record_offset` to `0` for precise results.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets connection objects.\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n- To get a list of all connections available in the ThoughtSpot system, send the API request without any attributes in the request body.\n- To get the connection objects for a specific type of data warehouse, specify the type in `data_warehouse_types`.\n- To fetch details of a connection object, specify the connection object GUID or name. The `name_pattern` attribute allows passing partial text with `%` for a wildcard match.\n- To get details of the database, schemas, tables, or columns from a data connection object, specify `data_warehouse_object_type`.\n- To get a specific database, schema, table, or column from a connection object, define the object type in `data_warehouse_object_type` and object properties in the `data_warehouse_objects` array. For example, to search for a column, you must pass the database, schema, and table names in the API request.\n Note that in the following example, object properties are set in a hierarchical order (`database` > `schema` > `table` > `column`).\n\n```\n{\n \"connections\": [\n {\n \"identifier\": \"b9d1f2ef-fa65-4a4b-994e-30fa2d57b0c2\",\n \"data_warehouse_objects\": [\n {\n \"database\": \"NEBULADEV\",\n \"schema\": \"INFORMATION_SCHEMA\",\n \"table\": \"APPLICABLE_ROLES\",\n \"column\": \"ROLE_NAME\"\n }\n ]\n }\n ],\n \"data_warehouse_object_type\": \"COLUMN\"\n}\n```\n\n- To fetch data by `configuration`, specify `data_warehouse_object_type`. For example, to fetch columns from the `DEVELOPMENT` database, specify the `data_warehouse_object_type` as `DATABASE` and define the `configuration` string as `{\"database\":\"DEVELOPMENT\"}`. To get column data for a specific table, specify the table, for example,`{\"database\":\"RETAILAPPAREL\",\"table\":\"PIPES\"}`.\n- To query connections by `authentication_type`, specify `data_warehouse_object_type`. Supported values for `authentication_type` are:\n - `SERVICE_ACCOUNT`: For connections that require service account credentials to authenticate to the Cloud Data Warehouse and fetch data.\n - `OAUTH`: For connections that require OAuth credentials to authenticate to the Cloud Data Warehouse and fetch data. Teradata, Oracle, and Presto Cloud Data Warehouses do not support the OAuth authentication type.\n - `IAM`: For connections that have the IAM OAuth set up. This authentication type is supported on Amazon Redshift connections only.\n - `EXTOAUTH`: For connections that have external OAuth set up. ThoughtSpot supports external [OAuth with Microsoft Azure Active Directory (AD)](https://docs.thoughtspot.com/cloud/latest/ connections-snowflake-azure-ad-oauth) and [Okta for Snowflake data connections](https://docs.thoughtspot.com/cloud/latest/connections-snowflake-okta-oauth).\n- To include more details about connection objects in the API response, set `include_details` to `true`.\n- You can also sort the output by field names and filter connections by tags.\n\n**NOTE**: When filtering connection records by parameters other than `data_warehouse_types` or `tag_identifiers`, ensure that you set `record_size` to `-1` and `record_offset` to `0` for precise results.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
"9.2.0.cl"
@@ -2928,7 +2951,10 @@
"GCP_POSTGRESQL",
"GCP_MYSQL",
"MODE",
- "GOOGLE_SHEETS"
+ "GOOGLE_SHEETS",
+ "FALCON",
+ "FALCON_ONPREM",
+ "CLICKHOUSE"
]
}
},
@@ -2986,7 +3012,9 @@
"SERVICE_ACCOUNT",
"OAUTH",
"IAM",
- "EXTOAUTH"
+ "EXTOAUTH",
+ "OAUTH_WITH_SERVICE_PRINCIPAL",
+ "PERSONAL_ACCESS_TOKEN"
]
}
}
@@ -3056,7 +3084,7 @@
"/api/rest/2.0/roles/search": {
"post": {
"operationId": "searchRoles",
- "description": "Gets Roles configured on a ThoughtSpot instance.\nRequires cluster Administration, Role Administration or\nGroup Administration privileges.
Version: 9.5.0.cl or later",
+ "description": "\n Version: 9.5.0.cl or later\n\nGets a list of Role objects from the ThoughtSpot system.\n\nAvailable if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\nTo get details of a specific Role object, specify the GUID or name. You can also filter the API response based on user group and Org identifiers, privileges assigned to the Role, and deprecation status.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
@@ -3137,7 +3165,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
}
},
@@ -3239,7 +3268,7 @@
"/api/rest/2.0/customization/custom-actions/search": {
"post": {
"operationId": "searchCustomActions",
- "description": "\n Version: 9.6.0.cl or later\n\nGets custom actions configured on the cluster.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.6.0.cl or later\n\nGets custom actions configured on the cluster.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Custom Action",
"9.6.0.cl"
@@ -3375,6 +3404,81 @@
}
}
},
+ "/api/rest/2.0/ai/answer/getDecomposedQuery": {
+ "post": {
+ "operationId": "queryGetDecomposedQuery",
+ "description": "Beta Version: 10.7.0.cl or later",
+ "tags": [
+ "AI",
+ "10.7.0.cl"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Input_eureka_DecomposeQueryRequest"
+ }
+ ]
+ }
+ },
+ "required": [
+ "request"
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Common successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/QueryGetDecomposedQueryResponse"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Common error response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/QueryGetDecomposedQueryResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/rest/2.0/auth/session/login": {
"post": {
"operationId": "login",
@@ -3464,7 +3568,7 @@
"/api/rest/2.0/auth/token/object": {
"post": {
"operationId": "getObjectAccessToken",
- "description": "\n Version: 9.0.0.cl or later\n\nGets an authentication token that provides access to a specific metadata object. By default, the token obtained from ThoughtSpot remains valid for 5 mins.\n\nYou can generate the token for a user by providing a `username` and `password` (for [Bearer token authentication](https://developers.thoughtspot.com/docs/?pageid=api-authv2#bearerToken)), or by using the cluster’s `secret key` (for [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable)).\n\nTo generate a `secret_key` on your cluster, the administrator must enable **Trusted authentication** in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**: When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n\n#### Just-in-time provisioning\n\nFor just-in-time user creation and provisioning, use the following attributes.\n\n* `auto_create`\n* `username`\n\nTo assign privileges to the new user, specify the group name or GUID in `group_identifiers`.\n\nTo add the user to an Org, send the `Org ID` in the API request.\n\n**Note**: This feature is available only if Trusted authentication is enabled on your cluster.\n\nTo provision a new user and assign privileges, you need `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets an authentication token that provides access to a specific metadata object. By default, the token obtained from ThoughtSpot remains valid for 5 mins.\n\nYou can generate the token for a user by providing a `username` and `password`, or by using the cluster’s `secret key` (for [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable)).\n\nTo generate a `secret_key` on your cluster, the administrator must enable **Trusted authentication** in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**: When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n\n#### Just-in-time provisioning\n\nFor just-in-time user creation and provisioning, define the following attributes:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `group_identifiers`\n\nSet `auto_create` to `True` if the user is not available in ThoughtSpot. If the user already exists in ThoughtSpot and the `auto_create` parameter is set to `true`, the API call will update user properties like display name, email and group assignment.\n\nFor more information, see [Just-in-time provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning).\n\nTo add a new user and assign privileges, you need `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege is required.\n\n#### Attribute-Based Access Control (ABAC) with tokens\n\nYou can define Attribute-Based Access Control (ABAC) parameters to assign security entitlements to users during session creation. For more information, see [ABAC via token](https://developers.thoughtspot.com/docs/abac-user-parameters).\n\n#### Important point to note\nAll options in the token creation APIs changing the content in ThoughtSpot will do so during the token creation and not when the token is being used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Similarly, using `user_parameters` with `persist: true` persists security parameters on the user profile when the token is created and not during authentication.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Authentication",
"9.0.0.cl"
@@ -3476,7 +3580,7 @@
"type": "object",
"properties": {
"username": {
- "description": "Username of the ThoughtSpot user",
+ "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.",
"type": "string"
},
"object_id": {
@@ -3601,7 +3705,7 @@
"/api/rest/2.0/auth/token/full": {
"post": {
"operationId": "getFullAccessToken",
- "description": "\n Version: 9.0.0.cl or later\n\nGets an authentication token and creates a full session in ThoughtSpot for a given user. By default, the token obtained from ThoughtSpot remains valid for 5 mins.\n\nYou can generate the token for a user by providing a `username` and `password` (for [Bearer token authentication](https://developers.thoughtspot.com/docs/?pageid=api-authv2#bearerToken)), or by using the cluster’s `secret_key` (for [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable)).\n\nTo generate a `secret_key` on your cluster, the administrator must enable **Trusted authentication** in the **Develop** > **Customizations** > **Security Settings** page. For more information, see [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable).\n\n**Note**: When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n\n#### Just-in-time provisioning\n\nFor just-in-time user creation and provisioning, use the following attributes.\n\n* `auto_create`\n* `username`\n\nTo assign privileges to the new user, specify the group name or GUID in `group_identifiers`.\n\nTo add the user to an Org, specify the Org ID in the `org_id` attribute.\n\n**Note**: This feature is available only on clusters with trusted authentication enabled.\n\nTo provision a new user and assign privileges, you need `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets an authentication token and creates a full session in ThoughtSpot for a given user. By default, the token obtained from ThoughtSpot remains valid for 5 mins.\n\nYou can generate the token for a user by providing a `username` and `password`, or by using the cluster’s `secret_key` (for [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable)).\n\nTo generate a `secret_key` on your cluster, the administrator must enable **Trusted authentication** in the **Develop** > **Customizations** > **Security Settings** page. For more information, see [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable).\n\n**Note**: When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n\n#### Just-in-time provisioning\n\nFor just-in-time user creation and provisioning, define the following attributes:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `group_identifiers`\n\nSet `auto_create` to `True` if the user is not available in ThoughtSpot. If the user already exists in ThoughtSpot and the `auto_create` parameter is set to `true`, the API call will update user properties like display name, email and group assignment.\n\nFor more information, see [Just-in-time provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning).\n\nTo add a new user and assign privileges, you need `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege is required.\n\n#### Attribute-Based Access Control (ABAC) with tokens\n\nYou can define Attribute-Based Access Control (ABAC) parameters to assign security entitlements to users during session creation. For more information, see [ABAC via token](https://developers.thoughtspot.com/docs/abac-user-parameters).\n\n#### Important point to note\nAll options in the token creation APIs changing the content in ThoughtSpot will do so during the token creation and not when the token is being used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Similarly, using `user_parameters` with `persist: true` persists security parameters on the user profile when the token is created and not during authentication.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Authentication",
"9.0.0.cl"
@@ -3613,7 +3717,7 @@
"type": "object",
"properties": {
"username": {
- "description": "Username of the ThoughtSpot user",
+ "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.",
"type": "string"
},
"password": {
@@ -3790,7 +3894,7 @@
"/api/rest/2.0/auth/token/revoke": {
"post": {
"operationId": "revokeToken",
- "description": "\n Version: 9.0.0.cl or later\n\n\nRevokes the authentication token issued for current user session.\n\nThe token of your current session expires when you make a call to the `/api/rest/2.0/auth/token/revoke` endpoint.\nthe users will not be able to access ThoughtSpot objects until a new token is obtained.\n\nTo restart your session, request for a new token from ThoughtSpot. See [Get Object Access Token](#/http/api-endpoints/authentication/get-object-access-token)\nand [Get Full Access Token](#/http/api-endpoints/authentication/get-full-access-token).\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\n\nRevokes the authentication token issued for current user session.\n\nThe token of your current session expires when you make a call to the `/api/rest/2.0/auth/token/revoke` endpoint.\nthe users will not be able to access ThoughtSpot objects until a new token is obtained.\n\nTo restart your session, request for a new token from ThoughtSpot. See [Get Full Access Token](#/http/api-endpoints/authentication/get-full-access-token).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Authentication",
"9.0.0.cl"
@@ -3864,7 +3968,7 @@
"/api/rest/2.0/auth/token/validate": {
"post": {
"operationId": "validateToken",
- "description": " Version: 9.12.0.cl or later",
+ "description": "\n Version: 9.12.0.cl or later\n\n\nValidates the authentication token specified in the API request.\n\nIf your token is not valid, [Get a new token](#/http/api-endpoints/authentication/get-full-access-token).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Authentication",
"9.12.0.cl"
@@ -3942,10 +4046,166 @@
}
}
},
+ "/api/rest/2.0/auth/token/custom": {
+ "post": {
+ "operationId": "getCustomAccessToken",
+ "description": "\n Version: 10.4.0.cl or later\n\nGets an authentication token with custom rules and security attributes and creates a full session in ThoughtSpot for a given user. By default, the token obtained from ThoughtSpot remains valid for 5 mins.\n\nTo add a new user and assign privileges during auto creation, you need `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege and edit access to the data source is required.\n\nTo assign security attributes with filter rules and Parameters to the JWT token, you'll need administrator privileges and edit access to the data source (Worksheet or Model). If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege and edit access to the data source is required.\n\n#### Usage guidelines\n\nYou can generate the token for a user by providing a `username` and `password`, or by using the cluster’s `secret_key`.\n\nTo generate a `secret_key` on your cluster, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-auth#trusted-auth-enable) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**: When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n\n##### Attribute-Based Access Control (ABAC) with tokens\n\nTo implement Attribute-Based Access Control (ABAC) and assign security entitlements to users during session creation, you can generate a token with custom filtering rules and Parameters in the `filter_rules` and `parameter_values` array respectively. These attributes can be configured to persist on a specific set of objects for user sessions initiated using the token. Once defined, the rules are added to the user's `access_control_properties` object, after which all sessions will use the persisted values.\n\nFor more information, see [ABAC via tokens Documentation](https://developers.thoughtspot.com/docs/api-authv2#_get_tokens_with_custom_rules_and_filter_conditions).\n\n##### Just-in-time provisioning\n\nFor just-in-time user creation and provisioning, define the following attributes:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `groups`\n\nSet `auto_create` to `true` if the user is not available in ThoughtSpot. If the user already exists in ThoughtSpot and the `auto_create` parameter is set to `true` in the API request, the user properties such as the display name, email, Org and group assignment will not be updated with new values.\n\nFor more information, see [Just-in-time provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning).\n\n##### Important point to note\nAll options in the token creation APIs that define access to the content in ThoughtSpot will do so during the token creation and not when the token is being used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Persist options such as `APPEND`, `REPLACE`, `RESET` will persist security parameters on the user profile when the token is created, while Persist option `NONE` will not persist anything but will be honoured in the session.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": [
+ "Authentication",
+ "10.4.0.cl"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.",
+ "type": "string"
+ },
+ "password": {
+ "description": "Password of the user account",
+ "default": "",
+ "type": "string"
+ },
+ "secret_key": {
+ "description": "The secret key string provided by the ThoughtSpot application server. ThoughtSpot generates a secret key when Trusted authentication is enabled.",
+ "default": "",
+ "type": "string"
+ },
+ "validity_time_in_sec": {
+ "description": "Token validity duration in seconds",
+ "default": 300,
+ "type": "integer",
+ "format": "int32"
+ },
+ "org_identifier": {
+ "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.",
+ "type": "string"
+ },
+ "persist_option": {
+ "description": "Indicates whether the specified attributes should be persisted or not.",
+ "type": "string",
+ "enum": [
+ "APPEND",
+ "NONE",
+ "REPLACE",
+ "RESET"
+ ]
+ },
+ "filter_rules": {
+ "description": "Filter rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FilterRules"
+ }
+ },
+ "parameter_values": {
+ "description": "Parameter values.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParameterValues"
+ }
+ },
+ "objects": {
+ "description": "Objects on which the filter rules and parameters values should be applied to",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TokenAccessScopeObject"
+ }
+ },
+ "email": {
+ "description": "(just-in-time (JIT) provisioning)Email address of the user. Specify this attribute when creating a new user.",
+ "type": "string"
+ },
+ "display_name": {
+ "description": "(just-in-time (JIT) provisioning) Indicates display name of the user. Specify this attribute when creating a new user.",
+ "type": "string"
+ },
+ "groups": {
+ "description": "(just-in-time (JIT) provisioning) ID or name of the groups to which the newly created user belongs. Specify this attribute when creating a new user.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Group_Object"
+ }
+ },
+ "auto_create": {
+ "description": " Creates a new user if the specified username does not exist in ThoughtSpot. To provision a user just-in-time (JIT), set this attribute to true.\n \n\nNote: For JIT provisioning of a user, the secret_key is required.
Version: 10.5.0.cl or later",
+ "default": true,
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "required": [
+ "username",
+ "persist_option"
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "ABAC token creation was successful.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AccessToken"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid request. This could be due to missing or incorrect parameters.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized access. The request could not be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden access. The user does not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "An unexpected error occurred on the server.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "security": []
+ }
+ },
"/api/rest/2.0/users/create": {
"post": {
"operationId": "createUser",
- "description": "\n Version: 9.0.0.cl or later\n\nCreates a user in ThoughtSpot.\n\nThe API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nCreates a user in ThoughtSpot.\n\nThe API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -3965,7 +4225,7 @@
"type": "string"
},
"password": {
- "description": "Password for the user account.",
+ "description": "Password for the user account. For IAMv2 users, you must set this password if you do not want to trigger an activation email.",
"type": "string"
},
"email": {
@@ -3985,7 +4245,7 @@
]
},
"account_status": {
- "description": "Current status of the user account.",
+ "description": "Current status of the user account. The `SUSPENDED` user state indicates a transitional state applicable to IAMv2 users only.",
"default": "ACTIVE",
"type": "string",
"enum": [
@@ -3993,7 +4253,8 @@
"INACTIVE",
"EXPIRED",
"LOCKED",
- "PENDING"
+ "PENDING",
+ "SUSPENDED"
]
},
"org_identifiers": {
@@ -4088,7 +4349,7 @@
"nullable": true
},
"trigger_activation_email": {
- "description": "Flag to indicate whether activation email should be sent to user.",
+ "description": "Flag to indicate whether activation email should be sent to the user. Default value for IAMv2 users is set to true. Users must either set this to false, or enter a valid \npassword if they do not want to trigger an activation email.",
"type": "boolean",
"nullable": true
}
@@ -4161,7 +4422,7 @@
"/api/rest/2.0/users/{user_identifier}/update": {
"post": {
"operationId": "updateUser",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates a user object.\n\nYou can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a user object.\n\nYou can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -4193,14 +4454,15 @@
"type": "string"
},
"account_status": {
- "description": "Current status of the user account.",
+ "description": "Current status of the user account. The `SUSPENDED` user state indicates a transitional state applicable to IAMv2 users only.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"EXPIRED",
"LOCKED",
- "PENDING"
+ "PENDING",
+ "SUSPENDED"
]
},
"notify_on_share": {
@@ -4365,7 +4627,7 @@
"/api/rest/2.0/users/{user_identifier}/delete": {
"post": {
"operationId": "deleteUser",
- "description": "\n Version: 9.0.0.cl or later\n\nDeletes a user from the ThoughtSpot system.\n\nIf you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nDeletes a user from the ThoughtSpot system.\n\nIf you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -4431,7 +4693,7 @@
"/api/rest/2.0/users/import": {
"post": {
"operationId": "importUsers",
- "description": "\n Version: 9.0.0.cl or later\n\nImports user data from external databases into ThoughtSpot. During the user import operation:\n\n* If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional.\n* If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted.\n* If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nImports user data from external databases into ThoughtSpot. During the user import operation:\n\n* If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional.\n* If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted.\n* If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -4532,7 +4794,7 @@
"/api/rest/2.0/users/change-password": {
"post": {
"operationId": "changeUserPassword",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates the current password of the user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates the current password of the user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -4617,7 +4879,7 @@
"/api/rest/2.0/users/reset-password": {
"post": {
"operationId": "resetUserPassword",
- "description": "\n Version: 9.0.0.cl or later\n\nResets the password of a user account. Administrators can reset password on behalf of a user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nResets the password of a user account. Administrators can reset password on behalf of a user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -4697,7 +4959,7 @@
"/api/rest/2.0/users/force-logout": {
"post": {
"operationId": "forceLogoutUsers",
- "description": "\n Version: 9.0.0.cl or later\n\nEnforces logout on current user sessions. \n\nUse this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nEnforces logout on current user sessions. \n\nUse this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.0.0.cl"
@@ -4772,7 +5034,7 @@
"/api/rest/2.0/users/activate": {
"post": {
"operationId": "activateUser",
- "description": "\n Version: 9.7.0.cl or later\n\nActivates a deactivated user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\n\nTo activate an inactive user account, the API request body must include the following information:\n\n- Username or the GUID of the user account.\n- Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated.\n- Password for the user account.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.7.0.cl or later\n\nActivates a deactivated user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo activate an inactive user account, the API request body must include the following information:\n\n- Username or the GUID of the user account.\n- Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated.\n- Password for the user account.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.7.0.cl"
@@ -4794,6 +5056,10 @@
"password": {
"description": "New password for the user to access the account.",
"type": "string"
+ },
+ "properties": {
+ "description": "Properties of the user.",
+ "type": "string"
}
},
"required": [
@@ -4864,7 +5130,7 @@
"/api/rest/2.0/users/deactivate": {
"post": {
"operationId": "deactivateUser",
- "description": "\n Version: 9.7.0.cl or later\n\nDeactivates a user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\n\nTo deactivate a user account, the API request body must include the following information:\n\n- Username or the GUID of the user account\n- Base URL of the ThoughtSpot instance\n\nIf the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.7.0.cl or later\n\nDeactivates a user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo deactivate a user account, the API request body must include the following information:\n\n- Username or the GUID of the user account\n- Base URL of the ThoughtSpot instance\n\nIf the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Users",
"9.7.0.cl"
@@ -4951,7 +5217,7 @@
"/api/rest/2.0/system/config-update": {
"post": {
"operationId": "updateSystemConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nUpdates the current configuration of the cluster. You must send the configuration settings in JSON format.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nUpdates the current configuration of the cluster. You must send the configuration data in JSON format.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"System",
"9.2.0.cl"
@@ -5026,7 +5292,7 @@
"/api/rest/2.0/orgs/create": {
"post": {
"operationId": "createOrg",
- "description": "\n Version: 9.0.0.cl or later\n\nCreates an Org object.\n\nTo use this API, the [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview) feature must be enabled in your cluster.\n\nRequires cluster administration (**Can administer Org**) privileges.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nCreates an Org object.\n\nTo use this API, the [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview) feature must be enabled in your cluster.\n\nRequires cluster administration (**Can administer Org**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Orgs",
"9.0.0.cl"
@@ -5123,7 +5389,7 @@
"/api/rest/2.0/orgs/{org_identifier}/update": {
"post": {
"operationId": "updateOrg",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates an Org object. You can modify Org properties such as name, description, and user associations.\n\nRequires cluster administration (**Can administer Org**) privileges.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates an Org object. You can modify Org properties such as name, description, and user associations.\n\nRequires cluster administration (**Can administer Org**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Orgs",
"9.0.0.cl"
@@ -5233,7 +5499,7 @@
"/api/rest/2.0/orgs/{org_identifier}/delete": {
"post": {
"operationId": "deleteOrg",
- "description": "\n Version: 9.0.0.cl or later\n\nDeletes an Org object from the ThoughtSpot system.\n\nRequires cluster administration (**Can administer Org**) privilege.\n\nWhen you delete an Org, all its users and objects created in that Org context are removed. However, if the users in the deleted Org also exists in other Orgs, they are removed only from the deleted Org.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nDeletes an Org object from the ThoughtSpot system.\n\nRequires cluster administration (**Can administer Org**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\nWhen you delete an Org, all its users and objects created in that Org context are removed. However, if the users in the deleted Org also exists in other Orgs, they are removed only from the deleted Org.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Orgs",
"9.0.0.cl"
@@ -5299,7 +5565,7 @@
"/api/rest/2.0/tags/create": {
"post": {
"operationId": "createTag",
- "description": "\n Version: 9.0.0.cl or later\n\nCreates a tag object.\n\nTags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nCreates a tag object.\n\nTags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Tags",
"9.0.0.cl"
@@ -5403,7 +5669,7 @@
"/api/rest/2.0/tags/{tag_identifier}/update": {
"post": {
"operationId": "updateTag",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates a tag object.\n\nYou can modify the `name` and `color` properties of a tag object. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates a tag object.\n\nYou can modify the `name` and `color` properties of a tag object. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Tags",
"9.0.0.cl"
@@ -5489,7 +5755,7 @@
"/api/rest/2.0/tags/{tag_identifier}/delete": {
"post": {
"operationId": "deleteTag",
- "description": "\n Version: 9.0.0.cl or later\n\nDeletes a tag object from the ThoughtSpot system\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nDeletes a tag object from the ThoughtSpot system\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Tags",
"9.0.0.cl"
@@ -5727,7 +5993,7 @@
"/api/rest/2.0/groups/create": {
"post": {
"operationId": "createUserGroup",
- "description": "\n Version: 9.0.0.cl or later\n\nCreates a group object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### About groups\nGroups in ThoughtSpot are used by the administrators to define privileges and organize users based on their roles and access requirements. To know more about groups and privileges, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/groups-privileges).\n\n#### Supported operations\n\nThe API endpoint lets you perform the following operations:\n\n* Assign [privileges](https://developers.thoughtspot.com/docs/?pageid=api-user-management#group-privileges)\n* Add users\n* Define sharing visibility\n* Add sub-groups\n* Assign a default Liveboard\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nCreates a group object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n#### About groups\nGroups in ThoughtSpot are used by the administrators to define privileges and organize users based on their roles and access requirements. To know more about groups and privileges, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/groups-privileges).\n\n#### Supported operations\n\nThe API endpoint lets you perform the following operations:\n\n* Assign privileges\n* Add users\n* Define sharing visibility\n* Add sub-groups\n* Assign a default Liveboard\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Groups",
"9.0.0.cl"
@@ -5788,7 +6054,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
}
},
@@ -5899,7 +6166,7 @@
"/api/rest/2.0/groups/{group_identifier}/update": {
"post": {
"operationId": "updateUserGroup",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a group object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Supported operations\n\nThis API endpoint lets you perform the following operations in a single API request:\n\n* Edit [privileges](https://developers.thoughtspot.com/docs/?pageid=api-user-management#group-privileges)\n* Add or remove users\n* Change sharing visibility settings\n* Add or remove sub-groups\n* Assign a default Liveboard or update the existing settings\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a group object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n#### Supported operations\n\nThis API endpoint lets you perform the following operations in a single API request:\n\n* Edit [privileges](https://developers.thoughtspot.com/docs/?pageid=api-user-management#group-privileges)\n* Add or remove users\n* Change sharing visibility settings\n* Add or remove sub-groups\n* Assign a default Liveboard or update the existing settings\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Groups",
"9.0.0.cl"
@@ -5960,7 +6227,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
}
},
@@ -6078,7 +6346,7 @@
"/api/rest/2.0/groups/{group_identifier}/delete": {
"post": {
"operationId": "deleteUserGroup",
- "description": "\n Version: 9.0.0.cl or later\n\nRemoves the specified group object from the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nRemoves the specified group object from the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Groups",
"9.0.0.cl"
@@ -6144,7 +6412,7 @@
"/api/rest/2.0/groups/import": {
"post": {
"operationId": "importUserGroups",
- "description": "\n Version: 9.0.0.cl or later\n\nImports group objects from external databases into ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nDuring the import operation:\n\n* If the specified group is not available in ThoughtSpot, it will be added to ThoughtSpot.\n* If `delete_unspecified_groups` is set to `true`, the groups not specified in the API request, excluding administrator and system user groups, are deleted.\n* If the specified groups are already available in ThoughtSpot, the object properties of these groups are modified and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nImports group objects from external databases into ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\nDuring the import operation:\n\n* If the specified group is not available in ThoughtSpot, it will be added to ThoughtSpot.\n* If `delete_unspecified_groups` is set to `true`, the groups not specified in the API request, excluding administrator and system user groups, are deleted.\n* If the specified groups are already available in ThoughtSpot, the object properties of these groups are modified and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Groups",
"9.0.0.cl"
@@ -6238,7 +6506,7 @@
"/api/rest/2.0/metadata/tml/import": {
"post": {
"operationId": "importMetadataTML",
- "description": "\n Version: 9.0.0.cl or later\n\nImports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege.\n\n#### Usage guidelines\n\n* Import all related objects in a single TML Import API call. For example, Tables that use the same Connection object and Worksheets connected to these Tables.\n* Include the `fqn` property to distinguish objects that have the same name.\n For example, if you have multiple Connections or Worksheets with the same name on ThoughtSpot and the Connection or Worksheet referenced in your TML file does not have a unique name to distinguish, it may result in invalid object references.\n Adding `fqn` helps ThoughtSpot differentiate a Table from another with the same name.\n We recommend [exporting TML with FQNs](#/http/api-endpoints/metadata/export-metadata-tml) and using these during the import operation.\n* You can upload multiple TML files at a time.\n If you import a Worksheet along with Liveboards, Answers, and other dependent objects in a single API call, the imported objects will be immediately available for use.\n When you import only a Worksheet object, it may take some time for the Worksheet to become available in the ThoughtSpot system. Please wait for a few minutes, and then proceed to create an Answer and Liveboard from the newly imported Worksheet.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nImports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### Usage guidelines\n\n* Import all related objects in a single TML Import API call. For example, Tables that use the same Connection object and Worksheets connected to these Tables.\n* Include the `fqn` property to distinguish objects that have the same name.\n For example, if you have multiple Connections or Worksheets with the same name on ThoughtSpot and the Connection or Worksheet referenced in your TML file does not have a unique name to distinguish, it may result in invalid object references.\n Adding `fqn` helps ThoughtSpot differentiate a Table from another with the same name.\n We recommend [exporting TML with FQNs](#/http/api-endpoints/metadata/export-metadata-tml) and using these during the import operation.\n* You can upload multiple TML files at a time.\n If you import a Worksheet along with Liveboards, Answers, and other dependent objects in a single API call, the imported objects will be immediately available for use.\n When you import only a Worksheet object, it may take some time for the Worksheet to become available in the ThoughtSpot system. Please wait for a few minutes, and then proceed to create an Answer and Liveboard from the newly imported Worksheet.\n\nFor more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_import_a_tml).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"9.0.0.cl"
@@ -6250,7 +6518,7 @@
"type": "object",
"properties": {
"metadata_tmls": {
- "description": "Details of TML objects.\n**Note: importing TML in YAML format, when coming directly from our Playground, is currently requires manual formatting. For more details on the workaround, please click [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_cl)**",
+ "description": "Details of TML objects.\n\n**Note: importing TML in YAML format, when coming directly from our Playground, is currently requires manual formatting. For more details on the workaround, please click [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_cl)**",
"type": "array",
"items": {
"type": "string"
@@ -6278,6 +6546,24 @@
"default": false,
"type": "boolean",
"nullable": true
+ },
+ "skip_cdw_validation_for_tables": {
+ "description": "Boolean to indicate if the CDW validation for table imports should be skipped.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ },
+ "skip_diff_check": {
+ "description": "Version: 10.6.0.cl or later
\n\nBoolean Flag to skip TML diff check before processing object TMLs.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ },
+ "enable_large_metadata_validation": {
+ "description": "Version: 10.5.0.cl or later
\n\nBoolean to indicate if the large metadata validation should be enabled.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
}
},
"required": [
@@ -6349,7 +6635,7 @@
"/api/rest/2.0/metadata/tml/async/import": {
"post": {
"operationId": "importMetadataTMLAsync",
- "description": " Version: 10.4.0.cl or later",
+ "description": "\n Version: 10.4.0.cl or later\n\nSchedules a task to import [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. You can use this API endpoint to process TML objects asynchronously when importing TMLs of large and complex metadata objects into ThoughtSpot. Unlike the synchronous import TML operation, the API processes TML data in the background and returns a task ID, which can be used to check the status of the import task via `/api/rest/2.0/metadata/tml/async/status` API endpoint.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege, and edit access to the TML objects.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### Usage guidelines\n\nSee [Async TML API Documentation](https://developers.thoughtspot.com/docs/tml#_import_tml_objects_asynchronously) for usage guidelines.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"10.4.0.cl"
@@ -6378,13 +6664,42 @@
"default": false,
"type": "boolean",
"nullable": true
- }
- },
- "required": [
- "metadata_tmls"
- ]
- }
- }
+ },
+ "skip_cdw_validation_for_tables": {
+ "description": "Boolean to indicate if the CDW validation for table imports should be skipped.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ },
+ "import_policy": {
+ "description": "Version: 10.5.0.cl or later
\n\nPolicy to be followed while importing the TML. Valid values are [PARTIAL_OBJECT, PARTIAL, VALIDATE_ONLY, ALL_OR_NONE]",
+ "default": "PARTIAL_OBJECT",
+ "type": "string",
+ "enum": [
+ "PARTIAL",
+ "ALL_OR_NONE",
+ "VALIDATE_ONLY",
+ "PARTIAL_OBJECT"
+ ]
+ },
+ "skip_diff_check": {
+ "description": "Version: 10.6.0.cl or later
\n\nBoolean Flag to skip TML diff check before processing object TMLs.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ },
+ "enable_large_metadata_validation": {
+ "description": "Version: 10.5.0.cl or later
\n\nBoolean to indicate if the large metadata validation should be enabled.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "required": [
+ "metadata_tmls"
+ ]
+ }
+ }
},
"required": true
},
@@ -6446,7 +6761,7 @@
"/api/rest/2.0/metadata/tml/export": {
"post": {
"operationId": "exportMetadataTML",
- "description": "\n Version: 9.0.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege.\n\n#### Usage guidelines\n\n* You can export one or several objects by passing metadata object GUIDs in the `metadata` array.\n* When exporting TML content for a Liveboard or Answer object, you can set `export_associated` to `true` to retrieve TML content for underlying Worksheets, Tables, or Views, including the GUID of each object within the headers. When `export_associated` is set to `true`, consider retrieving one metadata object at a time.\n* Set `export_fqns` to `true` to add FQNs of the referenced objects in the TML content. For example, if you send an API request to retrieve TML for a Liveboard and its associated objects, the API returns the TML content with FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if ThoughtSpot has multiple objects with the same name and you want to eliminate ambiguity when importing TML files into ThoughtSpot. It eliminates the need for adding FQNs of the referenced objects manually during the import operation.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\nRequires `DATADOWNLOADING` (**Can download Data**) and at least view access to the metadata object.\n\n#### Usage guidelines\n\n* You can export one or several objects by passing metadata object GUIDs in the `metadata` array.\n* When exporting TML content for a Liveboard or Answer object, you can set `export_associated` to `true` to retrieve TML content for underlying Worksheets, Tables, or Views, including the GUID of each object within the headers. When `export_associated` is set to `true`, consider retrieving one metadata object at a time.\n* Set `export_fqns` to `true` to add FQNs of the referenced objects in the TML content. For example, if you send an API request to retrieve TML for a Liveboard and its associated objects, the API returns the TML content with FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if ThoughtSpot has multiple objects with the same name and you want to eliminate ambiguity when importing TML files into ThoughtSpot. It eliminates the need for adding FQNs of the referenced objects manually during the import operation.\n\nFor more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_export_a_tml).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"9.0.0.cl"
@@ -6477,7 +6792,7 @@
"nullable": true
},
"edoc_format": {
- "description": "TML EDOC content format.\n**Note: exporting in YAML format currently requires manual formatting of the output. For more details on the workaround, please click [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_cl)**",
+ "description": "TML EDOC content format.\n\n**Note: exporting in YAML format currently requires manual formatting of the output. For more details on the workaround, please click [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_cl)**",
"default": "JSON",
"type": "string",
"enum": [
@@ -6512,6 +6827,14 @@
"default": false,
"type": "boolean",
"nullable": true
+ },
+ "export_options": {
+ "description": "Flags to specify additional options for export.
Version: 10.6.0.cl or later",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Export_Options"
+ }
+ ]
}
},
"required": [
@@ -6583,7 +6906,7 @@
"/api/rest/2.0/metadata/tml/export/batch": {
"post": {
"operationId": "exportMetadataTMLBatched",
- "description": " Version: 10.1.0.cl or later",
+ "description": "\n Version: 10.1.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\n#### Usage guidelines\n\n* You can export one or several objects by passing metadata object GUIDs in the `metadata` array.\n* When exporting TML content for a Liveboard or Answer object, you can set `export_associated` to `true` to retrieve TML content for underlying Worksheets, Tables, or Views, including the GUID of each object within the headers. When `export_associated` is set to `true`, consider retrieving one metadata object at a time.\n* Set `export_fqns` to `true` to add FQNs of the referenced objects in the TML content. For example, if you send an API request to retrieve TML for a Liveboard and its associated objects, the API returns the TML content with FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if ThoughtSpot has multiple objects with the same name and you want to eliminate ambiguity when importing TML files into ThoughtSpot. It eliminates the need for adding FQNs of the referenced objects manually during the import operation.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"10.1.0.cl"
@@ -6703,7 +7026,7 @@
"/api/rest/2.0/metadata/delete": {
"post": {
"operationId": "deleteMetadata",
- "description": "\n Version: 9.0.0.cl or later\n\nRemoves the specified metadata object from the ThoughtSpot system.\n\nRequires edit access to the metadata object or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nRemoves the specified metadata object from the ThoughtSpot system.\n\nRequires edit access to the metadata object. \n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"9.0.0.cl"
@@ -6787,7 +7110,7 @@
"/api/rest/2.0/metadata/copyobject": {
"post": {
"operationId": "copyObject",
- "description": "\nMakes a copy of an Answer or Liveboard saved in Atlas
Version: 10.3.0.cl or later\n\nCreates a copy of the metadata object specified in the API request.\n\nRequires create access to metadata objects\n\nUpon successful execution, the API returns the id of the new object which is copied from the given object.\n\n\n\n#### Endpoint URL\n",
+ "description": "\nMakes a copy of an Answer or Liveboard saved in Atlas
Version: 10.3.0.cl or later\n\nCreates a copy of a metadata object.\n\nRequires at least view access to the metadata object being copied.\n\nUpon successful execution, the API creates a copy of the metadata object specified in the API request and returns the ID of the new object.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"10.3.0.cl"
@@ -6892,10 +7215,190 @@
}
}
},
+ "/api/rest/2.0/metadata/worksheets/convert": {
+ "post": {
+ "operationId": "convertWorksheetToModel",
+ "description": "\nConvert worksheets to models
Version: 10.6.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **worksheet_ids** \n - **Description:** A comma-separated list of GUIDs (Globally Unique Identifiers) specifying the Worksheets to be converted. \n - **Usage:** \n - Used only when `convert_all` is set to `false`. \n - Leave empty or omit when `convert_all` is set to `true`.\n\n2. **exclude_worksheet_ids** \n - **Description:** A comma-separated list of GUIDs specifying Worksheets to be excluded from conversion. \n - **Usage:** \n - Useful when `convert_all` is set to `true` and specific Worksheets should not be converted.\n\n3. **convert_all** \n - **Description:** Sets the scope of conversion.\n - **Options:** \n - `true`: Converts all Worksheets in the system, except those specified in `exclude_worksheet_ids`. \n - `false`: Converts only the Worksheets listed in `worksheet_ids`.\n\n4. **apply_changes** \n - **Description:** Specifies whether to apply changes directly to ThoughtSpot or to generate a preview before applying any changes.Used for validation of conversion.\n - **Options:** \n - `true`: Applies conversion changes directly to ThoughtSpot.\n - `false`: Generates only a preview of the changes and does not apply any changes to ThoughtSpot\n\n---\n\n## Best Practices\n\n1. **Backup Before Conversion:** \n Always export metadata as a backup before initiating the conversion process\n\n2. **Partial Conversion for Testing:** \n Test the conversion process by setting `convert_all` to `false` and specifying a small number of `worksheet_ids`.\n\n3. **Verify Dependencies:** \n Check for dependent objects, such as Tables and Connections, to avoid invalid references.\n\n4. **Review Changes:** \n Use `apply_changes: false` to preview the impact of the conversion before applying changes.\n\n---\n\n## Examples\n\n### Convert Specific Worksheets\n```json\n{\n \"worksheet_ids\": [\"guid1\", \"guid2\", \"guid3\"],\n \"exclude_worksheet_ids\": [],\n \"convert_all\": false,\n \"apply_changes\": true\n}\n```\n\n### Convert All Accessible Worksheets\n```json\n{\n \"worksheet_ids\": [],\n \"exclude_worksheet_ids\": [],\n \"convert_all\": true,\n \"apply_changes\": true\n}\n```\n\n### Exclude Specific Worksheets While Converting All Accessible Worksheets\n```json\n{\n \"worksheet_ids\": [],\n \"exclude_worksheet_ids\": [\"abc\"],\n \"convert_all\": true,\n \"apply_changes\": true\n}\n```\n\n\n\n#### Endpoint URL\n",
+ "tags": [
+ "Metadata",
+ "10.6.0.cl"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "worksheet_ids": {
+ "description": "List of Worksheet IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "exclude_worksheet_ids": {
+ "description": "List of Worksheet IDs to be excluded.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "convert_all": {
+ "description": "Indicates whether all the worksheet needs to be converted to models.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ },
+ "apply_changes": {
+ "description": "Indicates whether the changes should be applied to database.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Conversion of worksheets to model done successfully.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResponseWorksheetToModelConversion"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/metadata/headers/update": {
+ "post": {
+ "operationId": "updateMetadataHeader",
+ "description": "\nUpdate header attributes for a given list of header objects.
Beta Version: 10.6.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `ORG_ADMINISTRATION` (Can manage orgs).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **headers_update** \n - **Description:** List of header objects with their attributes to be updated. Each object contains a list of attributes to be updated in the header.\n - **Usage:**\n - You must provide either `identifier` or `obj_identifier`, but not both. Both fields cannot be empty.\n - When `org_identifier` is set to `-1`, only the `identifier` value is accepted; `obj_identifier` is not allowed.\n\n2. **org_identifier** \n - **Description:** GUID (Globally Unique Identifier) or name of the organization. \n - **Usage:**\n - Leaving this field empty assumes that the changes should be applied to the current organization \n - Provide `org_guid` or `org_name` to uniquely identify the organization where changes need to be applied. .\n - Provide `-1` if changes have to be applied across all the org.\n\n---\n\n## Note\nCurrently, this API is enabled only for updating the `obj_identifier` attribute. Only `text` will be allowed in attribute's value.\n\n## Best Practices\n\n1. **Backup Before Conversion:** \n Always export metadata as a backup before initiating the update process\n\n---\n\n## Examples\n\n### Only `identifier` is given \n```json\n{\n \"headers_update\":\n [\n {\n \"identifier\": \"guid_1\",\n \"obj_identifier\": \"\",\n \"type\": \"LOGICAL_COLUMN\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": \"orgGuid\"\n}\n```\n\n### Only `obj_identifier` is given\n```json\n{\n \"headers_update\":\n [\n {\n \"obj_identifier\": \"custom_object_id\",\n \"type\": \"ANSWER\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": \"orgName\"\n}\n```\n\n### Executing update for all org `-1`\n```json\n{\n \"headers_update\":\n [\n {\n \"identifier\": \"guid_1\",\n \"type\": \"ANSWER\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": -1\n}\n```\n\n### Optional `type` is not provided\n```json\n{\n \"headers_update\":\n [\n {\n \"identifier\": \"guid_1\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": -1\n}\n```\n\n\n\n#### Endpoint URL\n",
+ "tags": [
+ "Metadata",
+ "10.6.0.cl"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "headers_update": {
+ "description": "List of header objects to update.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/HeaderUpdateInput"
+ }
+ },
+ "org_identifier": {
+ "description": "Unique ID or name of the organization.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "Headers update was successful."
+ },
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/rest/2.0/security/metadata/assign": {
"post": {
"operationId": "assignChangeAuthor",
- "description": "\n Version: 9.0.0.cl or later\n\nTransfers the ownership of one or several objects from one user to another.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.0.0.cl or later\n\nTransfers the ownership of one or several objects from one user to another.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege and edit access to the objects are required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Security",
"9.0.0.cl"
@@ -6994,12 +7497,14 @@
"type": "object",
"properties": {
"metadata_type": {
- "description": "Type of metadata. Required if identifier in metadata_identifies is a name\".\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.",
+ "description": "Type of metadata. Required if identifier in metadata_identifies is a name.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN",
"type": "string",
"enum": [
"LIVEBOARD",
"ANSWER",
- "LOGICAL_TABLE"
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION"
]
},
"metadata_identifiers": {
@@ -7032,6 +7537,7 @@
},
"emails": {
"description": "Email IDs to which notifications will be sent.",
+ "default": [],
"type": "array",
"items": {
"type": "string"
@@ -7062,7 +7568,6 @@
},
"required": [
"permissions",
- "emails",
"message"
]
}
@@ -7121,7 +7626,7 @@
"/api/rest/2.0/vcs/git/config/create": {
"post": {
"operationId": "createConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nAllows you to connect a ThoughtSpot instance to a Git repository.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nYou can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository.\n\nBefore using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites:\n\n* You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\n\n* Your access token has `repo` scope that grants full access to public and private repositories.\n* Your Git repository has a branch that can be configured as a default branch in ThoughtSpot.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration).\n\n**Note**: ThoughtSpot supports only GitHub / GitHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nAllows you to connect a ThoughtSpot instance to a Git repository.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\nYou can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository.\n\nBefore using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites:\n\n* You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\n\n* Your access token has `repo` scope that grants full access to public and private repositories.\n* Your Git repository has a branch that can be configured as a default branch in ThoughtSpot.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration).\n\n**Note**: ThoughtSpot supports only GitHub / GitHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Version Control",
"9.2.0.cl"
@@ -7238,7 +7743,7 @@
"/api/rest/2.0/vcs/git/config/update": {
"post": {
"operationId": "updateConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nUpdates Git repository configuration settings.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nUpdates Git repository configuration settings.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Version Control",
"9.2.0.cl"
@@ -7345,7 +7850,7 @@
"/api/rest/2.0/vcs/git/config/delete": {
"post": {
"operationId": "deleteConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nDeletes Git repository configuration from your ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nDeletes Git repository configuration from your ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Version Control",
"9.2.0.cl"
@@ -7623,7 +8128,7 @@
"/api/rest/2.0/vcs/git/branches/validate": {
"post": {
"operationId": "validateMerge",
- "description": "\n Version: 9.2.0.cl or later\n\nValidates the content of your source branch against the objects in your destination environment.\n\nBefore merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nValidates the content of your source branch against the objects in your destination environment.\n\nBefore merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Version Control",
"9.2.0.cl"
@@ -7821,7 +8326,7 @@
"/api/rest/2.0/connection/create": {
"post": {
"operationId": "createConnection",
- "description": "\n Version: 9.2.0.cl or later\n\nCreates a connection to a data warehouse for live query services. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Create a connection without tables\n\nTo create a connection without tables:\n\n1. Pass these parameters in your API request.\n * Name of the connection.\n * Type of the data warehouse to connect to.\n * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a SnowFlake connection:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"externalDatabases\":[\n\n ]\n }\n ```\n2. Set `validate` to `false`.\n\n#### Create a connection with tables\n\nTo create a connection with tables:\n\n1. Pass these parameters in your API request.\n * Name of the connection.\n * Type of the data warehouse to connect to.\n * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"externalDatabases\":[\n {\n \"name\":\"AllDatatypes\",\n \"isAutoCreated\":false,\n \"schemas\":[\n {\n \"name\":\"alldatatypes\",\n \"tables\":[\n {\n \"name\":\"allDatatypes\",\n \"type\":\"TABLE\",\n \"description\":\"\",\n \"selected\":true,\n \"linked\":true,\n \"columns\":[\n {\n \"name\":\"CNUMBER\",\n \"type\":\"INT64\",\n \"canImport\":true,\n \"selected\":true,\n \"isLinkedActive\":true,\n \"isImported\":false,\n \"tableName\":\"allDatatypes\",\n \"schemaName\":\"alldatatypes\",\n \"dbName\":\"AllDatatypes\"\n },\n {\n \"name\":\"CDECIMAL\",\n \"type\":\"INT64\",\n \"canImport\":true,\n \"selected\":true,\n \"isLinkedActive\":true,\n \"isImported\":false,\n \"tableName\":\"allDatatypes\",\n \"schemaName\":\"alldatatypes\",\n \"dbName\":\"AllDatatypes\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ```\n2. Set `validate` to `true`.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nCreates a connection to a data warehouse for live query services. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n#### Create a connection without tables\n\nTo create a connection without tables:\n\n1. Pass these parameters in your API request.\n * Name of the connection.\n * Type of the data warehouse to connect to.\n * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a SnowFlake connection:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"externalDatabases\":[\n\n ]\n }\n ```\n2. Set `validate` to `false`.\n\n#### Create a connection with tables\n\nTo create a connection with tables:\n\n1. Pass these parameters in your API request.\n * Name of the connection.\n * Type of the data warehouse to connect to.\n * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"externalDatabases\":[\n {\n \"name\":\"AllDatatypes\",\n \"isAutoCreated\":false,\n \"schemas\":[\n {\n \"name\":\"alldatatypes\",\n \"tables\":[\n {\n \"name\":\"allDatatypes\",\n \"type\":\"TABLE\",\n \"description\":\"\",\n \"selected\":true,\n \"linked\":true,\n \"columns\":[\n {\n \"name\":\"CNUMBER\",\n \"type\":\"INT64\",\n \"canImport\":true,\n \"selected\":true,\n \"isLinkedActive\":true,\n \"isImported\":false,\n \"tableName\":\"allDatatypes\",\n \"schemaName\":\"alldatatypes\",\n \"dbName\":\"AllDatatypes\"\n },\n {\n \"name\":\"CDECIMAL\",\n \"type\":\"INT64\",\n \"canImport\":true,\n \"selected\":true,\n \"isLinkedActive\":true,\n \"isImported\":false,\n \"tableName\":\"allDatatypes\",\n \"schemaName\":\"alldatatypes\",\n \"dbName\":\"AllDatatypes\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ```\n2. Set `validate` to `true`.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
"9.2.0.cl"
@@ -7873,7 +8378,10 @@
"GCP_POSTGRESQL",
"GCP_MYSQL",
"MODE",
- "GOOGLE_SHEETS"
+ "GOOGLE_SHEETS",
+ "FALCON",
+ "FALCON_ONPREM",
+ "CLICKHOUSE"
]
},
"data_warehouse_config": {
@@ -7955,7 +8463,8 @@
"/api/rest/2.0/connection/delete": {
"post": {
"operationId": "deleteConnection",
- "description": "\n Version: 9.2.0.cl or later\n\nDeletes a connection object.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nDeletes a connection object.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "deprecated": true,
"tags": [
"Connections",
"9.2.0.cl"
@@ -8027,13 +8536,13 @@
}
}
},
- "/api/rest/2.0/connections/delete/{connection_identifier}": {
+ "/api/rest/2.0/connections/{connection_identifier}/delete": {
"post": {
"operationId": "deleteConnectionV2",
- "description": "\n Version: 10.0.0.cl or later\n\nDeletes a connection object.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 10.4.0.cl or later\n\nDeletes a connection object.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
- "10.0.0.cl"
+ "10.4.0.cl"
],
"parameters": [
{
@@ -8096,7 +8605,8 @@
"/api/rest/2.0/connection/update": {
"post": {
"operationId": "updateConnection",
- "description": "\n Version: 9.2.0.cl or later\n\nUpdates a connection object. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n b. Set `validate` to `true`.\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.2.0.cl or later\n\nUpdates a connection object. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n b. Set `validate` to `true`.\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n\n\n\n#### Endpoint URL\n",
+ "deprecated": true,
"tags": [
"Connections",
"9.2.0.cl"
@@ -8186,13 +8696,13 @@
}
}
},
- "/api/rest/2.0/connections/update/{connection_identifier}": {
+ "/api/rest/2.0/connections/{connection_identifier}/update": {
"post": {
"operationId": "updateConnectionV2",
- "description": "\n Version: 10.0.0.cl or later\n\nUpdates a connection object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n b. Set `validate` to `true`.\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 10.4.0.cl or later\n\nUpdates a connection object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n b. Set `validate` to `true`.\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
- "10.0.0.cl"
+ "10.4.0.cl"
],
"requestBody": {
"content": {
@@ -8285,7 +8795,7 @@
"/api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}": {
"post": {
"operationId": "fetchConnectionDiffStatus",
- "description": "\n Version: 9.9.0.cl or later\n\nValidates the difference in connection metadata between CDW and ThoughtSpot\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege\n\nReturns a boolean indicating whether there is any difference between the connection metadata at ThoughtSpot and CDW.\n\nTo get the connection metadata difference status, pass the connection GUID as `connection_identifier` in the API request.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.9.0.cl or later\n\nValidates the difference in connection metadata between CDW and ThoughtSpot.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\nReturns a boolean indicating whether there is any difference between the connection metadata at ThoughtSpot and CDW.\n\nTo get the connection metadata difference status, pass the connection GUID as `connection_identifier` in the API request.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
"9.9.0.cl"
@@ -8358,7 +8868,7 @@
"/api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}": {
"post": {
"operationId": "downloadConnectionMetadataChanges",
- "description": "\n Version: 9.9.0.cl or later\n\nExports the difference in connection metadata between CDW and ThoughtSpot\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege\n\nTo download the connection metadata difference between ThoughtSpot and CDW, pass the connection GUID as `connection_identifier` in the API request.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.9.0.cl or later\n\nExports the difference in connection metadata between CDW and ThoughtSpot\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: \n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\nTo download the connection metadata difference between ThoughtSpot and CDW, pass the connection GUID as `connection_identifier` in the API request.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
"9.9.0.cl"
@@ -8427,7 +8937,7 @@
"/api/rest/2.0/roles/create": {
"post": {
"operationId": "createRole",
- "description": "Creates a Role.\nRequires cluster Administration or Role Administration privileges.
Version: 9.5.0.cl or later",
+ "description": "\n Version: 9.5.0.cl or later\n\nCreates a Role object in ThoughtSpot.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
@@ -8483,9 +8993,16 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
}
+ },
+ "read_only": {
+ "description": "Version: 10.5.0.cl or later
\n\nIndicates whether the role is read only. A readonly role can neither be updated nor deleted.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
}
},
"required": [
@@ -8554,7 +9071,7 @@
"/api/rest/2.0/roles/{role_identifier}/update": {
"post": {
"operationId": "updateRole",
- "description": "Updates a Role.\nRequires cluster Administration or Role Administration privileges.
Version: 9.5.0.cl or later",
+ "description": "\n Version: 9.5.0.cl or later\n\nUpdates the properties of a Role object.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
@@ -8690,7 +9207,7 @@
"/api/rest/2.0/roles/{role_identifier}/delete": {
"post": {
"operationId": "deleteRole",
- "description": "Deletes a Role.\nRequires cluster Administration or Role Administration privileges.
Version: 9.5.0.cl or later",
+ "description": "\n Version: 9.5.0.cl or later\n\nDeletes a Role object from the ThoughtSpot system.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
@@ -8703,7 +9220,7 @@
"schema": {
"type": "string"
},
- "description": "Unique ID or name of the Role."
+ "description": "Unique ID or name of the Role. ReadOnly roles cannot be deleted."
}
],
"responses": {
@@ -8756,7 +9273,7 @@
"/api/rest/2.0/schedules/create": {
"post": {
"operationId": "createSchedule",
- "description": "\nCreate schedule.
Version: 9.4.0.cl or later\n\nCreates a Liveboard schedule job.\n\nRequires at least edit access to Liveboards. To create a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\n\n#### Usage guidelines\n\n* The description text is mandatory. The description text appears as **Description: ** in the Liveboard schedule email notifications.\n* The API endpoint supports exporting Liveboard data to the recipients in CSV or PDF format. If your Liveboard has tables, you can set `file_format` to CSV to send CSV files in the email notification to the recipients. For PDF generation, you can define PDF layout options.\n* To include only specific visualizations, specify the visualization GUIDs in the `visualization_identifiers` array.\n* You can schedule a Liveboard job to run periodically by setting frequency parameters. You can set the schedule to run daily, weekly, monthly or every n minutes or hours. The scheduled job can also be configured to run at a specific time of the day or on specific days of the week or month.\n* If the `frequency` parameters are defined, you can set the time zone to a value that matches your server's time zone. For example, `US/Central`, `Etc/UTC`, `CET`. The default time zone is `America/Los_Angeles`.\n\nFor more information about Liveboard jobs, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/liveboard-schedule).\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\nCreate schedule.
Version: 9.4.0.cl or later\n\nCreates a Liveboard schedule job.\n\nRequires at least edit access to Liveboards. To create a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\n#### Usage guidelines\n\n* The description text is mandatory. The description text appears as **Description: ** in the Liveboard schedule email notifications.\n* For Liveboards with both charts and tables, schedule creation is only supported in PDF and XLS formats. Schedules created in CSV formats for such Liveboards will fail to run. If `PDF` is set as the `file_format`, enable `pdf_options` to get the correct attachment. Not doing so may cause the attachment to be rendered empty.\n* To include only specific visualizations, specify the visualization GUIDs in the `visualization_identifiers` array.\n* You can schedule a Liveboard job to run periodically by setting frequency parameters. You can set the schedule to run daily, weekly, monthly or every n minutes or hours. The scheduled job can also be configured to run at a specific time of the day or on specific days of the week or month. Please ensure that when setting the schedule frequency for _minute of the object_, only values that are multiples of 5 are included.\n* If the `frequency` parameters are defined, you can set the time zone to a value that matches your server's time zone. For example, `US/Central`, `Etc/UTC`, `CET`. The default time zone is `America/Los_Angeles`.\n\nFor more information about Liveboard jobs, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/liveboard-schedule).\n\n\n\n#### Endpoint URL\n",
"tags": [
"Schedules",
"9.4.0.cl"
@@ -9537,7 +10054,7 @@
"/api/rest/2.0/schedules/{schedule_identifier}/delete": {
"post": {
"operationId": "deleteSchedule",
- "description": "\nDeletes a scheduled job.
Version: 9.4.0.cl or later\n\nDeletes a scheduled Liveboard job.\n\nRequires at least edit access to Liveboard or `ADMINISTRATION` (**Can administer Org**) privilege. \n\n\n\n\n#### Endpoint URL\n",
+ "description": "\nDeletes a scheduled job.
Version: 9.4.0.cl or later\n\nDeletes a scheduled Liveboard job.\n\nRequires at least edit access to Liveboard or `ADMINISTRATION` (**Can administer Org**) privilege. \nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Schedules",
"9.4.0.cl"
@@ -9721,7 +10238,7 @@
"/api/rest/2.0/schedules/{schedule_identifier}/update": {
"post": {
"operationId": "updateSchedule",
- "description": "\nUpdate schedule.
Version: 9.4.0.cl or later\n\nUpdates a scheduled Liveboard job.\n\nRequires at least edit access to Liveboards. To update a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\n\nThe API endpoint allows you to pause a scheduled job, change the status of a paused job. You can also edit the recipients list, frequency of the job, format of the file to send to the recipients in email notifications, PDF options, and time zone setting.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\nUpdate schedule.
Version: 9.4.0.cl or later\n\nUpdates a scheduled Liveboard job.\n\nRequires at least edit access to Liveboards. To update a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\nThe API endpoint allows you to pause a scheduled job, change the status of a paused job. You can also edit the recipients list, frequency of the job, format of the file to send to the recipients in email notifications, PDF options, and time zone setting.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Schedules",
"9.4.0.cl"
@@ -10503,7 +11020,7 @@
"/api/rest/2.0/customization/custom-actions": {
"post": {
"operationId": "createCustomAction",
- "description": "\n Version: 9.6.0.cl or later\n\nCreates a custom action that appears as a menu action on a saved Answer or Liveboard visualization.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Usage Guidelines\n\nThe API lets you create the following types of custom actions:\n\n* URL-based action \n Allows pushing data to an external URL.\n* Callback action \n Triggers a callback to the host application and initiates a response payload on an embedded ThoughtSpot instance.\n\nBy default, custom actions are visible to only administrator or developer users. To make a custom action available to other users, and specify the groups in `group_identifiers`.\n\nBy default, the custom action is set as a _global_ action on all visualizations and saved Answers. To assign a custom action to specific Liveboard visualization, saved Answer, or Worksheet, set `visibility` to `false` in `default_action_config` property and specify the GUID or name of the object in `associate_metadata`.\n\nFor more information, see [Custom actions](https://developers.thoughtspot.com/docs/?pageid=custom-action-intro).\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.6.0.cl or later\n\nCreates a custom action that appears as a menu action on a saved Answer or Liveboard visualization.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n#### Usage Guidelines\n\nThe API lets you create the following types of custom actions:\n\n* URL-based action \n Allows pushing data to an external URL.\n* Callback action \n Triggers a callback to the host application and initiates a response payload on an embedded ThoughtSpot instance.\n\nBy default, custom actions are visible to only administrator or developer users. To make a custom action available to other users, and specify the groups in `group_identifiers`.\n\nBy default, the custom action is set as a _global_ action on all visualizations and saved Answers. To assign a custom action to specific Liveboard visualization, saved Answer, or Worksheet, set `visibility` to `false` in `default_action_config` property and specify the GUID or name of the object in `associate_metadata`.\n\nFor more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Custom Action",
"9.6.0.cl"
@@ -10634,7 +11151,7 @@
"/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update": {
"post": {
"operationId": "updateCustomAction",
- "description": "\n Version: 9.6.0.cl or later\n\nUpdates a custom action.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Usage Guidelines\n\nThe API allows you to modify the following properties:\n\n* Name of the custom action\n* Action availability to groups\n* Association to metadata objects\n* Authentication settings for a URL-based action\n\nFor more information, see [Custom actions](https://developers.thoughtspot.com/docs/?pageid=custom-action-intro).\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.6.0.cl or later\n\nUpdates a custom action.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n#### Usage Guidelines\n\nThe API allows you to modify the following properties:\n\n* Name of the custom action\n* Action availability to groups\n* Association to metadata objects\n* Authentication settings for a URL-based action\n\nFor more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro).\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Custom Action",
"9.6.0.cl"
@@ -10755,7 +11272,7 @@
"/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete": {
"post": {
"operationId": "deleteCustomAction",
- "description": "\n Version: 9.6.0.cl or later\n\nRemoves the custom action specified in the API request.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.6.0.cl or later\n\nRemoves the custom action specified in the API request.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Custom Action",
"9.6.0.cl"
@@ -10821,7 +11338,7 @@
"/api/rest/2.0/dbt/dbt-connection": {
"post": {
"operationId": "dbtConnection",
- "description": "\n Version: 9.9.0.cl or later\n\nCreates a DBT connection object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege.\n\n#### About create DBT connection\nDBT connection in ThoughtSpot is used by the user to define DBT credentials for cloud . The API needs embrace connection, embrace database name, DBT url, import type, DBT account identifier, DBT project identifier, DBT access token and environment details (or) embrace connection, embrace database name, import type, file_content to create a connection object. To know more about DBT, see ThoughtSpot Product Documentation.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.9.0.cl or later\n\nCreates a DBT connection object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About create DBT connection\nDBT connection in ThoughtSpot is used by the user to define DBT credentials for cloud . The API needs embrace connection, embrace database name, DBT url, import type, DBT account identifier, DBT project identifier, DBT access token and environment details (or) embrace connection, embrace database name, import type, file_content to create a connection object. To know more about DBT, see ThoughtSpot Product Documentation.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"DBT",
"9.9.0.cl"
@@ -10946,7 +11463,7 @@
"/api/rest/2.0/dbt/generate-tml": {
"post": {
"operationId": "dbtGenerateTml",
- "description": " Version: 9.9.0.cl or later",
+ "description": "\n Version: 9.9.0.cl or later\n\nGenerate required table and worksheet and import them.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About generate TML\nModels and Worksheets to be imported can be selected by the user as part of the API.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"DBT",
"9.9.0.cl"
@@ -11057,7 +11574,7 @@
"/api/rest/2.0/dbt/generate-sync-tml": {
"post": {
"operationId": "dbtGenerateSyncTml",
- "description": " Version: 9.9.0.cl or later",
+ "description": "\n Version: 9.9.0.cl or later\n\nResynchronize the existing list of models, tables, worksheet tml’s and import them to Thoughtspot based on the DBT connection object.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"DBT",
"9.9.0.cl"
@@ -11144,7 +11661,7 @@
"/api/rest/2.0/dbt/search": {
"post": {
"operationId": "dbtSearch",
- "description": "\n Version: 9.9.0.cl or later\n\nGets a list of DBT connection objects by user and organization, available on the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege\n\n#### About search DBT connection\nTo get details of a specific DBT connection identifier, database connection identifier, database connection name, database name, project name, project identifier, environment identifier , import type and author.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.9.0.cl or later\n\nGets a list of DBT connection objects by user and organization, available on the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About search DBT connection\nTo get details of a specific DBT connection identifier, database connection identifier, database connection name, database name, project name, project identifier, environment identifier , import type and author.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"DBT",
"9.9.0.cl"
@@ -11210,7 +11727,7 @@
"/api/rest/2.0/dbt/{dbt_connection_identifier}/delete": {
"post": {
"operationId": "deleteDbtConnection",
- "description": "\n Version: 9.9.0.cl or later\n\nRemoves the specified DBT connection object from the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.9.0.cl or later\n\nRemoves the specified DBT connection object from the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"DBT",
"9.9.0.cl"
@@ -11276,7 +11793,7 @@
"/api/rest/2.0/dbt/update-dbt-connection": {
"post": {
"operationId": "updateDbtConnection",
- "description": "\n Version: 9.9.0.cl or later\n\nUpdates a DBT connection object.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege, along with an existing DBT connection.\n\n#### About update DBT connection\nYou can modify DBT connection object properties such as embrace connection name, embrace database name, import type, account identifier, access token, project identifier and environment (or) embrace connection, embrace database name, import type, file_content settings.\n\n\n\n\n#### Endpoint URL\n",
+ "description": "\n Version: 9.9.0.cl or later\n\nUpdates a DBT connection object.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege, along with an existing DBT connection.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About update DBT connection\nYou can modify DBT connection object properties such as embrace connection name, embrace database name, import type, account identifier, access token, project identifier and environment (or) embrace connection, embrace database name, import type, file_content settings.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"DBT",
"9.9.0.cl"
@@ -11400,42 +11917,288 @@
}
}
}
- }
- },
- "components": {
- "schemas": {
- "ErrorResponse": {
- "type": "object",
- "properties": {
- "error": {
- "type": "object",
- "nullable": true
- }
- }
- },
- "GetTokenResponse": {
- "type": "object",
- "required": [
- "token",
- "creation_time_in_millis",
- "expiration_time_in_millis",
- "valid_for_user_id",
- "valid_for_username"
+ },
+ "/api/rest/2.0/ai/conversation/create": {
+ "post": {
+ "operationId": "createConversation",
+ "description": "\nBeta Version: 10.4.0.cl or later\n\nCreates a Conversation object to start an AI-driven conversation based on a specific data model.\n\nRequires at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThis API requires the `metadata_identifier` parameter to define the context for the conversation.\n\nYou can also specify the tokens to initiate the conversation as shown in this example:\n\n`\"tokens\": \"[tea],[sales],[type]\"`\n\nIf the API request is successful, ThoughtSpot returns the ID of the conversation.\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": [
+ "AI",
+ "10.4.0.cl"
],
- "properties": {
- "token": {
- "type": "string",
- "description": "Bearer auth token."
- },
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token creation time in milliseconds."
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "metadata_identifier": {
+ "description": "ID of the metadata object, such as a Worksheet or Model, to use as a data source for the conversation.",
+ "type": "string"
+ },
+ "tokens": {
+ "description": "Token string to set the context for the conversation. For example,`[sales],[item type],[state]`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "metadata_identifier"
+ ]
+ }
+ }
},
- "expiration_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token expiration time in milliseconds."
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Common successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Conversation"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Common error response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Conversation"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/ai/conversation/{conversation_identifier}/converse": {
+ "post": {
+ "operationId": "sendMessage",
+ "description": "\nBeta Version: 10.4.0.cl or later\n\nAllows sending a follow-up message to an ongoing conversation within the context of the metadata model.\n\nRequires at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe API requires you to specify the `conversation_identifier` in the request path, and a `metadata_identifier` and `message` string in the request body.\n\nIf the API request is successful, ThoughtSpot returns the session ID, tokens used in the conversation, and visualization type.\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": [
+ "AI",
+ "10.4.0.cl"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "metadata_identifier": {
+ "description": "ID of the metadata object, such as a Worksheet or Model, to use as a data source for the conversation.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A message string with the follow-up question to continue the conversation.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "metadata_identifier",
+ "message"
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [
+ {
+ "in": "path",
+ "name": "conversation_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Unique identifier of the conversation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Common successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseMessage"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Common error response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseMessage"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/ai/answer/create": {
+ "post": {
+ "operationId": "singleAnswer",
+ "description": "\nBeta Version: 10.4.0.cl or later\n\nProcesses a natural language query and returns an AI-generated response based on a specified data model.\n\nRequires at least view access to the metadata object specified in the request.\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": [
+ "AI",
+ "10.4.0.cl"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "A natural language query string to generate the Answer.",
+ "type": "string"
+ },
+ "metadata_identifier": {
+ "description": "ID of the metadata object, such as a Worksheet or Model, to use as a data source for the query.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "query",
+ "metadata_identifier"
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Common successful response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResponseMessage"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Common error response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResponseMessage"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Operation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "ErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "GetTokenResponse": {
+ "type": "object",
+ "required": [
+ "token",
+ "creation_time_in_millis",
+ "expiration_time_in_millis",
+ "valid_for_user_id",
+ "valid_for_username"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "Bearer auth token."
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token creation time in milliseconds."
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token expiration time in milliseconds."
},
"valid_for_user_id": {
"type": "string",
@@ -11546,7 +12309,8 @@
"INACTIVE",
"EXPIRED",
"LOCKED",
- "PENDING"
+ "PENDING",
+ "SUSPENDED"
],
"description": "Status of the user account.",
"nullable": true
@@ -11731,6 +12495,11 @@
"type": "object",
"description": "User Parameters which are specified for the user via JWToken",
"nullable": true
+ },
+ "access_control_properties": {
+ "type": "object",
+ "description": "Access Control Properties which are specified for the user via JWToken",
+ "nullable": true
}
}
},
@@ -12294,6 +13063,11 @@
"description": "Unique ID or name of the metadata.",
"nullable": true
},
+ "obj_identifier": {
+ "type": "string",
+ "description": "CustomObjectId of the metadata.",
+ "nullable": true
+ },
"name_pattern": {
"type": "string",
"description": "A pattern to match the case-insensitive name of the metadata object. User % for a wildcard match.",
@@ -12447,7 +13221,8 @@
"TAG",
"USER",
"USER_GROUP",
- "LOGICAL_RELATIONSHIP"
+ "LOGICAL_RELATIONSHIP",
+ "INSIGHT_SPEC"
],
"description": "Type of the metadata."
},
@@ -12730,6 +13505,338 @@
"default": false,
"description": "Indicates whether to include a page with all applied filters.",
"nullable": true
+ },
+ "personalised_view_id": {
+ "type": "string",
+ "description": "Indicates personalised view of the Liveboard in case of png",
+ "nullable": true
+ }
+ }
+ },
+ "RegionalSettingsInput": {
+ "type": "object",
+ "properties": {
+ "currency_format": {
+ "type": "string",
+ "description": "ISO code to be appended with currency values.",
+ "nullable": true,
+ "enum": [
+ "ADP",
+ "AED",
+ "AFN",
+ "ALL",
+ "AMD",
+ "ANG",
+ "AOA",
+ "ARA",
+ "ARS",
+ "ATS",
+ "AUD",
+ "AWG",
+ "AZN",
+ "BAM",
+ "BBD",
+ "BDT",
+ "BEF",
+ "BGL",
+ "BGM",
+ "BGN",
+ "BHD",
+ "BIF",
+ "BMD",
+ "BND",
+ "BOB",
+ "BOP",
+ "BOV",
+ "BRL",
+ "BSD",
+ "BTN",
+ "BUK",
+ "BWP",
+ "BYN",
+ "BZD",
+ "CAD",
+ "CDF",
+ "CHE",
+ "CHF",
+ "CHW",
+ "CLE",
+ "CLP",
+ "CNX",
+ "CNY",
+ "COP",
+ "COU",
+ "CRC",
+ "CSK",
+ "CUC",
+ "CUP",
+ "CVE",
+ "CYP",
+ "CZK",
+ "DDM",
+ "DEM",
+ "DJF",
+ "DKK",
+ "DOP",
+ "DZD",
+ "ECS",
+ "ECV",
+ "EEK",
+ "EGP",
+ "ERN",
+ "ESP",
+ "ETB",
+ "EUR",
+ "FIM",
+ "FJD",
+ "FKP",
+ "FRF",
+ "GBP",
+ "GEK",
+ "GEL",
+ "GHS",
+ "GIP",
+ "GMD",
+ "GNF",
+ "GNS",
+ "GQE",
+ "GRD",
+ "GTQ",
+ "GWE",
+ "GWP",
+ "GYD",
+ "HKD",
+ "HNL",
+ "HRD",
+ "HRK",
+ "HTG",
+ "HUF",
+ "IDR",
+ "IEP",
+ "ILP",
+ "ILS",
+ "INR",
+ "IQD",
+ "IRR",
+ "ISK",
+ "ITL",
+ "JMD",
+ "JOD",
+ "JPY",
+ "KES",
+ "KGS",
+ "KHR",
+ "KMF",
+ "KPW",
+ "KRW",
+ "KWD",
+ "KYD",
+ "KZT",
+ "LAK",
+ "LBP",
+ "LKR",
+ "LRD",
+ "LSL",
+ "LTL",
+ "LTT",
+ "LUC",
+ "LUF",
+ "LUL",
+ "LVL",
+ "LVR",
+ "LYD",
+ "MAD",
+ "MAF",
+ "MCF",
+ "MDC",
+ "MDL",
+ "MGA",
+ "MGF",
+ "MKD",
+ "MLF",
+ "MMK",
+ "MNT",
+ "MOP",
+ "MRU",
+ "MTL",
+ "MTP",
+ "MUR",
+ "MVR",
+ "MWK",
+ "MXN",
+ "MXV",
+ "MYR",
+ "MZE",
+ "MZN",
+ "NAD",
+ "NGN",
+ "NIO",
+ "NLG",
+ "NOK",
+ "NPR",
+ "NZD",
+ "OMR",
+ "PAB",
+ "PEI",
+ "PEN",
+ "PGK",
+ "PHP",
+ "PKR",
+ "PLN",
+ "PTE",
+ "PYG",
+ "QAR",
+ "RHD",
+ "RON",
+ "RSD",
+ "RUB",
+ "RWF",
+ "SAR",
+ "SBD",
+ "SCR",
+ "SDG",
+ "SEK",
+ "SGD",
+ "SHP",
+ "SIT",
+ "SKK",
+ "SLL",
+ "SOS",
+ "SRD",
+ "SRG",
+ "SSP",
+ "STN",
+ "SUR",
+ "SVC",
+ "SYP",
+ "SZL",
+ "THB",
+ "TJR",
+ "TJS",
+ "TMT",
+ "TND",
+ "TOP",
+ "TPE",
+ "TRY",
+ "TTD",
+ "TWD",
+ "TZS",
+ "UAH",
+ "UAK",
+ "UGX",
+ "USD",
+ "UYU",
+ "UYW",
+ "UZS",
+ "VES",
+ "VND",
+ "VUV",
+ "WST",
+ "XAF",
+ "XAG",
+ "XAU",
+ "XBA",
+ "XBB",
+ "XCD",
+ "XDR",
+ "XEU",
+ "XFO",
+ "XFU",
+ "XOF",
+ "XPD",
+ "XPF",
+ "XPT",
+ "XRE",
+ "XSU",
+ "XTS",
+ "XUA",
+ "XXX",
+ "YDD",
+ "YER",
+ "ZAR",
+ "ZMW"
+ ]
+ },
+ "user_locale": {
+ "type": "string",
+ "description": "Indicates the locale to be used for all formattings.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN"
+ ]
+ },
+ "number_format_locale": {
+ "type": "string",
+ "description": "Indicates the locale to be used for number formatting.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN"
+ ]
+ },
+ "date_format_locale": {
+ "type": "string",
+ "description": "Indicates the locale to be used for date formatting.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN"
+ ]
}
}
},
@@ -13239,7 +14346,10 @@
"GCP_POSTGRESQL",
"GCP_MYSQL",
"MODE",
- "GOOGLE_SHEETS"
+ "GOOGLE_SHEETS",
+ "FALCON",
+ "FALCON_ONPREM",
+ "CLICKHOUSE"
],
"description": "Type of data warehouse."
},
@@ -13491,7 +14601,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
},
"description": "Privileges granted to the role."
@@ -13812,15 +14923,99 @@
},
"description": "MetadataType InputType used in Custom Action API's"
},
- "GenericInfo": {
+ "Input_eureka_DecomposeQueryRequest": {
"type": "object",
"properties": {
- "id": {
- "type": "string",
+ "nlsRequest": {
+ "$ref": "#/components/schemas/NLSRequest",
"nullable": true
},
- "name": {
- "type": "string",
+ "worksheetIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "answerIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "content": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "NLSRequest": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "type": "string",
+ "nullable": true
+ },
+ "instructions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "QueryGetDecomposedQueryResponse": {
+ "type": "object",
+ "properties": {
+ "decomposedQueryResponse": {
+ "$ref": "#/components/schemas/DecomposedQueryResponse",
+ "nullable": true
+ }
+ }
+ },
+ "DecomposedQueryResponse": {
+ "type": "object",
+ "properties": {
+ "decomposedQueries": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DecomposedQuery"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "DecomposedQuery": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "type": "string",
+ "nullable": true
+ },
+ "worksheetId": {
+ "type": "string",
+ "nullable": true
+ },
+ "worksheetName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "GenericInfo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
"nullable": true
}
}
@@ -13918,7 +15113,7 @@
"runtime_filters": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/User_Runtime_Filters"
+ "$ref": "#/components/schemas/Runtime_Filters"
},
"description": "Objects to apply the User_Runtime_Filters.\n\nExamples to set the `runtime_filters` :\n```json\n{ \"column_name\": \"Color\", \"operator\": \"EQ\", \"values\": [\"red\"], \"persist\": false }\n```",
"nullable": true
@@ -13926,7 +15121,7 @@
"runtime_sorts": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/User_Runtime_Sorts"
+ "$ref": "#/components/schemas/Runtime_Sorts"
},
"description": "Objects to apply the User_Runtime_Sorts.\n\nExamples to set the `runtime_sorts` :\n```json\n{ \"column_name\": \"Color\", \"order\": \"ASC\", \"persist\": false }\n```",
"nullable": true
@@ -13934,7 +15129,7 @@
"parameters": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/User_Parameters"
+ "$ref": "#/components/schemas/Runtime_Parameters"
},
"description": "Objects to apply the Runtime_Parameters.\n\nExamples to set the `parameters` :\n```json\n{ \"name\": \"Color\", \"values\": [\"Blue\"], \"persist\": false }\n```",
"nullable": true
@@ -13965,7 +15160,7 @@
},
"description": "Objects to apply the User_Object."
},
- "User_Runtime_Filters": {
+ "Runtime_Filters": {
"type": "object",
"required": [
"column_name",
@@ -13988,19 +15183,21 @@
"type": "string",
"enum": [
"EQ",
- "GE",
+ "NE",
+ "LT",
+ "LE",
"GT",
+ "GE",
"IN",
- "LE",
- "LT",
- "NE",
- "BEGINS_WITH",
"BW",
+ "CONTAINS",
+ "BEGINS_WITH",
+ "ENDS_WITH",
"BW_INC",
- "BW_INC_MAX",
"BW_INC_MIN",
- "CONTAINS",
- "ENDS_WITH"
+ "BW_INC_MAX",
+ "LIKE",
+ "NOT_IN"
],
"description": "Operator value. Example: EQ"
},
@@ -14019,9 +15216,9 @@
"nullable": true
}
},
- "description": "Objects to apply the User_Runtime_Filters."
+ "description": "Objects to apply the Runtime_Filters."
},
- "User_Runtime_Sorts": {
+ "Runtime_Sorts": {
"type": "object",
"properties": {
"column_name": {
@@ -14053,9 +15250,9 @@
"nullable": true
}
},
- "description": "Objects to apply the User_Runtime_Sorts."
+ "description": "Objects to apply the Runtime_Sorts."
},
- "User_Parameters": {
+ "Runtime_Parameters": {
"type": "object",
"required": [
"name",
@@ -14199,6 +15396,198 @@
}
}
},
+ "FilterRules": {
+ "type": "object",
+ "required": [
+ "column_name",
+ "operator",
+ "values"
+ ],
+ "properties": {
+ "column_name": {
+ "type": "string",
+ "description": "The name of the column to apply the filter on."
+ },
+ "operator": {
+ "type": "string",
+ "enum": [
+ "EQ",
+ "NE",
+ "LT",
+ "LE",
+ "GT",
+ "GE",
+ "IN",
+ "BW",
+ "CONTAINS",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "BW_INC",
+ "BW_INC_MIN",
+ "BW_INC_MAX",
+ "LIKE",
+ "NOT_IN"
+ ],
+ "description": "The operator to use for filtering. Example: EQ (equals), GT(greater than), etc."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "description": "The values to filter on. To get all records, use TS_WILDCARD_ALL as values."
+ }
+ },
+ "description": "Filter Rules to be applied on Objects."
+ },
+ "ParameterValues": {
+ "type": "object",
+ "required": [
+ "name",
+ "values"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the column to apply the filter on."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "description": "The values to filter on. Only single value is supported currently."
+ }
+ },
+ "description": "Filter Rules to be applied on Objects."
+ },
+ "TokenAccessScopeObject": {
+ "type": "object",
+ "required": [
+ "identifier"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE"
+ ],
+ "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique name/id of the object."
+ }
+ },
+ "description": "Objects on which the filter rules and parameters values should be applied to"
+ },
+ "Group_Object": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "description": "Groups objects."
+ },
+ "AccessToken": {
+ "type": "object",
+ "required": [
+ "token",
+ "org",
+ "user",
+ "creation_time_in_millis",
+ "expiration_time_in_millis"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "GUID of the auth token.",
+ "nullable": true
+ },
+ "token": {
+ "type": "string",
+ "description": "Bearer auth token."
+ },
+ "org": {
+ "$ref": "#/components/schemas/OrgInfo",
+ "description": "Org information for which the token is generated."
+ },
+ "user": {
+ "$ref": "#/components/schemas/UserInfo",
+ "description": "User information for which the token is generated."
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token creation time in milliseconds."
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token expiration time in milliseconds."
+ }
+ }
+ },
+ "OrgInfo": {
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Id."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name.",
+ "nullable": true
+ }
+ }
+ },
+ "UserInfo": {
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Id."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name.",
+ "nullable": true
+ }
+ }
+ },
"ResponseActivationURL": {
"type": "object",
"properties": {
@@ -14250,7 +15639,8 @@
"INACTIVE",
"EXPIRED",
"LOCKED",
- "PENDING"
+ "PENDING",
+ "SUSPENDED"
],
"default": "ACTIVE",
"description": "Status of the user account.",
@@ -14442,7 +15832,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
},
"description": "Privileges that will be assigned to the group.",
@@ -14515,6 +15906,30 @@
}
}
},
+ "Export_Options": {
+ "type": "object",
+ "properties": {
+ "include_obj_id_ref": {
+ "type": "boolean",
+ "default": false,
+ "description": "Boolean Flag to whether to export user_defined_id of referenced object. This will only be respected when UserDefinedId in TML is enabled.",
+ "nullable": true
+ },
+ "include_guid": {
+ "type": "boolean",
+ "default": true,
+ "description": "Boolean flag to whether to export guid of the object. This will only be respected when UserDefinedId in TML is enabled.",
+ "nullable": true
+ },
+ "include_obj_id": {
+ "type": "boolean",
+ "default": false,
+ "description": "Boolean flag to whether to export user_defined_id of the object. This will only be respected when UserDefinedId in TML is enabled.",
+ "nullable": true
+ }
+ },
+ "description": "Flags to specify additional options for export. This will only be active when UserDefinedId in TML is enabled."
+ },
"ResponseCopyObject": {
"type": "object",
"properties": {
@@ -14525,6 +15940,270 @@
}
}
},
+ "ResponseWorksheetToModelConversion": {
+ "type": "object",
+ "required": [
+ "name",
+ "success_count",
+ "failure_count",
+ "incomplete_count",
+ "post_upgrade_failed_count",
+ "total_time_in_millis",
+ "successful_entities",
+ "failed_entities",
+ "incomplete_entities",
+ "post_upgrade_failed_entities"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "success_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets successfully converted to models."
+ },
+ "failure_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets that failed to convert."
+ },
+ "incomplete_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets that were incomplete during the conversion process."
+ },
+ "post_upgrade_failed_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets that failed after an upgrade during the conversion process."
+ },
+ "total_time_in_millis": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The total time taken to complete the conversion process in milliseconds."
+ },
+ "successful_entities": {
+ "$ref": "#/components/schemas/ResponseSuccessfulEntities",
+ "description": "List of worksheets successfully converted to models."
+ },
+ "failed_entities": {
+ "$ref": "#/components/schemas/ResponseFailedEntities",
+ "description": "List of worksheets that failed to convert."
+ },
+ "incomplete_entities": {
+ "$ref": "#/components/schemas/ResponseIncompleteEntities",
+ "description": "List of worksheets that were incomplete during the conversion."
+ },
+ "post_upgrade_failed_entities": {
+ "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntities",
+ "description": "List of worksheets that failed after an upgrade during the conversion process."
+ }
+ },
+ "description": "Name of the conversion process, which involves converting worksheets to models."
+ },
+ "ResponseSuccessfulEntities": {
+ "type": "object",
+ "required": [
+ "data"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseSuccessfulEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the successful entities, as they are inside a 'data' field in the response."
+ },
+ "ResponseSuccessfulEntity": {
+ "type": "object",
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the worksheet."
+ }
+ },
+ "description": "Unique ID of the worksheet."
+ },
+ "ResponseFailedEntities": {
+ "type": "object",
+ "required": [
+ "data"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseFailedEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the failed entities, as they are inside a 'data' field in the response."
+ },
+ "ResponseFailedEntity": {
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "error"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the worksheet that failed to convert."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error details related to the failed conversion."
+ }
+ },
+ "description": "Unique ID of the failed worksheet."
+ },
+ "ResponseIncompleteEntities": {
+ "type": "object",
+ "required": [
+ "data"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseIncompleteEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the incomplete entities, as they are inside a 'data' field in the response."
+ },
+ "ResponseIncompleteEntity": {
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "error"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the incomplete worksheet."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error details related to the incomplete conversion."
+ }
+ },
+ "description": "Unique ID of the incomplete worksheet."
+ },
+ "ResponsePostUpgradeFailedEntities": {
+ "type": "object",
+ "required": [
+ "data"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the post-upgrade failed entities, as they are inside a 'data' field in the response."
+ },
+ "ResponsePostUpgradeFailedEntity": {
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "error"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the worksheet that failed post-upgrade."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error details related to the post-upgrade failure."
+ }
+ },
+ "description": "Unique ID of the worksheet that failed post-upgrade."
+ },
+ "HeaderUpdateInput": {
+ "type": "object",
+ "required": [
+ "attributes"
+ ],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID of a specified type to identify the header.",
+ "nullable": true
+ },
+ "obj_identifier": {
+ "type": "string",
+ "description": "Custom object identifier to uniquely identify header.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "LIVEBOARD",
+ "ACTION_OBJECT",
+ "DATA_SOURCE",
+ "USER",
+ "USER_GROUP"
+ ],
+ "description": "Optional type of the header object.",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/HeaderAttributeInput"
+ },
+ "description": "List of attributes to update"
+ }
+ },
+ "description": "Favorite object options."
+ },
+ "HeaderAttributeInput": {
+ "type": "object",
+ "required": [
+ "name",
+ "value"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Attribute name to be updated."
+ },
+ "value": {
+ "type": "string",
+ "description": "Attribute's new value."
+ }
+ },
+ "description": "Attribute to update in a header."
+ },
"ExportMetadataTypeInput": {
"type": "object",
"required": [
@@ -14589,7 +16268,8 @@
"enum": [
"LIVEBOARD",
"ANSWER",
- "LOGICAL_TABLE"
+ "LOGICAL_TABLE",
+ "CONNECTION"
],
"description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
"nullable": true
@@ -14612,7 +16292,9 @@
"enum": [
"LIVEBOARD",
"ANSWER",
- "LOGICAL_TABLE"
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION"
],
"description": " Type of metadata.\n \n\nType of metadata. Required if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
"nullable": true
@@ -14894,7 +16576,10 @@
"GCP_POSTGRESQL",
"GCP_MYSQL",
"MODE",
- "GOOGLE_SHEETS"
+ "GOOGLE_SHEETS",
+ "FALCON",
+ "FALCON_ONPREM",
+ "CLICKHOUSE"
],
"description": "Type of data warehouse."
},
@@ -14994,7 +16679,8 @@
"ALLOW_NON_EMBED_FULL_APP_ACCESS",
"CAN_ACCESS_ANALYST_STUDIO",
"CAN_MANAGE_ANALYST_STUDIO",
- "PREVIEW_DOCUMENT_SEARCH"
+ "PREVIEW_DOCUMENT_SEARCH",
+ "CAN_SETUP_VERSION_CONTROL"
]
},
"description": "Privileges granted to the role."
@@ -15952,6 +17638,64 @@
}
}
},
+ "Conversation": {
+ "type": "object",
+ "required": [
+ "conversation_identifier"
+ ],
+ "properties": {
+ "conversation_identifier": {
+ "type": "string",
+ "description": "Unique identifier of the conversation."
+ }
+ }
+ },
+ "ResponseMessage": {
+ "type": "object",
+ "required": [
+ "message_type"
+ ],
+ "properties": {
+ "session_identifier": {
+ "type": "string",
+ "description": "Unique identifier of the generated response.",
+ "nullable": true
+ },
+ "generation_number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Generate number of the response.",
+ "nullable": true
+ },
+ "message_type": {
+ "type": "string",
+ "enum": [
+ "TSAnswer"
+ ],
+ "description": "Type of the generated response."
+ },
+ "visualization_type": {
+ "type": "string",
+ "enum": [
+ "Chart",
+ "Table",
+ "Undefined"
+ ],
+ "description": "Generated visualization type.",
+ "nullable": true
+ },
+ "tokens": {
+ "type": "string",
+ "description": "Tokens for the response.",
+ "nullable": true
+ },
+ "display_tokens": {
+ "type": "string",
+ "description": "User friendly tokens for the response.",
+ "nullable": true
+ }
+ }
+ },
"Runtime_Filter": {
"type": "object",
"properties": {