diff --git a/modules/ROOT/pages/api-changelog.adoc b/modules/ROOT/pages/api-changelog.adoc index 762bbdbb2..7eb58168c 100644 --- a/modules/ROOT/pages/api-changelog.adoc +++ b/modules/ROOT/pages/api-changelog.adoc @@ -19,7 +19,7 @@ The following enumerations are available for code based custom actions: To define the target object for the custom action, such as on a Liveboard, visualization, Answer, or in Spotter. * `CustomActionsPosition` + To define the position of the custom action in the target object, such as primary menu, **More** options menu image:./images/icon-more-10px.png[the more options menu], or the contextual menu. -|[tag greenBackground]#NEW FEATURE# | *Attribute to set Parameter chip visibility during overrides* +|[tag greenBackground]#NEW FEATURE# | *Attribute to set Parameter chip visibility during overrides* + The `HostEvent.UpdateParameters` event now supports configuring the `isVisibleToUser` attribute to show or hide the Parameter chips after an override. For more information, see xref:runtime-parameters.adoc#_show_or_hide_parameter_chips_in_embedded_sessions[Show or hide Parameter chips in embedded sessions]. |==== diff --git a/modules/ROOT/pages/common/nav.adoc b/modules/ROOT/pages/common/nav.adoc index 8f7e34007..47daf5395 100644 --- a/modules/ROOT/pages/common/nav.adoc +++ b/modules/ROOT/pages/common/nav.adoc @@ -23,7 +23,7 @@ ** link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground] ** link:{{navprefix}}/graphql-play-ground[GraphQL Playground] ** +++REST API v1 Playground+++ -** link:{{navprefix}}/theme-builder[Theme Builder ^Beta^] +** link:{{navprefix}}/theme-builder[Theme Builder] ** link:{{navprefix}}/spotdev-portal[How to use] *** link:{{navprefix}}/dev-playground[Visual Embed Playground] *** link:{{navprefix}}/graphql-playground[GraphQL Playground] @@ -86,7 +86,7 @@ ***** link:{{navprefix}}/css-variables-reference[CSS variables reference] ***** link:{{navprefix}}/customize-icons[Customize icons] ***** link:{{navprefix}}/customize-text[Customize text strings] -***** link:{{navprefix}}/theme-builder-doc[Theme builder ^Beta^] +***** link:{{navprefix}}/theme-builder-doc[Theme builder] *** link:{{navprefix}}/filters-overview[Filters overview] **** link:{{navprefix}}/runtime-overrides[Runtime overrides] @@ -256,3 +256,4 @@ include::generated/typedoc/CustomSideNav.adoc[] ** link:https://docs.thoughtspot.com[Product Documentation, window=_blank] ** link:{{navprefix}}/rest-apiv2-beta-reference[REST API v2 ^Beta^ Reference (Deprecated)] + diff --git a/modules/ROOT/pages/mcp-integration.adoc b/modules/ROOT/pages/mcp-integration.adoc index d88e77098..8b05690c6 100644 --- a/modules/ROOT/pages/mcp-integration.adoc +++ b/modules/ROOT/pages/mcp-integration.adoc @@ -8,7 +8,7 @@ ThoughtSpot’s Agentic Model Context Protocol (MCP) Server allows you to integrate ThoughtSpot analytics directly into any AI agent, custom chatbot, or LLM-based platforms that support MCP. It acts as a connector between the ThoughtSpot instance and external AI client, and provides a set of tools for interacting with ThoughtSpot’s data and its analytics capabilities programmatically. - The ThoughtSpot MCP Server is an add-on feature available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. + +The ThoughtSpot MCP Server is an add-on feature available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. + To purchase the MCP Server subscription and enable the MCP Server in your environment, you must have an active subscription to one of the following ThoughtSpot license plans: * Enterprise Edition of ThoughtSpot Analytics @@ -60,10 +60,10 @@ Integration requires configuration, typically via a config file, to specify serv Authentication and security settings:: -* Access to ThoughtSpot instance: + - +* Access to ThoughtSpot instance + For MCP Server connection, users require access to a ThoughtSpot instance. For tool invocation, the MCP server must accept authenticated requests, and the LLM tool specification must carry those credentials or headers. + ThoughtSpot administrators can use the SSO framework with SAML or OAuth token-based authentication methods to authenticate and sign in users. + + * SAML redirect settings: + For SAML SSO users, the SAML redirect domain configuration is required to ensure that users are redirected to an allowed and trusted domain after they are authenticated. + * To get answers to their data queries, your application users require at least view access to ThoughtSpot data sources. To generate an Answer or to create a Liveboard, users require the data download privilege. diff --git a/modules/ROOT/pages/publishing-overview.adoc b/modules/ROOT/pages/publishing-overview.adoc index bf82dd224..09ef9c228 100644 --- a/modules/ROOT/pages/publishing-overview.adoc +++ b/modules/ROOT/pages/publishing-overview.adoc @@ -52,22 +52,23 @@ You can create the following types of variables using the xref:variables.adoc[va [options='header'] |===== |Variable type| Description -|`TABLE_MAPPING`| The **TABLE_MAPPING** variable allow parameterizing the following Table properties: +|`TABLE_MAPPING` a| The **TABLE_MAPPING** variable allow parameterizing the following Table properties: + +* `databaseName` + +* `schemaName` + +* `tableName` + -** `databaseName` -** `schemaName` -** `tableName` |`CONNECTION_PROPERTY` a| The `CONNECTION_PROPERTY` variables allow parameterizing connection properties. For example, `accountName`, `warehouse`, `user`, `password`, `role` and so on. | `CONNECTION_PROPERTY_PER_PRINCIPLE` a| -[NOTE] -This feature is disabled by default. To enable this option, contact ThoughtSpot Support. - This variable supports modifying connection properties per principal (user or user group). This means you can set different values for connection properties depending on the user or group accessing the connection. For example, `warehouse`, `role`, `user`, `password`. -The `CONNECTION_PROPERTY_PER_PRINCIPLE` variable does not allow parameterizing core connection properties such as `accountName`, `host`, or `port`. These properties must be derived from the connection configuration and cannot be set per user or user group. + +The `CONNECTION_PROPERTY_PER_PRINCIPLE` variable does not allow parameterizing core connection properties such as `accountName`, `host`, or `port`. These properties must be derived from the connection configuration and cannot be set per user or user group. + +[NOTE] +This feature is disabled by default. To enable this option, contact ThoughtSpot Support. || //`FORMULA_VARIABLE` a| `FORMULA_VARIABLE` refers can be used to create and manage formula variables. diff --git a/modules/ROOT/pages/rest-api-java-sdk.adoc b/modules/ROOT/pages/rest-api-java-sdk.adoc index 3fe82006f..484a255ba 100644 --- a/modules/ROOT/pages/rest-api-java-sdk.adoc +++ b/modules/ROOT/pages/rest-api-java-sdk.adoc @@ -311,18 +311,26 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#commitBranch[commitBranch^] |*POST* /api/rest/2.0/vcs/git/branches/commit +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#connectionConfigurationSearch[connectionConfigurationSearch^] |*POST* /api/rest/2.0/connection-configurations/search + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#convertWorksheetToModel[convertWorksheetToModel^] |*POST* /api/rest/2.0/metadata/worksheets/convert |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#copyObject[copyObject^] |*POST* /api/rest/2.0/metadata/copyobject +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createAgentConversation[createAgentConversation^] |*POST* /api/rest/2.0/ai/agent/conversation/create + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createCalendar[createCalendar^] |*POST* /api/rest/2.0/calendars/create + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createConfig[createConfig^] |*POST* /api/rest/2.0/vcs/git/config/create |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createConnection[createConnection^] |*POST* /api/rest/2.0/connection/create +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createConnectionConfiguration[createConnectionConfiguration^] |*POST* /api/rest/2.0/connection-configurations/create + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createConversation[createConversation^] |*POST* /api/rest/2.0/ai/conversation/create @@ -344,8 +352,9 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createUser[createUser^] |*POST* /api/rest/2.0/users/create -|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createUserGroup[createUserGroup^] |*POST* -/api/rest/2.0/groups/create +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createUserGroup[createUserGroup^] |*POST* /api/rest/2.0/groups/create + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#createVariable[createVariable^] |*POST* /api/rest/2.0/template/variables/create |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#dbtConnection[dbtConnection^] |*POST* /api/rest/2.0/dbt/dbt-connection @@ -368,6 +377,9 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteConnection[deleteConnection^] |*POST* /api/rest/2.0/connection/delete + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteConnectionConfiguration[deleteConnectionConfiguration^] |*POST* /api/rest/2.0/connection-configurations/delete + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteConnectionV2[deleteConnectionV2^] |*POST* /api/rest/2.0/connections/\{connection_identifier}/delete @@ -384,8 +396,8 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteOrg[deleteOrg^] |*POST* /api/rest/2.0/orgs/\{org_identifier}/delete -|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteRole[deleteRole^] |*POST* -/api/rest/2.0/roles/\{role_identifier}/delete +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteOrgEmailCustomization[deleteOrgEmailCustomization^] |*POST* /api/rest/2.0/customization/email/delete + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteSchedule[deleteSchedule^] |*POST* /api/rest/2.0/schedules/\{schedule_identifier}/delete @@ -399,6 +411,8 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteUserGroup[deleteUserGroup^] |*POST* /api/rest/2.0/groups/\{group_identifier}/delete +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deleteVariable[deleteVariable^] |*POST* /api/rest/2.0/template/variables/{identifier}/delete + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#deployCommit[deployCommit^] |*POST* /api/rest/2.0/vcs/git/commits/deploy @@ -427,6 +441,9 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#fetchAsyncImportTaskStatus[fetchAsyncImportTaskStatus^] |*POST* /api/rest/2.0/metadata/tml/async/status +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#fetchColumnSecurityRules[fetchColumnSecurityRules^] +|*POST* /api/rest/2.0/security/column/rules/fetch + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#fetchConnectionDiffStatus[fetchConnectionDiffStatus^] |*POST* /api/rest/2.0/connections/fetch-connection-diff-status/\{connection_identifier} @@ -464,6 +481,9 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#getObjectAccessToken[getObjectAccessToken^] |*POST* /api/rest/2.0/auth/token/object +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#getRelevantQuestions[getRelevantQuestions^] +|*POST* /api/rest/2.0/ai/relevant-questions/ + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#getSystemConfig[getSystemConfig^] |*GET* /api/rest/2.0/system/config @@ -491,6 +511,10 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#logout[logout^] |*POST* /api/rest/2.0/auth/session/logout +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#parameterizeMetadata[parameterizeMetadata^] |*POST* /api/rest/2.0/metadata/parameterize + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#publishMetadata[publishMetadata^] |*POST* /api/rest/2.0/security/metadata/publish + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#queryGetDecomposedQuery[queryGetDecomposedQuery^] |*POST* /api/rest/2.0/ai/analytical-questions @@ -503,6 +527,8 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#revokeToken[revokeToken^] |*POST* /api/rest/2.0/auth/token/revoke +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchCalendars[searchCalendars^]|*POST* /api/rest/2.0/calendars/search + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchCommits[searchCommits^] |*POST* /api/rest/2.0/vcs/git/commits/search @@ -518,8 +544,7 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchData[searchData^] |*POST* /api/rest/2.0/searchdata -|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchMetadata[searchMetadata^] |*POST* -/api/rest/2.0/metadata/search +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchMetadata[searchMetadata^] |*POST* /api/rest/2.0/metadata/search |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchOrgs[searchOrgs^] |*POST* /api/rest/2.0/orgs/search @@ -536,9 +561,10 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchUserGroups[searchUserGroups^] |*POST* /api/rest/2.0/groups/search -|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchUsers[searchUsers^] |*POST* -/api/rest/2.0/users/search +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#searchVariables[searchVariables^] |*POST* /api/rest/2.0/template/variables/search +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#sendAgentMessageStreaming[sendAgentMessageStreaming^] |*POST* +/api/rest/2.0/ai/agent/converse/sse |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#sendMessage[sendMessage^] |*POST* /api/rest/2.0/ai/conversation/\{conversation_identifier}/converse @@ -551,12 +577,23 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#unassignTag[unassignTag^] |*POST* /api/rest/2.0/tags/unassign -|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateConfig[updateConfig^] |*POST* -/api/rest/2.0/vcs/git/config/update +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#unparameterizeMetadata[unparameterizeMetadata^] |*POST* +/api/rest/2.0/metadata/unparameterize + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#unpublishMetadata[unpublishMetadata^] |*POST* /api/rest/2.0/security/metadata/unpublish + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateCalendar[updateCalendar^] |*POST* /api/rest/2.0/calendars/{calendar_identifier}/update + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateColumnSecurityRules[updateColumnSecurityRules^] |*POST* /api/rest/2.0/security/column/rules/update + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateConfig[updateConfig^] |*POST* /api/rest/2.0/vcs/git/config/update |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateConnection[updateConnection^] |*POST* /api/rest/2.0/connection/update +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateConnectionConfiguration[updateConnectionConfiguration^] |*POST* +/api/rest/2.0/connection-configurations/{configuration_identifier}/update + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateConnectionV2[updateConnectionV2^] |*POST* /api/rest/2.0/connections/\{connection_identifier}/update @@ -567,6 +604,9 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateDbtConnection[updateDbtConnection^] |*POST* /api/rest/2.0/dbt/update-dbt-connection +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateEmailCustomization[updateEmailCustomization^] +|*POST* /api/rest/2.0/customization/email/update + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateMetadataHeader[updateMetadataHeader^] |*POST* /api/rest/2.0/metadata/headers/update @@ -594,6 +634,14 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateUserGroup[updateUserGroup^] |*POST* /api/rest/2.0/groups/\{group_identifier}/update +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateVariable[updateVariable^] |*POST* /api/rest/2.0/template/variables/{identifier}/update + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#updateVariableValues[updateVariableValues^] |*POST* /api/rest/2.0/template/variables/update + + +|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#validateEmailCustomization[validateEmailCustomization^] |*POST* +/api/rest/2.0/customization/email/validate + |link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#validateMerge[validateMerge^] |*POST* /api/rest/2.0/vcs/git/branches/validate diff --git a/modules/ROOT/pages/rest-api-sdk-libraries.adoc b/modules/ROOT/pages/rest-api-sdk-libraries.adoc index 31514f29e..332fa0659 100644 --- a/modules/ROOT/pages/rest-api-sdk-libraries.adoc +++ b/modules/ROOT/pages/rest-api-sdk-libraries.adoc @@ -18,4 +18,3 @@ For more information about REST APIs, use the following resources: * Browse through the +++REST API v2 Playground+++ before you start constructing your API requests. The playground offers an interactive portal with comprehensive information about the API endpoints, request and response workflows. * For information about supported API endpoints, see xref:rest-api-v2-reference.adoc[REST API v2 reference]. * For information about new and deprecated features and enhancements, see xref:_rest_api_v2_0_changelog[REST API v2 Changelog]. - diff --git a/modules/ROOT/pages/rest-api-sdk-typescript.adoc b/modules/ROOT/pages/rest-api-sdk-typescript.adoc index dbd192eab..c721ac791 100644 --- a/modules/ROOT/pages/rest-api-sdk-typescript.adoc +++ b/modules/ROOT/pages/rest-api-sdk-typescript.adoc @@ -237,6 +237,7 @@ For information about new features, breaking changes, and deprecated parameters, For a complete list of supported methods to use for API requests, see the following resources: +//// [width="100%" cols="4,4,6"] [options='header'] |==== @@ -379,3 +380,138 @@ For a complete list of supported methods to use for API requests, see the follow | `updateConfig` | `POST /api/rest/2.0/vcs/git/config/update` | `validateMerge` | `POST /api/rest/2.0/vcs/git/branches/validate` |==== +//// + + +[width="100%" cols="3,5"] +[options='header'] + +|===== +|Method|HTTP request +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#activateUser[activateUser, window=_blank]|*POST* /api/rest/2.0/users/activate +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#assignChangeAuthor[assignChangeAuthor, window=_blank]|*POST* /api/rest/2.0/security/metadata/assign +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#assignTag[assignTag, window=_blank]|*POST* /api/rest/2.0/tags/assign +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#changeUserPassword[changeUserPassword, window=_blank]|*POST* /api/rest/2.0/users/change-password +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#commitBranch[commitBranch, window=_blank]|*POST* /api/rest/2.0/vcs/git/branches/commit +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#connectionConfigurationSearch[connectionConfigurationSearch, window=_blank]|*POST* /api/rest/2.0/connection-configurations/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#convertWorksheetToModel[convertWorksheetToModel, window=_blank]|*POST* /api/rest/2.0/metadata/worksheets/convert +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#copyObject[copyObject, window=_blank]|*POST* /api/rest/2.0/metadata/copyobject +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createCalendar[createCalendar, window=_blank]|*POST* /api/rest/2.0/calendars/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createConfig[createConfig, window=_blank]|*POST* /api/rest/2.0/vcs/git/config/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createConnection[createConnection, window=_blank]|*POST* /api/rest/2.0/connection/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createConnectionConfiguration[createConnectionConfiguration, window=_blank]|*POST* /api/rest/2.0/connection-configurations/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createConversation[createConversation, window=_blank]|*POST* /api/rest/2.0/ai/conversation/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createCustomAction[createCustomAction, window=_blank]|*POST* /api/rest/2.0/customization/custom-actions +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createEmailCustomization[createEmailCustomization, window=_blank]|*POST* /api/rest/2.0/customization/email +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createOrg[createOrg, window=_blank]|*POST* /api/rest/2.0/orgs/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createRole[createRole, window=_blank]|*POST* /api/rest/2.0/roles/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createSchedule[createSchedule, window=_blank]|*POST* /api/rest/2.0/schedules/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createTag[createTag, window=_blank]|*POST* /api/rest/2.0/tags/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createUser[createUser, window=_blank]|*POST* /api/rest/2.0/users/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createUserGroup[createUserGroup, window=_blank]|*POST* /api/rest/2.0/groups/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#createVariable[createVariable, window=_blank]|*POST* /api/rest/2.0/template/variables/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#dbtConnection[dbtConnection, window=_blank]|*POST* /api/rest/2.0/dbt/dbt-connection +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#dbtGenerateSyncTml[dbtGenerateSyncTml, window=_blank]|*POST* /api/rest/2.0/dbt/generate-sync-tml +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#dbtGenerateTml[dbtGenerateTml, window=_blank]|*POST* /api/rest/2.0/dbt/generate-tml +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#dbtSearch[dbtSearch, window=_blank]|*POST* /api/rest/2.0/dbt/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deactivateUser[deactivateUser, window=_blank]|*POST* /api/rest/2.0/users/deactivate +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteCalendar[deleteCalendar, window=_blank]|*POST* /api/rest/2.0/calendars/{calendar_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteConfig[deleteConfig, window=_blank]|*POST* /api/rest/2.0/vcs/git/config/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteConnection[deleteConnection, window=_blank]|*POST* /api/rest/2.0/connection/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteConnectionConfiguration[deleteConnectionConfiguration, window=_blank]|*POST* /api/rest/2.0/connection-configurations/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteConnectionV2[deleteConnectionV2, window=_blank]|*POST* /api/rest/2.0/connections/{connection_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteCustomAction[deleteCustomAction, window=_blank]|*POST* /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteDbtConnection[deleteDbtConnection, window=_blank]|*POST* /api/rest/2.0/dbt/{dbt_connection_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteEmailCustomization[deleteEmailCustomization, window=_blank]|*POST* /api/rest/2.0/customization/email/{template_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteMetadata[deleteMetadata, window=_blank]|*POST* /api/rest/2.0/metadata/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteOrg[deleteOrg, window=_blank]|*POST* /api/rest/2.0/orgs/{org_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteOrgEmailCustomization[deleteOrgEmailCustomization, window=_blank]|*POST* /api/rest/2.0/customization/email/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteRole[deleteRole, window=_blank]|*POST* /api/rest/2.0/roles/{role_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteSchedule[deleteSchedule, window=_blank]|*POST* /api/rest/2.0/schedules/{schedule_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteTag[deleteTag, window=_blank]|*POST* /api/rest/2.0/tags/{tag_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteUser[deleteUser, window=_blank]|*POST* /api/rest/2.0/users/{user_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteUserGroup[deleteUserGroup, window=_blank]|*POST* /api/rest/2.0/groups/{group_identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deleteVariable[deleteVariable, window=_blank]|*POST* /api/rest/2.0/template/variables/{identifier}/delete +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#deployCommit[deployCommit, window=_blank]|*POST* /api/rest/2.0/vcs/git/commits/deploy +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#downloadConnectionMetadataChanges[downloadConnectionMetadataChanges, window=_blank]|*POST* /api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier} +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#exportAnswerReport[exportAnswerReport, window=_blank]|*POST* /api/rest/2.0/report/answer +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#exportLiveboardReport[exportLiveboardReport, window=_blank]|*POST* /api/rest/2.0/report/liveboard +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#exportMetadataTML[exportMetadataTML, window=_blank]|*POST* /api/rest/2.0/metadata/tml/export +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#exportMetadataTMLBatched[exportMetadataTMLBatched, window=_blank]|*POST* /api/rest/2.0/metadata/tml/export/batch +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchAnswerData[fetchAnswerData, window=_blank]|*POST* /api/rest/2.0/metadata/answer/data +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchAnswerSqlQuery[fetchAnswerSqlQuery, window=_blank]|*POST* /api/rest/2.0/metadata/answer/sql +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchAsyncImportTaskStatus[fetchAsyncImportTaskStatus, window=_blank]|*POST* /api/rest/2.0/metadata/tml/async/status +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchColumnSecurityRules[fetchColumnSecurityRules, window=_blank]|*POST* /api/rest/2.0/security/column/rules/fetch +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchConnectionDiffStatus[fetchConnectionDiffStatus, window=_blank]|*POST* /api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier} +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchLiveboardData[fetchLiveboardData, window=_blank]|*POST* /api/rest/2.0/metadata/liveboard/data +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchLiveboardSqlQuery[fetchLiveboardSqlQuery, window=_blank]|*POST* /api/rest/2.0/metadata/liveboard/sql +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchLogs[fetchLogs, window=_blank]|*POST* /api/rest/2.0/logs/fetch +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchPermissionsOfPrincipals[fetchPermissionsOfPrincipals, window=_blank]|*POST* /api/rest/2.0/security/principals/fetch-permissions +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#fetchPermissionsOnMetadata[fetchPermissionsOnMetadata, window=_blank]|*POST* /api/rest/2.0/security/metadata/fetch-permissions +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#forceLogoutUsers[forceLogoutUsers, window=_blank]|*POST* /api/rest/2.0/users/force-logout +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#generateCSV[generateCSV, window=_blank]|*POST* /api/rest/2.0/calendars/generate-csv +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getCurrentUserInfo[getCurrentUserInfo, window=_blank]|*GET* /api/rest/2.0/auth/session/user +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getCurrentUserToken[getCurrentUserToken, window=_blank]|*GET* /api/rest/2.0/auth/session/token +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getCustomAccessToken[getCustomAccessToken, window=_blank]|*POST* /api/rest/2.0/auth/token/custom +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getFullAccessToken[getFullAccessToken, window=_blank]|*POST* /api/rest/2.0/auth/token/full +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getObjectAccessToken[getObjectAccessToken, window=_blank]|*POST* /api/rest/2.0/auth/token/object +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getSystemConfig[getSystemConfig, window=_blank]|*GET* /api/rest/2.0/system/config +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getSystemInformation[getSystemInformation, window=_blank]|*GET* /api/rest/2.0/system +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#getSystemOverrideInfo[getSystemOverrideInfo, window=_blank]|*GET* /api/rest/2.0/system/config-overrides +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#importMetadataTML[importMetadataTML, window=_blank]|*POST* /api/rest/2.0/metadata/tml/import +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#importMetadataTMLAsync[importMetadataTMLAsync, window=_blank]|*POST* /api/rest/2.0/metadata/tml/async/import +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#importUserGroups[importUserGroups, window=_blank]|*POST* /api/rest/2.0/groups/import +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#importUsers[importUsers, window=_blank]|*POST* /api/rest/2.0/users/import +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#login[login, window=_blank]|*POST* /api/rest/2.0/auth/session/login +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#logout[logout, window=_blank]|*POST* /api/rest/2.0/auth/session/logout +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#parameterizeMetadata[parameterizeMetadata, window=_blank]|*POST* /api/rest/2.0/metadata/parameterize +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#publishMetadata[publishMetadata, window=_blank]|*POST* /api/rest/2.0/security/metadata/publish +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#queryGetDecomposedQuery[queryGetDecomposedQuery, window=_blank]|*POST* /api/rest/2.0/ai/analytical-questions +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#resetUserPassword[resetUserPassword, window=_blank]|*POST* /api/rest/2.0/users/reset-password +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#revertCommit[revertCommit, window=_blank]|*POST* /api/rest/2.0/vcs/git/commits/{commit_id}/revert +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#revokeToken[revokeToken, window=_blank]|*POST* /api/rest/2.0/auth/token/revoke +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchCalendars[searchCalendars, window=_blank]|*POST* /api/rest/2.0/calendars/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchCommits[searchCommits, window=_blank]|*POST* /api/rest/2.0/vcs/git/commits/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchConfig[searchConfig, window=_blank]|*POST* /api/rest/2.0/vcs/git/config/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchConnection[searchConnection, window=_blank]|*POST* /api/rest/2.0/connection/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchCustomActions[searchCustomActions, window=_blank]|*POST* /api/rest/2.0/customization/custom-actions/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchData[searchData, window=_blank]|*POST* /api/rest/2.0/searchdata +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchEmailCustomization[searchEmailCustomization, window=_blank]|*POST* /api/rest/2.0/customization/email/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchMetadata[searchMetadata, window=_blank]|*POST* /api/rest/2.0/metadata/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchOrgs[searchOrgs, window=_blank]|*POST* /api/rest/2.0/orgs/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchRoles[searchRoles, window=_blank]|*POST* /api/rest/2.0/roles/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchSchedules[searchSchedules, window=_blank]|*POST* /api/rest/2.0/schedules/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchTags[searchTags, window=_blank]|*POST* /api/rest/2.0/tags/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchUserGroups[searchUserGroups, window=_blank]|*POST* /api/rest/2.0/groups/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchUsers[searchUsers, window=_blank]|*POST* /api/rest/2.0/users/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#searchVariables[searchVariables, window=_blank]|*POST* /api/rest/2.0/template/variables/search +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#sendMessage[sendMessage, window=_blank]|*POST* /api/rest/2.0/ai/conversation/{conversation_identifier}/converse +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#shareMetadata[shareMetadata, window=_blank]|*POST* /api/rest/2.0/security/metadata/share +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#singleAnswer[singleAnswer, window=_blank]|*POST* /api/rest/2.0/ai/answer/create +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#unassignTag[unassignTag, window=_blank]|*POST* /api/rest/2.0/tags/unassign +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#unparameterizeMetadata[unparameterizeMetadata, window=_blank]|*POST* /api/rest/2.0/metadata/unparameterize +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#unpublishMetadata[unpublishMetadata, window=_blank]|*POST* /api/rest/2.0/security/metadata/unpublish +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateCalendar[updateCalendar, window=_blank]|*POST* /api/rest/2.0/calendars/{calendar_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateColumnSecurityRules[updateColumnSecurityRules, window=_blank]|*POST* /api/rest/2.0/security/column/rules/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateConfig[updateConfig, window=_blank]|*POST* /api/rest/2.0/vcs/git/config/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateConnection[updateConnection, window=_blank]|*POST* /api/rest/2.0/connection/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateConnectionConfiguration[updateConnectionConfiguration, window=_blank]|*POST* /api/rest/2.0/connection-configurations/{configuration_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateConnectionV2[updateConnectionV2, window=_blank]|*POST* /api/rest/2.0/connections/{connection_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateCustomAction[updateCustomAction, window=_blank]|*POST* /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateDbtConnection[updateDbtConnection, window=_blank]|*POST* /api/rest/2.0/dbt/update-dbt-connection +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateEmailCustomization[updateEmailCustomization, window=_blank]|*POST* /api/rest/2.0/customization/email/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateMetadataHeader[updateMetadataHeader, window=_blank]|*POST* /api/rest/2.0/metadata/headers/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateMetadataObjId[updateMetadataObjId, window=_blank]|*POST* /api/rest/2.0/metadata/update-obj-id +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateOrg[updateOrg, window=_blank]|*POST* /api/rest/2.0/orgs/{org_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateRole[updateRole, window=_blank]|*POST* /api/rest/2.0/roles/{role_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateSchedule[updateSchedule, window=_blank]|*POST* /api/rest/2.0/schedules/{schedule_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateSystemConfig[updateSystemConfig, window=_blank]|*POST* /api/rest/2.0/system/config-update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateTag[updateTag, window=_blank]|*POST* /api/rest/2.0/tags/{tag_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateUser[updateUser, window=_blank]|*POST* /api/rest/2.0/users/{user_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateUserGroup[updateUserGroup, window=_blank]|*POST* /api/rest/2.0/groups/{group_identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateVariable[updateVariable]|*POST* /api/rest/2.0/template/variables/{identifier}/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#updateVariableValues[updateVariableValues, window=_blank]|*POST* /api/rest/2.0/template/variables/update +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#validateEmailCustomization[validateEmailCustomization, window=_blank]|*POST* /api/rest/2.0/customization/email/validate +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#validateMerge[validateMerge, window=_blank]|*POST* /api/rest/2.0/vcs/git/branches/validate +| link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/typescript/ThoughtSpotRestApi.md#validateToken[validateToken, window=_blank]|*POST* /api/rest/2.0/auth/token/validate +|=== diff --git a/modules/ROOT/pages/rest-api-v2-reference.adoc b/modules/ROOT/pages/rest-api-v2-reference.adoc index 603f8ca48..a99334a80 100644 --- a/modules/ROOT/pages/rest-api-v2-reference.adoc +++ b/modules/ROOT/pages/rest-api-v2-reference.adoc @@ -16,12 +16,12 @@ Access to ThoughtSpot data is controlled based on xref:api-user-management.adoc# [div boxAuto] -- -[width="100%" cols="6,4,2"] +[width="100%" cols="6,6,3"] [options='header'] |===== |API endpoint| Release version | Playground link -a|`PPOST /api/rest/2.0/ai/agent/conversation/create` + +a|`POST /api/rest/2.0/ai/agent/conversation/create` + Creates a conversation session with ThoughtSpot's Spotter agent. |ThoughtSpot Cloud: __10.13.0.cl or later__ + ThoughtSpot Software: __Not available__ a| +++Try it out+++ @@ -31,12 +31,12 @@ Creates a conversation session with ThoughtSpot Spotter |ThoughtSpot Cloud: __10.4.0.cl or later__ + ThoughtSpot Software: __Not available__ a| +++Try it out+++ -a|`POST /api/rest/2.0/ai/data-source-suggestions` +a|`POST /api/rest/2.0/ai/data-source-suggestions` + Gets data source recommendations for a given query. |ThoughtSpot Cloud: __10.13.0.cl or later__ + |+++Try it out+++ -a|`POST /api/rest/2.0/ai/relevant-questions/` +a|`POST /api/rest/2.0/ai/relevant-questions/` + Breaks down a user submitted query into relevant questions |ThoughtSpot Cloud: __10.13.0.cl or later__ + |+++Try it out+++ @@ -421,7 +421,9 @@ ThoughtSpot Software: __10.0.0.sw or later__ a| +++Try it out +++ - - |===== -- @@ -879,7 +879,17 @@ Gets details of the current configuration running on your cluster. a|ThoughtSpot Cloud: __9.2.0.cl or later__ + ThoughtSpot Software: __9.5.1.sw or later__ a| +++Try it out +++ + +a|`POST /api/rest/2.0/system/preferences/communication-channels/configure` + +Allows configuring communication channel preferences. +ThoughtSpot Cloud: __10.14.0.cl or later__ a| +++Try it out +++ + +a|`POST /api/rest/2.0/system/preferences/communication-channels/search` + +Allows searching communication channel preferences. +ThoughtSpot Cloud: __10.14.0.cl or later__ a| +++Try it out +++ + |===== + -- @@ -947,7 +957,6 @@ ThoughtSpot Software: __9.0.1.sw or later__ a| a|`POST /api/rest/2.0/users/search` + Gets details of one or several ThoughtSpot users. - |ThoughtSpot Cloud: __9.0.0.cl or later__ + ThoughtSpot Software: __9.0.1.sw or later__ a| +++Try it out+++ @@ -1013,43 +1022,6 @@ ThoughtSpot Software: __9.8.0.sw or later__ a| +++Try it out +++ - -a| `POST /api/rest/2.0/template/variables/search` [beta betaBackground]^Beta^ + -Allows searching template variables. -a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| -+++Try it out +++ - -|`POST /api/rest/2.0/template/variables/update` [beta betaBackground]^Beta^ + -Allows you to add, remove, or replace properties of one or several template variables. - -a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| -+++Try it out +++ - -| `POST /api/rest/2.0/template/variables/{identifier}/update`[beta betaBackground]^Beta^ + -Allows updating properties of a template variable. - -a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| -+++Try it out +++ -| `POST /api/rest/2.0/template/variables/{identifier}/delete` [beta betaBackground]^Beta^ + -Deletes a template variable. -a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| -+++Try it out +++ -|===== --- - == Version control [div boxAuto] @@ -1127,3 +1099,78 @@ ThoughtSpot Software: __9.5.0.sw or later__ a| +++Try it out +++ |===== -- + +== Variable [beta betaBackground]^Beta^ + +[div boxAuto] +-- +[width="100%" cols="6,4,2"] +[options='header'] +|===== +|API endpoint| Release version | Playground link +| `POST /api/rest/2.0/template/variables/create` + +Allows creating a template variable which can be used to parameterize fields in a metadata object. + +a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| ++++Try it out +++ + +a| `POST /api/rest/2.0/template/variables/search` + +Allows searching template variables. +a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| ++++Try it out +++ + +|`POST /api/rest/2.0/template/variables/update` [tag redBackground]#DEPRECATED# + +Allows you to add, remove, or replace properties of one or several template variables. + +a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| Not available in the Playground + +| `POST /api/rest/2.0/template/variables/{identifier}/update` + +Allows updating properties of a template variable. + +a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| ++++Try it out +++ + +| `POST /api/rest/2.0/template/variables/update-values` + +Allows updating properties one or several variable. + +a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| ++++Try it out +++ + +| `POST /api/rest/2.0/template/variables/{identifier}/delete` + +Deletes a template variable. +a|ThoughtSpot Cloud: __10.9.0.cl or later__ a| ++++Try it out +++ +|===== +-- + +== Webhooks [beta betaBackground]^Beta^ + +[div boxAuto] +-- +[width="100%" cols="6,4,2"] +[options='header'] +|===== +|API endpoint| Release version | Playground link +| `POST /api/rest/2.0/webhooks/create` + +Allows creating a webhook and configuring a destination endpoint for webhook payloads. + +a|ThoughtSpot Cloud: __10.14.0.cl or later__ a| ++++Try it out +++ + +a| `POST /api/rest/2.0/webhooks/search` + +Retrieves webhook objects. +a|ThoughtSpot Cloud: __10.14.0.cl or later__ a| ++++Try it out +++ + +|`POST /api/rest/2.0/webhooks/{webhook_identifier}/update` + +Allows you to edit properties of a webhook object. + +a|ThoughtSpot Cloud: __10.14.0.cl or later__ a| ++++Try it out +++ + +| `POST /api/rest/2.0/webhooks/delete` + +Deletes a webhook object. +a|ThoughtSpot Cloud: __10.14.0.cl or later__ a| ++++Try it out +++ +|===== +-- diff --git a/modules/ROOT/pages/rest-apiv2-changelog.adoc b/modules/ROOT/pages/rest-apiv2-changelog.adoc index f610cb71a..b0e74ae7d 100644 --- a/modules/ROOT/pages/rest-apiv2-changelog.adoc +++ b/modules/ROOT/pages/rest-apiv2-changelog.adoc @@ -50,9 +50,9 @@ POST /api/rest/2.0/ai/agent/{conversation_identifier}/converse //// === Variable API enhancements -The following enhancements are introduced in variable API endpoints: +The variable API enhancements are listed in the following sections. For additional details, see xref:variables.adoc[Define variables]. -Variable creation:: +==== Variable creation API * The variable creation endpoint `/api/rest/2.0/template/variables/create` doesn't support assigning values to a variable. To assign values to a variable, use the `/api/rest/2.0/template/variables/update-values` endpoint. * The `sensitive` parameter is renamed as `is_sensitive`. @@ -60,16 +60,15 @@ Variable creation:: //* You can now create formula variables. To create a formula variable, use define the variable type as `FORMULA_VARIABLE` variable type in your API request . -Variables update:: -[tag redBackground]#BREAKING CHANGE# -* The `/api/rest/2.0/template/variables/update` endpoint is deprecated and replaced with `/api/rest/2.0/template/variables/{identifier}/update`. To update a variable, use the `POST /api/rest/2.0/template/variables/update` endpoint. -* The resource path for updating multiple variable values has changed from `/api/rest/2.0/template/variables/{identifier}/update` to `/api/rest/2.0/template/variables/update-values`. To assign values to one or several variables, use the `POST /api/rest/2.0/template/variables/update-values` endpoint. +==== Variables update APIs [tag redBackground]#BREAKING CHANGE# + +The `/api/rest/2.0/template/variables/update` endpoint is deprecated and is replaced with `/api/rest/2.0/template/variables/update-values`. + +To update the properties of a specific variable, use the `/api/rest/2.0/template/variables/{identifier}/update` endpoint and to assign values to one or several variables, use the `POST /api/rest/2.0/template/variables/update-values` endpoint. + +==== Variables search API -Variables search:: * The variables search API endpoint `/api/rest/2.0/template/variables/search` now includes the `value_scope` parameter that allows you to filter the API response by the objects to which the variable is mapped. * Filtering API response by `EDITABLE_METADATA_AND_VALUES` output format is no longer supported. -For more information, see xref:variables.adoc[Define variables]. === User API enhancements The following APIs now support `variable_values` parameter. The `variable_values` property can be used for user-specific customization. diff --git a/modules/ROOT/pages/variables.adoc b/modules/ROOT/pages/variables.adoc index 946cb0a36..683f26473 100644 --- a/modules/ROOT/pages/variables.adoc +++ b/modules/ROOT/pages/variables.adoc @@ -18,8 +18,8 @@ Note the following enhancements and breaking changes introduced in ThoughtSpot C ** The `sensitive` parameter is renamed as `is_sensitive`. * Variables update and value assignment + -** The `/api/rest/2.0/template/variables/update` endpoint is deprecated and replaced with `/api/rest/2.0/template/variables/{identifier}/update`. To update a variable, use the `POST /api/rest/2.0/template/variables/update` endpoint. -** The resource path for updating multiple variable values has changed from `/api/rest/2.0/template/variables/{identifier}/update` to `/api/rest/2.0/template/variables/update-values`. To assign values to one or several variables, use the `POST /api/rest/2.0/template/variables/update-values` endpoint. +The `/api/rest/2.0/template/variables/update` endpoint is deprecated and is replaced with `/api/rest/2.0/template/variables/update-values`. + +To update the properties of a specific variable, use the `/api/rest/2.0/template/variables/{identifier}/update` endpoint and to assign values to one or several variables, use the `POST /api/rest/2.0/template/variables/update-values` endpoint. * Variable search + @@ -75,7 +75,7 @@ The Double data type refers to a floating point numeric type that is recommended Date format. For example, 2025-10-20. * `DATE_TIME` + Date with time stamp. For example, 2025-10-20 14:30:00. - ++ [NOTE] The API doesn't support setting data type for the `TABLE_MAPPING`, `CONNECTION_PROPERTY`, and `CONNECTION_PROPERTY_PER_PRINCIPAL` variable types. diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index 01061ea56..669f2fbf6 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -28,7 +28,7 @@ For more information, see xref:code-based-custom-actions.adoc[Code based custom === Webhooks for Liveboard schedule events [beta betaBackground]^Beta^ -You can now configure a xref:webhooks-lb-schedule.adoc[webhook for Liveboard schedule events] to automate notifications to external applications. This feature allows you to send Liveboard reports directly to a webhook endpoint, such as your internal marketing or incident management app, at a scheduled frequency. It eliminates the need to manually process data from email notifications and gives you full control over how the data is handled in your downstream workflows. +You can now configure a xref:webhooks-lb-schedule.adoc[webhook for Liveboard schedule events] to automate notifications to external applications. This feature allows you to send Liveboard reports directly to a webhook endpoint and create your own custom emails or workflow. This feature is currently in beta and is not enabled by default. To enable it on your instance, contact ThoughtSpot Support.