From 179fe17d5e234db6782015e2285388d7c0526383 Mon Sep 17 00:00:00 2001 From: "podishetti.nagavenu" Date: Tue, 27 Jan 2026 15:30:16 +0530 Subject: [PATCH 1/8] initial commit for email customization --- api-spec/openapiSpecv3-2_0.json | 15862 +++++++++++++++++------------- 1 file changed, 9136 insertions(+), 6726 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index 98385330d..66a5d0c46 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -61,6 +61,14 @@ ], "description": "Roles for version 9.12.0.cl" }, + { + "name": "26.4.0.cl", + "id": "26.4.0.cl", + "tags": [ + "26.4.0.cl" + ], + "description": "Roles for version 26.4.0.cl" + }, { "name": "10.12.0.cl", "id": "10.12.0.cl", @@ -93,6 +101,14 @@ ], "description": "Roles for version 26.2.0.cl" }, + { + "name": "26.5.0.cl", + "id": "26.5.0.cl", + "tags": [ + "26.5.0.cl" + ], + "description": "Roles for version 26.5.0.cl" + }, { "name": "9.6.0.cl", "id": "9.6.0.cl", @@ -187,7 +203,7 @@ "/api/rest/2.0/ai/agent/conversation/create": { "post": { "operationId": "createAgentConversation", - "description": "Beta Version: 10.13.0.cl or later", + "description": "\nBeta Version: 10.13.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.13.0.cl" @@ -196,29 +212,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_context": { - "description": "Context for the conversation.", - "allOf": [ - { - "$ref": "#/components/schemas/ContextPayloadV2Input" - } - ] - }, - "conversation_settings": { - "description": "Conversation settings.", - "allOf": [ - { - "$ref": "#/components/schemas/ConversationSettingsInput" - } - ] - } - }, - "required": [ - "metadata_context", - "conversation_settings" - ] + "$ref": "#/components/schemas/CreateAgentConversationRequest" } } }, @@ -281,20 +275,7 @@ "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" - ] + "$ref": "#/components/schemas/CreateConversationRequest" } } }, @@ -357,16 +338,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "query": { - "description": "User query used to suggest data sources.", - "type": "string" - } - }, - "required": [ - "query" - ] + "$ref": "#/components/schemas/GetDataSourceSuggestionsRequest" } } }, @@ -429,16 +401,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "data_source_identifier": { - "description": "Unique ID or name of the data-model for which to retrieve NL instructions.", - "type": "string" - } - }, - "required": [ - "data_source_identifier" - ] + "$ref": "#/components/schemas/GetNLInstructionsRequest" } } }, @@ -501,43 +464,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_context": { - "description": "metadata for the query to enable generation of relevant sub-questions; at least one context identifier is required.", - "allOf": [ - { - "$ref": "#/components/schemas/MetadataContext" - } - ] - }, - "limit_relevant_questions": { - "description": "Maximum number of relevant questions that is allowed in the response, default = 5.", - "type": "integer", - "format": "int32" - }, - "bypass_cache": { - "description": "If true, results are not returned from cache & calculated every time.", - "type": "boolean", - "nullable": true - }, - "query": { - "description": "A user query that requires breaking down into smaller, more manageable analytical questions to facilitate better understanding and analysis.", - "type": "string" - }, - "ai_context": { - "description": "Additional context to guide the response.", - "allOf": [ - { - "$ref": "#/components/schemas/AIContext" - } - ] - } - }, - "required": [ - "metadata_context", - "query" - ] + "$ref": "#/components/schemas/GetRelevantQuestionsRequest" } } }, @@ -591,7 +518,7 @@ "/api/rest/2.0/ai/analytical-questions": { "post": { "operationId": "queryGetDecomposedQuery", - "description": "Beta Version: 10.7.0.cl or later", + "description": "\nBeta Version: 10.7.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "AI", @@ -601,54 +528,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "answerIds": { - "description": "List of answer unique identifiers (GUIDs) whose data will be used to guide the response.", - "type": "array", - "items": { - "type": "string" - } - }, - "content": { - "description": "User provided content like text data, csv data as a string message to provide context & potentially improve the quality of the response.", - "type": "array", - "items": { - "type": "string" - } - }, - "conversationId": { - "description": "Unique identifier to denote current conversation.", - "type": "string" - }, - "liveboardIds": { - "description": "List of liveboard unique identifiers (GUIDs) whose data will be used to guide the response.", - "type": "array", - "items": { - "type": "string" - } - }, - "maxDecomposedQueries": { - "description": "Maximum number of decomposed queries that is allowed in the response, default = 5.", - "type": "integer", - "format": "int32" - }, - "nlsRequest": { - "description": "NLSRequest object containing user query & instructions.", - "allOf": [ - { - "$ref": "#/components/schemas/Input_eureka_NLSRequest" - } - ] - }, - "worksheetIds": { - "description": "List of worksheetIds to provide context for decomposing user query into analytical queries that can be run on them.", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/QueryGetDecomposedQueryRequest" } } }, @@ -711,19 +591,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "messages": { - "description": "messages to be sent to the agent", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "messages" - ] + "$ref": "#/components/schemas/SendAgentMessageRequest" } } }, @@ -796,24 +664,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "conversation_identifier": { - "description": "Unique identifier for the conversation (used to track context)", - "type": "string" - }, - "messages": { - "description": "messages to be sent to the agent", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "conversation_identifier", - "messages" - ] + "$ref": "#/components/schemas/SendAgentMessageStreamingRequest" } } }, @@ -876,21 +727,7 @@ "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" - ] + "$ref": "#/components/schemas/SendMessageRequest" } } }, @@ -969,24 +806,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "data_source_identifier": { - "description": "Unique ID or name of the data-model for which to set NL instructions.", - "type": "string" - }, - "nl_instructions_info": { - "description": "List of NL instructions to set for the data-model.", - "type": "array", - "items": { - "$ref": "#/components/schemas/NLInstructionsInfoInput" - } - } - }, - "required": [ - "data_source_identifier", - "nl_instructions_info" - ] + "$ref": "#/components/schemas/SetNLInstructionsRequest" } } }, @@ -1049,21 +869,7 @@ "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" - ] + "$ref": "#/components/schemas/SingleAnswerRequest" } } }, @@ -1117,7 +923,7 @@ "/api/rest/2.0/auth/session/user": { "get": { "operationId": "getCurrentUserInfo", - "description": "\n Version: 9.0.0.cl or later\n\nRetrieves details of the current user session for the token provided in the request header.\n\nAny ThoughtSpot user can access this endpoint and send an API request. The data returned in the API response varies according to user's privilege and object access permissions.\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nRetrieves details of the current user session for the token provided in the request header.\n\nAny ThoughtSpot user can access this endpoint and send an API request. The data returned in the API response varies according to user's privilege and object access permissions.\n\n**NOTE**: In ThoughtSpot, users with cluster administration privileges can access all Orgs by default. However, unless the administrator is explicitly added to an Org, the Orgs list in the session information returned by the API will include only the Primary Org. To include other Orgs in the API response, you must explicitly add the administrator to each Org in the Admin settings page in the UI or via user REST API.\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" @@ -1243,7 +1049,7 @@ "/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\nIf Multi-Factor Authentication (MFA) is enabled on your instance, the API login request with basic authentication (`username` and `password` ) returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\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\nSpecify the object type as `LOGICAL_TABLE`. \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. If `auto_create` is set to `true`, it won't create formula variables and hence won't be applicable for `variable_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##### Formula Variables\nBefore using variables_values, variables must be created using Create Variable API with type as Formula_Variable (/api/rest/2.0/template/variables/create)\nThe persist_option RESET and NONE cannot be used when variable_values are provided in the request.\nIf you are working with variable_values, you must use other (APPEND, REPLACE) supported modes.\nIf you want to use RESET or NONE, do not pass any variable_values. In such cases, variable_values will remain unaffected.\nWhen using object_id with variable_values, models are supported. \n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 10.4.0.cl or later\n\nCreates an authentication token that provides values for the formula variables in the Row Level Security (RLS) rules for a given user. Recommended for use cases that require Attribute-based access control (ABAC) via RLS.\n\n#### Required privileges\n\nTo add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. 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 are required.\n\nTo configure formula variables for all Orgs on your instance or the Primary Org, cluster administration privileges are required. Org administrators can configure formula variables for their respective Orgs. If Role-Based Access Control (RBAC) is enabled, users with the `CAN_MANAGE_VARIABLES` (**Can manage variables**) role privilege can also create and manage variables for their Org context.\n\n#### Usage guidelines\n\nYou can generate a token by providing a `username` and `password`, or by using a `secret_key`. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**:\n* When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n* If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\n\nThe token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required.\n\n#### ABAC via RLS\n\nTo implement ABAC via RLS and assign security entitlements to users during session creation, generate a token with custom variable values. The values set in the authentication token are applied to the formula variables referenced in RLS rules at the table level, which determines the data each user can access based on their entitlements.\n\nThe variable values can be configured to persist for a specific set of Models in user sessions initiated with the token, allowing different RLS rules to be set for different data models. Once defined, the rules are added to the user's `variable_values` object, after which all sessions will use the persisted values.\n\nFor more information, see [ABAC via tokens Documentation](https://developers.thoughtspot.com/docs/abac-via-rls-variables).\n\n##### Formula variables\nBefore defining variable values, ensure the variables are created and available on your instance. To create a formula variable, you can use the **Create variable** (`/api/rest/2.0/template/variables/create`) REST API endpoint, with the variable `type` set as `Formula_Variable` in the API request.\n\nThe API doesn't support `\"persist_option\": \"RESET\"` and `\"persist_option\": \"NONE\"` when `variable_values` are defined in the request. If you are using `variable_values` for token generation, you must use other supported persist options such as `APPEND` or `REPLACE`.\n\nIf you want to use `RESET` or `NONE`, do not pass any `variable_values`. In such cases, `variable_values` will remain unaffected.\n\n#### Supported objects\n\nThe supported object type is `LOGICAL_TABLE`. When using `object_id` with `variable_values`, models are supported.\n\n#### Just-in-time provisioning\n\nFor [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `groups`\n\nSet `auto_create` to `true` if the username does not exist in ThoughtSpot. If the username already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email, Org and group entitlements will not be updated with new values. Setting `auto_create` to `true` does not create formula variables. Hence, this setting will not be applicable to `variable_values`.\n\n#### Important point to note\nAll options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Persist options such as `APPEND` and `REPLACE` will persist `variable_values` on the user profile when the token is created.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "10.4.0.cl" @@ -1252,96 +1058,7 @@ "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 or name of the Org context to log in to. If the Org ID or name is not specified but a secret key is provided, the user will be logged into the Org associated with the secret key. If neither the Org ID/name nor the secret key is provided, the user will be logged into the Org context from their previous login session.", - "type": "string" - }, - "persist_option": { - "description": "Indicates whether the specified attributes should be persisted or not. RESET and NONE are not applicable if you are setting variable_values.", - "type": "string", - "enum": [ - "REPLACE", - "APPEND", - "NONE", - "RESET" - ] - }, - "filter_rules": { - "description": "Filter rules.", - "type": "array", - "items": { - "$ref": "#/components/schemas/FilterRules" - } - }, - "parameter_values": { - "description": "Allows developers to assign parameter values for existing parameters to a user at login. Note: Using parameter values for row level security use cases will ultimately be deprecated. Developers can still pass data security values via the Custom Access token via the variable_values field and create RLS rules based on custom variables. Please refer to the [ABAC via RLS documentation](https://developers.thoughtspot.com/docs/abac-user-parameters) for more details.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ParameterValues" - } - }, - "variable_values": { - "description": "List of variable values where `name` references an existing formula variable and `values` is any value from the corresponding column.
Version: 10.14.0.cl or later", - "type": "array", - "items": { - "$ref": "#/components/schemas/VariableValues" - } - }, - "objects": { - "description": "Objects on which the parameter and variable 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. New formula variables won't be created.
Version: 10.5.0.cl or later", - "default": true, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "username", - "persist_option" - ] + "$ref": "#/components/schemas/GetCustomAccessTokenRequest" } } }, @@ -1406,7 +1123,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`, 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\nIf Multi-Factor Authentication (MFA) is enabled on your instance, the API login request with basic authentication (`username` and `password` ) returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\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#### 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.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nGenerates an authentication token for creating a full session in ThoughtSpot for a given user. Recommended for use cases that do not require Attribute-based access control (ABAC) via Row Level Security (RLS).\n\n#### Usage guidelines\n\nYou can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**:\n* When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n* If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\n\nThe token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required.\n\n#### Just-in-time provisioning\n\nFor [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `group_identifiers`\n\nSet `auto_create` to `true` if the username does not exist in ThoughtSpot. If the user already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email and group assignment will be updated.\n\nTo add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. 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#### Important point to note\nAll options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" @@ -1415,66 +1132,7 @@ "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_id": { - "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": "integer", - "format": "int32" - }, - "email": { - "description": "Email address of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", - "type": "string" - }, - "display_name": { - "description": "Indicates display name of the user. Use this parameter to provision a user just-in-time (JIT).", - "type": "string" - }, - "auto_create": { - "description": " Creates a new user if the specified username does not already 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. ", - "default": false, - "type": "boolean", - "nullable": true - }, - "group_identifiers": { - "description": "ID or name of the groups to which the newly created user belongs. Use this parameter to provision a user just-in-time (JIT).", - "type": "array", - "items": { - "type": "string" - } - }, - "user_parameters": { - "description": "
Version: 9.10.5.cl or laterDeprecated: 10.4.0.cl and later
\n\nDefine attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).", - "allOf": [ - { - "$ref": "#/components/schemas/User_Parameter_Options" - } - ] - } - }, - "required": [ - "username" - ] + "$ref": "#/components/schemas/GetFullAccessTokenRequest" } } }, @@ -1539,7 +1197,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`, 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\nIf Multi-Factor Authentication (MFA) is enabled on your instance, the API login request with basic authentication (`username` and `password` ) returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\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#### 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.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nGenerates an authentication token that provides access to a specific metadata object. This object list is intersected with the list of objects the user is allowed to access via group membership. For more information, see [Object security](https://docs.thoughtspot.com/cloud/latest/security-data-object#object_security).\n\n#### Usage guidelines\n\nYou can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**:\n* When both `password` and `secret_key` are included in the API request, `password` takes precedence.\n* If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\n\nThe token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required.\n\n#### Just-in-time provisioning\n\nFor [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request:\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`, user properties such as display name, email, and group assignment will be updated.\n\nTo add a new user and assign privileges, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. 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#### Important point to note\n\nAll options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" @@ -1548,70 +1206,7 @@ "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" - }, - "object_id": { - "description": "GUID of the ThoughtSpot metadata object that the user can access. The bearer will only have access to the object specified in the API request.", - "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_id": { - "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": "integer", - "format": "int32" - }, - "email": { - "description": "Email address of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", - "type": "string" - }, - "display_name": { - "description": "Display name of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", - "type": "string" - }, - "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. ", - "default": false, - "type": "boolean", - "nullable": true - }, - "group_identifiers": { - "description": "Unique ID or name of the groups to which you want to assign the new user. You can specify this attribute to dynamically assign privileges during just-in-time (JIT) provisioning.", - "type": "array", - "items": { - "type": "string" - } - }, - "user_parameters": { - "description": "
Version: 9.10.5.cl or laterDeprecated: 10.4.0.cl and later
\n\nDefine attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).", - "allOf": [ - { - "$ref": "#/components/schemas/User_Parameter_Options" - } - ] - } - }, - "required": [ - "username" - ] + "$ref": "#/components/schemas/GetObjectAccessTokenRequest" } } }, @@ -1685,27 +1280,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "username": { - "description": "Username of the ThoughtSpot user", - "type": "string" - }, - "password": { - "description": "Password of the user account", - "type": "string" - }, - "org_identifier": { - "description": "ID of the Org context to log in to. If Org ID is not specified, the user will be logged in to the Org context of their previous login session.", - "type": "string" - }, - "remember_me": { - "description": "A flag to remember the user session. When set to true, a session cookie is created and used in subsequent API requests.", - "default": false, - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/LoginRequest" } } }, @@ -1827,15 +1402,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "user_identifier": { - "type": "string" - }, - "token": { - "type": "string" - } - } + "$ref": "#/components/schemas/RevokeTokenRequest" } } }, @@ -1901,15 +1468,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "token": { - "type": "string" - } - }, - "required": [ - "token" - ] + "$ref": "#/components/schemas/ValidateTokenRequest" } } }, @@ -1970,41 +1529,19 @@ } } }, - "/api/rest/2.0/connection-configurations/search": { + "/api/rest/2.0/collections/create": { "post": { - "operationId": "connectionConfigurationSearch", - "description": "\n Version: 10.12.0.cl or later\n\nGets connection configuration objects.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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#### Usage guidelines\n* To get a list of all configurations available in the ThoughtSpot system, send the API request with only the connection name or GUID in the request body.\n* To fetch details of a configuration object, specify the configuration object name or GUID.\n\n\n\n\n#### Endpoint URL\n", + "operationId": "createCollection", + "description": "\n Version: 26.4.0.cl or later\n\nCreates a new collection in ThoughtSpot.\n\nCollections allow you to organize and group related metadata objects such as Liveboards, Answers, worksheets, and other data objects. You can also create nested collections (sub-collections) to build a hierarchical structure.\n\n#### Supported operations\n\nThe API endpoint lets you perform the following operations:\n\n* Create a new collection\n* Add metadata objects (Liveboards, Answers, Logical Tables) to the collection\n* Create nested collections by adding sub-collections\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connection Configurations", - "10.12.0.cl" + "Collections", + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - }, - "configuration_identifier": { - "description": "Unique ID or name of the configuration.", - "type": "string" - }, - "policy_type": { - "description": "Type of policy.", - "type": "string", - "enum": [ - "NO_POLICY", - "PRINCIPALS", - "PROCESSES" - ] - } - }, - "required": [ - "connection_identifier" - ] + "$ref": "#/components/schemas/CreateCollectionRequest" } } }, @@ -2013,14 +1550,11 @@ "parameters": [], "responses": { "200": { - "description": "Configuration fetched successfully.", + "description": "Collection created successfully", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConnectionConfigurationResponse" - } + "$ref": "#/components/schemas/Collection" } } } @@ -2068,96 +1602,19 @@ } } }, - "/api/rest/2.0/connection-configurations/create": { + "/api/rest/2.0/collections/delete": { "post": { - "operationId": "createConnectionConfiguration", - "description": "\n Version: 10.12.0.cl or later\n\nCreates an additional configuration to an existing connection to a data warehouse. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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#### Usage guidelines\n\n * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes:\n ```\n {\n \"user\":\"DEV_USER\",\n \"password\":\"TestConn123\",\n \"role\":\"DEV\",\n \"warehouse\":\"DEV_WH\"\n }\n ```\n\n* If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field.\n* If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field.\n* If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields.\n\n#### Parameterized Connection Support\nFor parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized.\n\n\n\n\n\n#### Endpoint URL\n", + "operationId": "deleteCollection", + "description": "\n Version: 26.4.0.cl or later\n\nDeletes one or more collections from ThoughtSpot.\n\n#### Delete options\n\n* **delete_children**: When set to `true`, deletes the child objects (metadata items) within the collection that the user has access to. Objects that the user does not have permission to delete will be skipped.\n* **dry_run**: When set to `true`, performs a preview of the deletion operation without actually deleting anything. The response shows what would be deleted, allowing you to review before committing the deletion.\n\n#### Response\n\nThe response includes:\n* **metadata_deleted**: List of metadata objects that were successfully deleted\n* **metadata_skipped**: List of metadata objects that were skipped due to lack of permissions or other constraints\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connection Configurations", - "10.12.0.cl" + "Collections", + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Unique name for the configuration.", - "type": "string" - }, - "description": { - "description": "Description of the configuration.", - "type": "string" - }, - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - }, - "same_as_parent": { - "description": "Specifies whether the connection configuration should inherit all properties and authentication\ntype from its parent connection. This attribute is only applicable to parameterized connections.\nWhen set to true, the configuration uses only the connection properties and authentication type\ninherited from the parent.
Version: 26.2.0.cl or later", - "default": false, - "type": "boolean", - "nullable": true - }, - "policy_process_options": { - "description": "This attribute is only applicable to parameterized connections. Ensure that the policy is\nset to Processes to allow the configuration to be used exclusively for system processes.
Version: 26.2.0.cl or later", - "allOf": [ - { - "$ref": "#/components/schemas/PolicyProcessOptionsInput" - } - ] - }, - "authentication_type": { - "description": "Type of authentication used for the connection.", - "default": "SERVICE_ACCOUNT", - "type": "string", - "enum": [ - "SERVICE_ACCOUNT", - "KEY_PAIR", - "PERSONAL_ACCESS_TOKEN", - "OAUTH_WITH_SERVICE_PRINCIPAL", - "OAUTH_CLIENT_CREDENTIALS" - ] - }, - "configuration": { - "description": "Configuration properties in JSON.", - "type": "object" - }, - "policy_type": { - "description": "Type of policy.", - "default": "NO_POLICY", - "type": "string", - "enum": [ - "NO_POLICY", - "PRINCIPALS", - "PROCESSES" - ] - }, - "policy_principals": { - "description": "Unique ID or name of the User and User Groups.", - "type": "array", - "items": { - "type": "string" - } - }, - "policy_processes": { - "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING and ROW_COUNT_STATS.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "SAGE_INDEXING", - "ROW_COUNT_STATS" - ] - } - } - }, - "required": [ - "name", - "connection_identifier", - "configuration" - ] + "$ref": "#/components/schemas/DeleteCollectionRequest" } } }, @@ -2166,11 +1623,11 @@ "parameters": [], "responses": { "200": { - "description": "Connection configuration successfully created.", + "description": "Collections deleted successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectionConfigurationResponse" + "$ref": "#/components/schemas/CollectionDeleteResponse" } } } @@ -2205,6 +1662,16 @@ } } }, + "404": { + "description": "Resource not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "500": { "description": "Unexpected error", "content": { @@ -2218,33 +1685,19 @@ } } }, - "/api/rest/2.0/connection-configurations/delete": { + "/api/rest/2.0/collections/search": { "post": { - "operationId": "deleteConnectionConfiguration", - "description": "\n Version: 10.12.0.cl or later\n\nDeletes connection configuration objects.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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", + "operationId": "searchCollections", + "description": "\n Version: 26.4.0.cl or later\n\nGets a list of collections available in ThoughtSpot.\n\nTo get details of a specific collection, specify the collection GUID or name. You can also filter the API response based on the collection name pattern, author, and other criteria.\n\n#### Search options\n\n* **name_pattern**: Use '%' as a wildcard character to match collection names\n* **collection_identifiers**: Search for specific collections by their GUIDs or names\n* **include_metadata**: When set to `true`, includes the metadata objects within each collection in the response\n\n**NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available collections, set `record_size` to `-1`.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connection Configurations", - "10.12.0.cl" + "Collections", + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "configuration_identifier": { - "description": "Unique ID or name of the configuration.", - "type": "string" - }, - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - } - }, - "required": [ - "configuration_identifier", - "connection_identifier" - ] + "$ref": "#/components/schemas/SearchCollectionsRequest" } } }, @@ -2252,8 +1705,15 @@ }, "parameters": [], "responses": { - "204": { - "description": "Connection Configurations successfully deleted." + "200": { + "description": "Successfully retrieved list of collections", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionSearchResponse" + } + } + } }, "400": { "description": "Invalid request.", @@ -2298,102 +1758,19 @@ } } }, - "/api/rest/2.0/connection-configurations/{configuration_identifier}/update": { + "/api/rest/2.0/collections/{collection_identifier}/update": { "post": { - "operationId": "updateConnectionConfiguration", - "description": "\n Version: 10.12.0.cl or later\n\nUpdates a connection configuration object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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#### Supported operations\nThis API endpoint lets you perform the following operations in a single API request:\n\n * Edit the name or description of the configuration\n * Edit the configuration properties\n * Edit the `policy_type`\n * Edit the type of authentication\n * Enable or disable a configuration\n\n#### Parameterized Connection Support\nFor parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized.\n\n **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`.\n\n\n\n\n#### Endpoint URL\n", + "operationId": "updateCollection", + "description": "\n Version: 26.4.0.cl or later\n\nUpdates an existing collection in ThoughtSpot.\n\n#### Supported operations\n\nThis API endpoint lets you perform the following operations:\n\n* Update collection name and description\n* Change visibility settings\n* Add metadata objects to the collection (operation: ADD)\n* Remove metadata objects from the collection (operation: REMOVE)\n* Replace all metadata objects in the collection (operation: REPLACE)\n\n#### Operation types\n\n* **ADD**: Adds the specified metadata objects to the existing collection without removing current items\n* **REMOVE**: Removes only the specified metadata objects from the collection\n* **REPLACE**: Replaces all existing metadata objects with the specified items (default behavior)\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connection Configurations", - "10.12.0.cl" + "Collections", + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - }, - "name": { - "description": "Name of the configuration to update.", - "type": "string" - }, - "description": { - "description": "Description of the configuration.", - "type": "string" - }, - "same_as_parent": { - "description": "Specifies whether the connection configuration should inherit all properties and authentication\ntype from its parent connection. This attribute is only applicable to parameterized connections.\nWhen set to true, the configuration uses only the connection properties and authentication type\ninherited from the parent.
Version: 26.2.0.cl or later", - "default": false, - "type": "boolean", - "nullable": true - }, - "policy_process_options": { - "description": "This attribute is only applicable to parameterized connections. Ensure that the policy is\nset to Processes to allow the configuration to be used exclusively for system processes.
Version: 26.2.0.cl or later", - "allOf": [ - { - "$ref": "#/components/schemas/PolicyProcessOptionsInput" - } - ] - }, - "authentication_type": { - "description": "Type of authentication.", - "type": "string", - "enum": [ - "SERVICE_ACCOUNT", - "OAUTH", - "OAUTH_WITH_SERVICE_PRINCIPAL", - "EXTOAUTH", - "KEY_PAIR", - "EXTOAUTH_WITH_PKCE", - "OAUTH_WITH_PKCE", - "PERSONAL_ACCESS_TOKEN", - "OAUTH_CLIENT_CREDENTIALS" - ] - }, - "configuration": { - "description": "Configuration properties in JSON.", - "type": "object" - }, - "policy_type": { - "description": "Type of policy.", - "type": "string", - "enum": [ - "NO_POLICY", - "PRINCIPALS", - "PROCESSES" - ] - }, - "policy_principals": { - "description": "Unique ID or name of the User and User Groups.", - "type": "array", - "items": { - "type": "string" - } - }, - "policy_processes": { - "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING and ROW_COUNT_STATS.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "SAGE_INDEXING", - "ROW_COUNT_STATS" - ] - } - }, - "disable": { - "description": "Indicates whether the configuration enable/disable.", - "default": false, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "connection_identifier" - ] + "$ref": "#/components/schemas/UpdateCollectionRequest" } } }, @@ -2402,17 +1779,17 @@ "parameters": [ { "in": "path", - "name": "configuration_identifier", + "name": "collection_identifier", "required": true, "schema": { "type": "string" }, - "description": "Unique ID or name of the configuration." + "description": "Unique GUID of the collection. Note: Collection names cannot be used as\nidentifiers since duplicate names are allowed." } ], "responses": { "204": { - "description": "Connection configuration successfully updated." + "description": "Collection updated successfully. No content returned." }, "400": { "description": "Invalid request.", @@ -2444,6 +1821,16 @@ } } }, + "404": { + "description": "Resource not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "500": { "description": "Unexpected error", "content": { @@ -2457,83 +1844,19 @@ } } }, - "/api/rest/2.0/connection/create": { + "/api/rest/2.0/connection-configurations/search": { "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.\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", + "operationId": "connectionConfigurationSearch", + "description": "\n Version: 10.12.0.cl or later\n\nGets connection configuration objects.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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#### Usage guidelines\n* To get a list of all configurations available in the ThoughtSpot system, send the API request with only the connection name or GUID in the request body.\n* To fetch details of a configuration object, specify the configuration object name or GUID.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connections", - "9.2.0.cl" + "Connection Configurations", + "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Unique name for the connection.", - "type": "string" - }, - "description": { - "description": "Description of the connection.", - "type": "string" - }, - "data_warehouse_type": { - "description": "Type of the data warehouse.", - "type": "string", - "enum": [ - "SNOWFLAKE", - "AMAZON_REDSHIFT", - "GOOGLE_BIGQUERY", - "AZURE_SYNAPSE", - "TERADATA", - "SAP_HANA", - "STARBURST", - "ORACLE_ADW", - "DATABRICKS", - "DENODO", - "DREMIO", - "TRINO", - "PRESTO", - "POSTGRES", - "SQLSERVER", - "MYSQL", - "GENERIC_JDBC", - "AMAZON_RDS_POSTGRESQL", - "AMAZON_AURORA_POSTGRESQL", - "AMAZON_RDS_MYSQL", - "AMAZON_AURORA_MYSQL", - "LOOKER", - "AMAZON_ATHENA", - "SINGLESTORE", - "GCP_SQLSERVER", - "GCP_ALLOYDB_POSTGRESQL", - "GCP_POSTGRESQL", - "GCP_MYSQL", - "MODE", - "GOOGLE_SHEETS", - "FALCON", - "FALCON_ONPREM", - "CLICKHOUSE" - ] - }, - "data_warehouse_config": { - "description": "Connection configuration attributes in JSON format. To create a connection with tables, include table attributes. See the documentation above for sample JSON.", - "type": "object" - }, - "validate": { - "description": "Validates the connection metadata if tables are included. If you are creating a connection without tables, specify `false`.", - "default": true, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "name", - "data_warehouse_type", - "data_warehouse_config" - ] + "$ref": "#/components/schemas/ConnectionConfigurationSearchRequest" } } }, @@ -2542,11 +1865,14 @@ "parameters": [], "responses": { "200": { - "description": "Connection to the datasource successfully created.", + "description": "Configuration fetched successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateConnectionResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionConfigurationResponse" + } } } } @@ -2594,29 +1920,19 @@ } } }, - "/api/rest/2.0/connection/delete": { + "/api/rest/2.0/connection-configurations/create": { "post": { - "operationId": "deleteConnection", - "description": "\n Version: 9.2.0.cl or later\n\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Delete Connection V2](#/http/api-endpoints/connections/delete-connection-v2) endpoint to delete your connection objects. \n\n#### Usage guidelines\n\nDeletes 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\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\n\n\n#### Endpoint URL\n", - "deprecated": true, + "operationId": "createConnectionConfiguration", + "description": "\n Version: 10.12.0.cl or later\n\nCreates an additional configuration to an existing connection to a data warehouse. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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#### Usage guidelines\n\n * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes:\n ```\n {\n \"user\":\"DEV_USER\",\n \"password\":\"TestConn123\",\n \"role\":\"DEV\",\n \"warehouse\":\"DEV_WH\"\n }\n ```\n\n* If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field.\n* If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field.\n* If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields.\n\n#### Parameterized Connection Support\nFor parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized.\n\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connections", - "9.2.0.cl" + "Connection Configurations", + "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - } - }, - "required": [ - "connection_identifier" - ] + "$ref": "#/components/schemas/CreateConnectionConfigurationRequest" } } }, @@ -2624,8 +1940,15 @@ }, "parameters": [], "responses": { - "204": { - "description": "Connection successfully deleted." + "200": { + "description": "Connection configuration successfully created.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionConfigurationResponse" + } + } + } }, "400": { "description": "Invalid request.", @@ -2670,28 +1993,28 @@ } } }, - "/api/rest/2.0/connections/{connection_identifier}/delete": { + "/api/rest/2.0/connection-configurations/delete": { "post": { - "operationId": "deleteConnectionV2", - "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", + "operationId": "deleteConnectionConfiguration", + "description": "\n Version: 10.12.0.cl or later\n\nDeletes connection configuration objects.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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.4.0.cl" - ], - "parameters": [ - { - "in": "path", - "name": "connection_identifier", - "required": true, - "schema": { - "type": "string" - }, - "description": "Unique ID or name of the connection." - } + "Connection Configurations", + "10.12.0.cl" ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteConnectionConfigurationRequest" + } + } + }, + "required": true + }, + "parameters": [], "responses": { "204": { - "description": "Connection successfully deleted." + "description": "Connection Configurations successfully deleted." }, "400": { "description": "Invalid request.", @@ -2736,31 +2059,38 @@ } } }, - "/api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}": { + "/api/rest/2.0/connection-configurations/{configuration_identifier}/update": { "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.\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", + "operationId": "updateConnectionConfiguration", + "description": "\n Version: 10.12.0.cl or later\n\nUpdates a connection configuration object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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#### Supported operations\nThis API endpoint lets you perform the following operations in a single API request:\n\n * Edit the name or description of the configuration\n * Edit the configuration properties\n * Edit the `policy_type`\n * Edit the type of authentication\n * Enable or disable a configuration\n\n#### Parameterized Connection Support\nFor parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized.\n\n **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Connections", - "9.9.0.cl" + "Connection Configurations", + "10.12.0.cl" ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateConnectionConfigurationRequest" + } + } + }, + "required": true + }, "parameters": [ { "in": "path", - "name": "connection_identifier", + "name": "configuration_identifier", "required": true, "schema": { "type": "string" }, - "description": "GUID of the connection" + "description": "Unique ID or name of the configuration." } ], "responses": { - "200": { - "description": "Export metadata changes.", - "content": { - "application/octet-stream": {} - } + "204": { + "description": "Connection configuration successfully updated." }, "400": { "description": "Invalid request.", @@ -2805,32 +2135,32 @@ } } }, - "/api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}": { + "/api/rest/2.0/connection/create": { "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.\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", + "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.\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 \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"externalDatabases\":[\n\n ]\n }\n ```\n2. Set `validate` to `false`.\n\n**NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n#### Create a connection with tables\n\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**) and `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\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 \"authenticationType\": \"SERVICE_ACCOUNT\",\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**NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", - "9.9.0.cl" - ], - "parameters": [ - { - "in": "path", - "name": "connection_identifier", - "required": true, - "schema": { - "type": "string" - }, - "description": "GUID of the connection" - } + "9.2.0.cl" ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionRequest" + } + } + }, + "required": true + }, + "parameters": [], "responses": { "200": { - "description": "true/false", + "description": "Connection to the datasource successfully created.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FetchConnectionDiffStatusResponse" + "$ref": "#/components/schemas/CreateConnectionResponse" } } } @@ -2878,68 +2208,29 @@ } } }, - "/api/rest/2.0/connections/{connection_identifier}/revoke-refresh-tokens": { + "/api/rest/2.0/connection/delete": { "post": { - "operationId": "revokeRefreshTokens", - "description": "\n Version: 26.2.0.cl or later\n\nRevokes OAuth refresh tokens for users who no longer require access to a data warehouse connection.\nWhen a token is revoked, the affected user's session for that connection is terminated, and they must re-authenticate to regain access.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users.\n\n#### Usage guidelines\n\nYou can specify different combinations of identifiers to control which refresh tokens are revoked.\n\n- **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author.\n- **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked.\n- **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for all users on the specified configurations, except the configuration author.\n- **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations.\n- **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections.\n- **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections.\n\n**NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request.\n\n\n\n\n#### Endpoint URL\n", + "operationId": "deleteConnection", + "description": "\n Version: 9.2.0.cl or later\n\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Delete Connection V2](#/http/api-endpoints/connections/delete-connection-v2) endpoint to delete your connection objects. \n\n#### Usage guidelines\n\nDeletes 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\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\n\n\n#### Endpoint URL\n", + "deprecated": true, "tags": [ "Connections", - "26.2.0.cl" + "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "configuration_identifiers": { - "description": "Unique ID or name of the configuration. When provided, the refresh tokens of the users associated with the connection configuration will be revoked.", - "type": "array", - "items": { - "type": "string" - } - }, - "user_identifiers": { - "description": "Unique ID or name of the users. When provided, the refresh tokens of the specified users will be revoked. If the request includes the user ID or name of the connection author, their token will also be revoked.", - "type": "array", - "items": { - "type": "string" - } - }, - "org_identifiers": { - "description": "Unique ID or name of the Org. When provided, the refresh tokens of all users associated with the published connection in the Org will be revoked. This parameter is valid only for published connections. Using it with unpublished connections will result in an error.", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/DeleteConnectionRequest" } } }, "required": true }, - "parameters": [ - { - "in": "path", - "name": "connection_identifier", - "required": true, - "schema": { - "type": "string" - }, - "description": "Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author." - } - ], + "parameters": [], "responses": { - "200": { - "description": "Token(s) successfully revoked.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RevokeRefreshTokensResponse" - } - } - } + "204": { + "description": "Connection successfully deleted." }, "400": { "description": "Invalid request.", @@ -2971,26 +2262,6 @@ } } }, - "404": { - "description": "Object not found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "500": { "description": "Unexpected error", "content": { @@ -3004,159 +2275,28 @@ } } }, - "/api/rest/2.0/connection/search": { + "/api/rest/2.0/connections/{connection_identifier}/delete": { "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.\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 - `KEY_PAIR`: For connections that require Key Pair account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n - `OAUTH_WITH_PKCE`: For connections that require OAuth with PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake, Starburst, Databricks, Denodo connections only.\n - `EXTOAUTH_WITH_PKCE`: For connections that require External OAuth With PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n - `OAUTH_WITH_PEZ`: For connections that require OAuth With PEZ account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Amazon Redshift connections only.\n - `OAUTH_WITH_SERVICE_PRINCIPAL`: For connections that require OAuth With Service Principal account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n - `PERSONAL_ACCESS_TOKEN`: For connections that require Personal Access Token account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n - `OAUTH_CLIENT_CREDENTIALS`: For connections that require OAuth Client Credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\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", + "operationId": "deleteConnectionV2", + "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", - "9.2.0.cl" + "10.4.0.cl" + ], + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection." + } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "connections": { - "description": "List of connections and name pattern", - "type": "array", - "items": { - "$ref": "#/components/schemas/ConnectionInput" - } - }, - "data_warehouse_types": { - "description": "Array of types of data warehouse defined for the connection.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "SNOWFLAKE", - "AMAZON_REDSHIFT", - "GOOGLE_BIGQUERY", - "AZURE_SYNAPSE", - "TERADATA", - "SAP_HANA", - "STARBURST", - "ORACLE_ADW", - "DATABRICKS", - "DENODO", - "DREMIO", - "TRINO", - "PRESTO", - "POSTGRES", - "SQLSERVER", - "MYSQL", - "GENERIC_JDBC", - "AMAZON_RDS_POSTGRESQL", - "AMAZON_AURORA_POSTGRESQL", - "AMAZON_RDS_MYSQL", - "AMAZON_AURORA_MYSQL", - "LOOKER", - "AMAZON_ATHENA", - "SINGLESTORE", - "GCP_SQLSERVER", - "GCP_ALLOYDB_POSTGRESQL", - "GCP_POSTGRESQL", - "GCP_MYSQL", - "MODE", - "GOOGLE_SHEETS", - "FALCON", - "FALCON_ONPREM", - "CLICKHOUSE" - ] - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "tag_identifiers": { - "description": "Unique ID or name of tags.", - "type": "array", - "items": { - "type": "string" - } - }, - "data_warehouse_object_type": { - "description": "Data warehouse object type.", - "type": "string", - "enum": [ - "DATABASE", - "SCHEMA", - "TABLE", - "COLUMN" - ] - }, - "sort_options": { - "description": "Sort options.", - "allOf": [ - { - "$ref": "#/components/schemas/SortOptionInput" - } - ] - }, - "include_details": { - "description": "Indicates whether to include complete details of the connection objects.", - "type": "boolean", - "nullable": true - }, - "configuration": { - "description": "Configuration values. If empty we are fetching configuration from datasource based on given connection id. If required you can provide config details to fetch specific details. Example input: {}, {\"warehouse\":\"SMALL_WH\",\"database\":\"DEVELOPMENT\"}. This is only applicable when data_warehouse_object_type is selected.", - "type": "object" - }, - "authentication_type": { - "description": "List of authentication types to fetch data_ware_house_objects from external Data warehouse. This is only applicable when data_warehouse_object_type is selected.", - "default": "SERVICE_ACCOUNT", - "type": "string", - "enum": [ - "SERVICE_ACCOUNT", - "OAUTH", - "IAM", - "EXTOAUTH", - "OAUTH_WITH_SERVICE_PRINCIPAL", - "PERSONAL_ACCESS_TOKEN", - "KEY_PAIR", - "OAUTH_WITH_PKCE", - "EXTOAUTH_WITH_PKCE", - "OAUTH_WITH_PEZ", - "OAUTH_CLIENT_CREDENTIALS" - ] - }, - "show_resolved_parameters": { - "description": "
Version: 10.9.0.cl or later
\n\nIndicates whether to show resolved parameterised values.", - "default": false, - "type": "boolean", - "nullable": true - } - } - } - } - }, - "required": true - }, - "parameters": [], "responses": { - "200": { - "description": "List of connections to the datasource.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchConnectionResponse" - } - } - } - } + "204": { + "description": "Connection successfully deleted." }, "400": { "description": "Invalid request.", @@ -3201,56 +2341,31 @@ } } }, - "/api/rest/2.0/connection/update": { + "/api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}": { "post": { - "operationId": "updateConnection", - "description": "\n Version: 9.2.0.cl or later\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Update connection V2](#/http/api-endpoints/connections/update-connection-v2) endpoint to update your connection objects.\n\n#### Usage guidelines\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, + "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.\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.2.0.cl" + "9.9.0.cl" + ], + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "GUID of the connection" + } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - }, - "name": { - "description": "Updated name of the connection.", - "type": "string" - }, - "description": { - "description": "Updated description of the connection.", - "type": "string" - }, - "data_warehouse_config": { - "description": "Configuration of the data warehouse in JSON.", - "type": "object" - }, - "validate": { - "description": "Indicates whether to validate the connection details.", - "default": true, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "connection_identifier" - ] - } - } - }, - "required": true - }, - "parameters": [], "responses": { - "204": { - "description": "Connection successfully updated." + "200": { + "description": "Export metadata changes.", + "content": { + "application/octet-stream": {} + } }, "400": { "description": "Invalid request.", @@ -3295,44 +2410,14 @@ } } }, - "/api/rest/2.0/connections/{connection_identifier}/update": { + "/api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}": { "post": { - "operationId": "updateConnectionV2", - "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`.\n \n **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n * This is an example of updating a single table in a empty connection:\n \n ```\n {\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"externalDatabases\": [\n {\n \"name\": \"DEVELOPMENT\",\n \"isAutoCreated\": false,\n \"schemas\": [\n {\n \"name\": \"TS_dataset\",\n \"tables\": [\n {\n \"name\": \"DEMORENAME\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [\n {\n \"name\": \"Col1\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col2\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col3\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col312\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col4\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n }\n ],\n \"relationships\": []\n }\n ]\n }\n ]\n }\n ],\n \"configuration\": {\n \"password\": \"\",\n \"database\": \"DEVELOPMENT\",\n \"role\": \"DEV\",\n \"accountName\": \"thoughtspot_partner\",\n \"warehouse\": \"DEMO_WH\",\n \"user\": \"DEV_USER\"\n }\n }\n ```\n \n* This is an example of updating a single table in an existing connection with tables:\n \n ```\n {\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"externalDatabases\": [\n {\n \"name\": \"DEVELOPMENT\",\n \"isAutoCreated\": false,\n \"schemas\": [\n {\n \"name\": \"TS_dataset\",\n \"tables\": [\n {\n \"name\": \"CUSTOMER\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [],\n \"relationships\": []\n },\n {\n \"name\": \"tpch5k_falcon_default_schema_users\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [\n {\n \"name\": \"user_id\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"product_id\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"user_cost\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n }\n ],\n \"relationships\": []\n }\n ]\n }\n ]\n }\n ],\n \"configuration\": {\n \"password\": \"\",\n \"database\": \"DEVELOPMENT\",\n \"role\": \"DEV\",\n \"accountName\": \"thoughtspot_partner\",\n \"warehouse\": \"DEMO_WH\",\n \"user\": \"DEV_USER\"\n }\n }\n ```\n\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\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 ```\n\n\n\n\n#### Endpoint URL\n", + "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.\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", - "10.4.0.cl" + "9.9.0.cl" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Updated name of the connection.", - "type": "string" - }, - "description": { - "description": "Updated description of the connection.", - "type": "string" - }, - "data_warehouse_config": { - "description": "Configuration of the data warehouse in JSON.", - "type": "object" - }, - "validate": { - "description": "Indicates whether to validate the connection details.", - "default": true, - "type": "boolean", - "nullable": true - } - } - } - } - }, - "required": true - }, "parameters": [ { "in": "path", @@ -3341,12 +2426,19 @@ "schema": { "type": "string" }, - "description": "Unique ID or name of the connection." + "description": "GUID of the connection" } ], "responses": { - "204": { - "description": "Connection successfully updated." + "200": { + "description": "true/false", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FetchConnectionDiffStatusResponse" + } + } + } }, "400": { "description": "Invalid request.", @@ -3391,90 +2483,42 @@ } } }, - "/api/rest/2.0/customization/custom-actions": { + "/api/rest/2.0/connections/{connection_identifier}/revoke-refresh-tokens": { "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.\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", + "operationId": "revokeRefreshTokens", + "description": "\n Version: 26.2.0.cl or later\n\nRevokes OAuth refresh tokens for users who no longer require access to a data warehouse connection.\nWhen a token is revoked, the affected user's session for that connection is terminated, and they must re-authenticate to regain access.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users.\n\n#### Usage guidelines\n\nYou can specify different combinations of identifiers to control which refresh tokens are revoked.\n\n- **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author.\n- **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked.\n- **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for all users on the specified configurations, except the configuration author.\n- **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations.\n- **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections.\n- **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections.\n\n**NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Custom Action", - "9.6.0.cl" + "Connections", + "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the custom action. The custom action name must be unique.", - "type": "string" - }, - "action_details": { - "description": "Action details includes `Type` and Configuration data for Custom Actions, either Callback or URL is required.", - "allOf": [ - { - "$ref": "#/components/schemas/Action_Details_Input_Create" - } - ] - }, - "associate_metadata": { - "description": "Metadata objects to which the custom action needs to be associated.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Associate_Metadata_Input_Create" - } - }, - "default_action_config": { - "description": "Default Custom action configuration. This includes if the custom action is available on all visualizations. By default, a custom action is added to all visualizations and Answers.", - "allOf": [ - { - "$ref": "#/components/schemas/Default_Action_Config_Input_Create" - } - ] - }, - "group_identifiers": { - "description": "Unique ID or name of the groups that can view and access the custom action.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "name", - "action_details" - ] + "$ref": "#/components/schemas/RevokeRefreshTokensRequest" } } }, "required": true }, - "parameters": [], + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author." + } + ], "responses": { "200": { - "description": "Custom action created successfully.", + "description": "Token(s) successfully revoked.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResponseCustomAction" - }, - "examples": { - "example_1": { - "value": { - "action_details": { - "CALLBACK": { - "reference": "customaction" - } - }, - "default_action_config": { - "visibility": true - }, - "id": "3d3cad0f-e57b-4faa-8e24-da596c727ee0", - "metadata_association": [], - "name": "customactionsample", - "user_groups": [] - } - } + "$ref": "#/components/schemas/RevokeRefreshTokensResponse" } } } @@ -3509,6 +2553,26 @@ } } }, + "404": { + "description": "Object not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "500": { "description": "Unexpected error", "content": { @@ -3522,28 +2586,38 @@ } } }, - "/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete": { + "/api/rest/2.0/connection/search": { "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.\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", + "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.\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 - `KEY_PAIR`: For connections that require Key Pair account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n - `OAUTH_WITH_PKCE`: For connections that require OAuth with PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake, Starburst, Databricks, Denodo connections only.\n - `EXTOAUTH_WITH_PKCE`: For connections that require External OAuth With PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n - `OAUTH_WITH_PEZ`: For connections that require OAuth With PEZ account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Amazon Redshift connections only.\n - `OAUTH_WITH_SERVICE_PRINCIPAL`: For connections that require OAuth With Service Principal account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n - `PERSONAL_ACCESS_TOKEN`: For connections that require Personal Access Token account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n - `OAUTH_CLIENT_CREDENTIALS`: For connections that require OAuth Client Credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\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": [ - "Custom Action", - "9.6.0.cl" - ], - "parameters": [ - { - "in": "path", - "name": "custom_action_identifier", - "required": true, - "schema": { - "type": "string" - }, - "description": "Unique ID or name of the custom action." - } + "Connections", + "9.2.0.cl" ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchConnectionRequest" + } + } + }, + "required": true + }, + "parameters": [], "responses": { - "204": { - "description": "Custom action is successfully deleted." + "200": { + "description": "List of connections to the datasource.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchConnectionResponse" + } + } + } + } }, "400": { "description": "Invalid request.", @@ -3588,104 +2662,48 @@ } } }, - "/api/rest/2.0/customization/custom-actions/search": { + "/api/rest/2.0/connections/{connection_identifier}/resync-metadata": { "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.\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", + "operationId": "syncMetadata", + "description": "\n Version: 26.5.0.cl or later\n\nSynchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot.\n\nRequires the `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is also required.\n\n#### Usage guidelines\n\nTo synchronize attributes from a CDW, specify the connection GUID or name in the `connection_identifier` path parameter and `sync_attributes` in the request body. Default attribute is `[\"DESCRIPTION\"]`.\n\n##### Hierarchical schema\n\n* Connection: The connection object for the sync operation.\n* Tables: Tables for the sync operation. When no table is specified, all tables are synchronized.\n* Columns: If the table is specified, you can add the columns for the sync operation. If no columns are specified, all columns in the specified table are considered for the sync operation.\n\nTo set the scope for the sync operation:\n\n* Connection-level: To sync all tables and columns, pass an empty request body, or only the attributes in the request body.\n* Table-level: To synchronize specific tables and their columns, specify the table identifiers in the `tables` array.\n* Column-level: To synchronize specific columns, specify the table identifier as the key and column identifiers as the value in the `tables` array.\n\n```\n{\n \"tables\": [\n {\"table-guid-1\": [\"column-guid-1\", \"column-guid-2\"]},\n \"table-guid-2\"\n ],\n \"sync_attributes\": [\"DESCRIPTION\"]\n}\n```\n\n##### API response\n\nIf the sync operation is successful, the API returns the following information:\n\n* Status of the sync operation. For example, `SUCCESS`, `PARTIAL_SUCCESS`, or `NO_UPDATE`.\n* Number of tables and columns that were updated.\n* Number of tables and columns with the sync failed status when the overall sync status is `PARTIAL_SUCCESS`.\n* Message text indicating the sync results.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Custom Action", - "9.6.0.cl" + "Connections", + "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "custom_action_identifier": { - "description": "Name or ID of the custom action.", - "type": "string" - }, - "name_pattern": { - "description": "A pattern to match case-insensitive name of the custom-action object.", - "type": "string" - }, - "default_action_config": { - "description": "Default Custom action configuration. This includes if the custom action is available on all visualizations. By default, a custom action is added to all visualizations and Answers.", - "allOf": [ - { - "$ref": "#/components/schemas/Default_Action_Config_Search_Input" - } - ] - }, - "include_group_associations": { - "description": "When set to true, returns the associated groups for a custom action.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_metadata_associations": { - "description": "When set to true, returns the associated metadata for a custom action.", - "default": false, - "type": "boolean", - "nullable": true - }, - "metadata": { - "description": "Search with a given metadata identifier.", - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomActionMetadataTypeInput" - } - }, - "type": { - "description": "Filter the action objects based on type", - "type": "string", - "enum": [ - "CALLBACK", - "URL" - ] - } - } + "$ref": "#/components/schemas/SyncMetadataRequest" } } }, "required": true }, - "parameters": [], + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection." + } + ], "responses": { "200": { - "description": "Custom action search is successful.", + "description": "Metadata synced successfully.", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ResponseCustomAction" - } - }, - "examples": { - "example_1": { - "value": [ - { - "action_details": { - "CALLBACK": { - "reference": "LEDE" - } - }, - "default_action_config": { - "visibility": true - }, - "id": "c59262df-cf9e-4947-96fa-52d494688797", - "name": "LEDE" - } - ] - } + "$ref": "#/components/schemas/SyncMetadataResponse" } } } }, "400": { - "description": "Invalid request.", + "description": "Invalid request parameters or hierarchy.", "content": { "application/json": { "schema": { @@ -3714,6 +2732,16 @@ } } }, + "404": { + "description": "Connection, table, or column not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "500": { "description": "Unexpected error", "content": { @@ -3727,83 +2755,29 @@ } } }, - "/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update": { + "/api/rest/2.0/connection/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.\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", + "operationId": "updateConnection", + "description": "\n Version: 9.2.0.cl or later\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Update connection V2](#/http/api-endpoints/connections/update-connection-v2) endpoint to update your connection objects.\n\n#### Usage guidelines\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": [ - "Custom Action", - "9.6.0.cl" + "Connections", + "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "action_details": { - "description": "Action details includes `Type` and Configuration for Custom Actions, either Callback or URL is required.", - "allOf": [ - { - "$ref": "#/components/schemas/Action_Details_Input" - } - ] - }, - "associate_metadata": { - "description": "Metadata objects to which the custom action needs to be associated.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Associate_Metadata_Input" - } - }, - "default_action_config": { - "description": "Default Custom action configuration. This includes if the custom action available on visualizations and Answers. By default, a custom action is added to all visualizations and Answers.", - "allOf": [ - { - "$ref": "#/components/schemas/Default_Action_Config_Input" - } - ] - }, - "group_identifiers": { - "description": "Unique ID or name of the groups that can view and access the custom action.", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "Name of the custom action. The custom action name must be unique.", - "type": "string" - }, - "operation": { - "description": "Type of update operation. Default operation type is ADD", - "default": "ADD", - "type": "string", - "enum": [ - "ADD", - "REMOVE" - ] - } - } + "$ref": "#/components/schemas/UpdateConnectionRequest" } } }, "required": true }, - "parameters": [ - { - "in": "path", - "name": "custom_action_identifier", - "required": true, - "schema": { - "type": "string" - }, - "description": "Unique ID or name of the custom action." - } - ], + "parameters": [], "responses": { "204": { - "description": "Custom action updated successfully." + "description": "Connection successfully updated." }, "400": { "description": "Invalid request.", @@ -3848,108 +2822,95 @@ } } }, - "/api/rest/2.0/calendars/create": { + "/api/rest/2.0/connections/{connection_identifier}/update": { "post": { - "operationId": "createCalendar", - "description": "\n Version: 10.12.0.cl or later\n\nCreates a new [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n\n#### Usage guidelines\n\nYou can create a custom calendar from scratch or an existing Table in ThoughtSpot. For both methods of calendar creation, the following parameters are required:\n\n* Name of the custom calendar.\n* Calendar creation method. To create a calendar from an existing table, specify the method:\n\n - `FROM_EXISTING_TABLE` - Creates calendar from the table reference provided in the API request.\n - `FROM_INPUT_PARAMS` - Creates a calendar from the parameters defined in the API request.\n\n* Connection ID and Table name\n* Database and schema name attributes:\n For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. \n However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not.\n Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional.\n\n**NOTE**: If you are creating a calendar from an existing table, ensure that the referenced table matches the required DDL for custom calendars. If the schema does not match, the API returns an error.\n\n##### Calendar type\nThe API allows you to create the following types of calendars:\n\n* `MONTH_OFFSET`. The default calendar type. A `MONTH_OFFSET` calendar is offset by a few months from the standard calendar months (January to December) and the year begins with the month defined in the request. For example, if the `month_offset` value is set as `April`, the calendar year begins in April.\n\n* `4-4-5`. Each quarter in the calendar will include two 4-week months followed by one 5-week month.\n* `4-5-4`. Each quarter in the calendar will include two 4-week months with a 5-week month between.\n* `5-4-4`. Each quarter begins with a 5-week month, followed by two 4-week months.\n\nTo start and end the calendar on a specific date, specify the dates in the `MM/DD/YYYY` format. For `MONTH_OFFSET` calendars, ensure that the `start_date` matches the month specified in the `month_offset` attribute.\n\nYou can also set the starting day of the week and customize the prefixes for year and quarter labels.\n\n#### Examples\n\nTo create a calendar from an existing table:\n\n```\n{\n \"name\": \"MyCustomCalendar1\",\n \"table_reference\": {\n \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\",\n \"table_name\": \"MyCalendarTable\",\n \"database_name\": \"RETAILAPPAREL\",\n \"schema_name\": \"PUBLIC\"\n },\n \"creation_method\": \"FROM_EXISTING_TABLE\",\n}\n```\n\nTo create a calendar from scratch:\n\n```\n{\n \"name\": \"MyCustomCalendar1\",\n \"table_reference\": {\n \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\",\n \"table_name\": \"MyCalendarTable\",\n \"database_name\": \"RETAILAPPAREL\",\n \"schema_name\": \"PUBLIC\"\n },\n \"creation_method\": \"FROM_INPUT_PARAMS\",\n \"calendar_type\": \"MONTH_OFFSET\",\n \"month_offset\": \"April\",\n \"start_day_of_week\": \"Monday\",\n \"quarter_name_prefix\": \"Q\",\n \"year_name_prefix\": \"FY\",\n \"start_date\": \"04/01/2025\",\n \"end_date\": \"04/31/2025\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", + "operationId": "updateConnectionV2", + "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`.\n \n **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n * This is an example of updating a single table in a empty connection:\n \n ```\n {\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"externalDatabases\": [\n {\n \"name\": \"DEVELOPMENT\",\n \"isAutoCreated\": false,\n \"schemas\": [\n {\n \"name\": \"TS_dataset\",\n \"tables\": [\n {\n \"name\": \"DEMORENAME\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [\n {\n \"name\": \"Col1\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col2\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col3\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col312\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col4\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n }\n ],\n \"relationships\": []\n }\n ]\n }\n ]\n }\n ],\n \"configuration\": {\n \"password\": \"\",\n \"database\": \"DEVELOPMENT\",\n \"role\": \"DEV\",\n \"accountName\": \"thoughtspot_partner\",\n \"warehouse\": \"DEMO_WH\",\n \"user\": \"DEV_USER\"\n }\n }\n ```\n \n* This is an example of updating a single table in an existing connection with tables:\n \n ```\n {\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"externalDatabases\": [\n {\n \"name\": \"DEVELOPMENT\",\n \"isAutoCreated\": false,\n \"schemas\": [\n {\n \"name\": \"TS_dataset\",\n \"tables\": [\n {\n \"name\": \"CUSTOMER\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [],\n \"relationships\": []\n },\n {\n \"name\": \"tpch5k_falcon_default_schema_users\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [\n {\n \"name\": \"user_id\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"product_id\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"user_cost\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n }\n ],\n \"relationships\": []\n }\n ]\n }\n ]\n }\n ],\n \"configuration\": {\n \"password\": \"\",\n \"database\": \"DEVELOPMENT\",\n \"role\": \"DEV\",\n \"accountName\": \"thoughtspot_partner\",\n \"warehouse\": \"DEMO_WH\",\n \"user\": \"DEV_USER\"\n }\n }\n ```\n\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\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 ```\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Custom Calendars", - "10.12.0.cl" + "Connections", + "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the custom calendar.", - "type": "string" - }, - "creation_method": { - "description": "Type of create operation.", - "type": "string", - "enum": [ - "FROM_INPUT_PARAMS", - "FROM_EXISTING_TABLE" - ] - }, - "table_reference": { - "description": "Table reference containing connection identifier and table details in this format: `{\"connection_identifier\":\"conn1\", \"database_name\":\"db1\", \"schema_name\":\"sc1\", \"table_name\":\"tb1\"}`. The given table will be created if `creation_method` is set as `FROM_INPUT_PARAMS`.", - "allOf": [ - { - "$ref": "#/components/schemas/ExternalTableInput" - } - ] - }, - "start_date": { - "description": "Start date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `creation_method` is set as `FROM_INPUT_PARAMS`.", - "type": "string" - }, - "end_date": { - "description": "End date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `creation_method` is set as `FROM_INPUT_PARAMS`.", - "type": "string" - }, - "calendar_type": { - "description": "Type of the calendar.", - "default": "MONTH_OFFSET", - "type": "string", - "enum": [ - "MONTH_OFFSET", - "FOUR_FOUR_FIVE", - "FOUR_FIVE_FOUR", - "FIVE_FOUR_FOUR" - ] - }, - "month_offset": { - "description": "Specify the month in which the fiscal or custom calendar year should start. For example, if you set `month_offset` to \"April\", the custom calendar will treat \"April\" as the first month of the year, and the related attributes such as quarters and start date will be based on this offset. The default value is `January`, which represents the standard calendar year (January to December).", - "default": "January", - "type": "string", - "enum": [ - "January", - "February", - "March", - "April", - "May", - "June", - "July", - "August", - "September", - "October", - "November", - "December" - ] - }, - "start_day_of_week": { - "description": "Specify the starting day of the week.", - "default": "Sunday", - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ] - }, - "quarter_name_prefix": { - "description": "Prefix to add before the quarter.", - "default": "", - "type": "string" - }, - "year_name_prefix": { - "description": "Prefix to add before the year.", - "default": "", - "type": "string" - } - }, - "required": [ - "name", - "creation_method", - "table_reference" - ] + "$ref": "#/components/schemas/UpdateConnectionV2Request" + } + } + }, + "required": true + }, + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection." + } + ], + "responses": { + "204": { + "description": "Connection successfully updated." + }, + "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/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.\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" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomActionRequest" } } }, @@ -3958,11 +2919,29 @@ "parameters": [], "responses": { "200": { - "description": "Custom calendar created successfully.", + "description": "Custom action created successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalendarResponse" + "$ref": "#/components/schemas/ResponseCustomAction" + }, + "examples": { + "example_1": { + "value": { + "action_details": { + "CALLBACK": { + "reference": "customaction" + } + }, + "default_action_config": { + "visibility": true + }, + "id": "3d3cad0f-e57b-4faa-8e24-da596c727ee0", + "metadata_association": [], + "name": "customactionsample", + "user_groups": [] + } + } } } } @@ -4010,28 +2989,28 @@ } } }, - "/api/rest/2.0/calendars/{calendar_identifier}/delete": { + "/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete": { "post": { - "operationId": "deleteCalendar", - "description": "\n Version: 10.12.0.cl or later\n\nDeletes a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\nTo delete a custom calendar, specify the calendar ID as a path parameter in the request URL. \n\n\n\n\n#### Endpoint URL\n", + "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.\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 Calendars", - "10.12.0.cl" + "Custom Action", + "9.6.0.cl" ], "parameters": [ { "in": "path", - "name": "calendar_identifier", + "name": "custom_action_identifier", "required": true, "schema": { "type": "string" }, - "description": "Unique ID or name of the Calendar." + "description": "Unique ID or name of the custom action." } ], "responses": { "204": { - "description": "Custom calendar successfully deleted." + "description": "Custom action is successfully deleted." }, "400": { "description": "Invalid request.", @@ -4076,85 +3055,19 @@ } } }, - "/api/rest/2.0/calendars/generate-csv": { + "/api/rest/2.0/customization/custom-actions/search": { "post": { - "operationId": "generateCSV", - "description": "\n Version: 10.12.0.cl or later\n\nExports a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal) in the CSV format.\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nUse this API to download a custom calendar in the CSV file format. In your API request, specify the following parameters.\n\n* Start and end date of the calendar. For \"month offset\" calendars, the start date must match the month defined in the `month_offset` attribute.\n\nYou can also specify optional parameters such as the starting day of the week and prefixes for the quarter and year labels.\n\n\n\n\n#### Endpoint URL\n", + "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.\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 Calendars", - "10.12.0.cl" + "Custom Action", + "9.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "start_date": { - "description": "Start date for the calendar in `MM/dd/yyyy` format.", - "type": "string" - }, - "end_date": { - "description": "End date for the calendar in `MM/dd/yyyy` format.", - "type": "string" - }, - "calendar_type": { - "description": "Type of the calendar.", - "default": "MONTH_OFFSET", - "type": "string", - "enum": [ - "MONTH_OFFSET", - "FOUR_FOUR_FIVE", - "FOUR_FIVE_FOUR", - "FIVE_FOUR_FOUR" - ] - }, - "month_offset": { - "description": "Month offset to start calendar from `January`.", - "default": "January", - "type": "string", - "enum": [ - "January", - "February", - "March", - "April", - "May", - "June", - "July", - "August", - "September", - "October", - "November", - "December" - ] - }, - "start_day_of_week": { - "description": "Specify the starting day of the week.", - "default": "Sunday", - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ] - }, - "quarter_name_prefix": { - "description": "Prefix to add before the quarter.", - "type": "string" - }, - "year_name_prefix": { - "description": "Prefix to add before the year.", - "type": "string" - } - }, - "required": [ - "start_date", - "end_date" - ] + "$ref": "#/components/schemas/SearchCustomActionsRequest" } } }, @@ -4163,11 +3076,32 @@ "parameters": [], "responses": { "200": { - "description": "Generate custom calendar data based on specifications, as a CSV file.", + "description": "Custom action search is successful.", "content": { "application/json": { "schema": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/ResponseCustomAction" + } + }, + "examples": { + "example_1": { + "value": [ + { + "action_details": { + "CALLBACK": { + "reference": "LEDE" + } + }, + "default_action_config": { + "visibility": true + }, + "id": "c59262df-cf9e-4947-96fa-52d494688797", + "name": "LEDE" + } + ] + } } } } @@ -4215,68 +3149,38 @@ } } }, - "/api/rest/2.0/calendars/search": { + "/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update": { "post": { - "operationId": "searchCalendars", - "description": "\n Version: 10.12.0.cl or later\n\nGets a list of [custom calendars](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nBy default, the API returns a list of custom calendars for all connection objects. To retrieve custom calendar details for a particular connection, specify the connection ID. You can also use other search parameters such as `name_pattern` and `sort_options` as search filters.\n\nThe `name_pattern` parameter filters and returns only those objects that match the specified pattern. Use `%` as a wildcard for pattern matching.\n\n\n\n\n#### Endpoint URL\n", + "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.\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 Calendars", - "10.12.0.cl" + "Custom Action", + "9.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "connection_identifier": { - "description": "Unique ID or name of the connection.", - "type": "string" - }, - "name_pattern": { - "description": "Pattern to match for calendar names (use '%' for wildcard match).", - "type": "string" - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "sort_options": { - "description": "Sort options.", - "allOf": [ - { - "$ref": "#/components/schemas/SortOption" - } - ] - } - } + "$ref": "#/components/schemas/UpdateCustomActionRequest" } } }, "required": true }, - "parameters": [], + "parameters": [ + { + "in": "path", + "name": "custom_action_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the custom action." + } + ], "responses": { - "200": { - "description": "Custom calendar fetched successfully.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CalendarResponse" - } - } - } - } + "204": { + "description": "Custom action updated successfully." }, "400": { "description": "Invalid request.", @@ -4321,10 +3225,10 @@ } } }, - "/api/rest/2.0/calendars/{calendar_identifier}/update": { + "/api/rest/2.0/calendars/create": { "post": { - "operationId": "updateCalendar", - "description": "\n Version: 10.12.0.cl or later\n\nUpdates the properties of a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nYou can update the properties of a calendar using one of the following methods:\n* `FROM_INPUT_PARAMS` to update the calendar properties with the values defined in the API request.\n* `FROM_EXISTING_TABLE` Creates a calendar from the parameters defined in the API request.\n\nTo update a custom calendar, specify the calendar ID as a path parameter in the request URL and the following parameters in the request body: \n\n* Connection ID and Table name\n* Database and schema name attributes:\n For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. \n However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not.\n Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional.\n\nThe API allows you to modify the calendar type, month offset value, start and end date, starting day of the week, and prefixes assigned to the year and quarter labels. \n\n#### Examples\n\nUpdate a custom calendar using an existing Table in ThoughtSpot:\n\n```\n{\n \"update_method\": \"FROM_EXISTING_TABLE\",\n \"table_reference\": {\n \"connection_identifier\": \"Connection1\",\n \"database_name\": \"db1\",\n \"table_name\": \"custom_calendar_2025\",\n \"schame_name\": \"schemaVar\"\n }\n}\n```\n\nUpdate a custom calendar with the attributes defined in the API request:\n\n```\n{\n \"update_method\": \"FROM_INPUT_PARAMS\",\n \"table_reference\": {\n \"connection_identifier\": \"Connection1\",\n \"database_name\": \"db1\",\n \"table_name\": \"custom_calendar_2025\",\n \"schame_name\": \"schemaVar\"\n },\n \"month_offset\": \"August\",\n \"start_day_of_week\": \"Monday\",\n \"start_date\": \"08/01/2025\",\n \"end_date\": \"07/31/2026\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", + "operationId": "createCalendar", + "description": "\n Version: 10.12.0.cl or later\n\nCreates a new [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n\n#### Usage guidelines\n\nYou can create a custom calendar from scratch or an existing Table in ThoughtSpot. For both methods of calendar creation, the following parameters are required:\n\n* Name of the custom calendar.\n* Calendar creation method. To create a calendar from an existing table, specify the method:\n\n - `FROM_EXISTING_TABLE` - Creates calendar from the table reference provided in the API request.\n - `FROM_INPUT_PARAMS` - Creates a calendar from the parameters defined in the API request.\n\n* Connection ID and Table name\n* Database and schema name attributes:\n For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. \n However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not.\n Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional.\n\n**NOTE**: If you are creating a calendar from an existing table, ensure that the referenced table matches the required DDL for custom calendars. If the schema does not match, the API returns an error.\n\n##### Calendar type\nThe API allows you to create the following types of calendars:\n\n* `MONTH_OFFSET`. The default calendar type. A `MONTH_OFFSET` calendar is offset by a few months from the standard calendar months (January to December) and the year begins with the month defined in the request. For example, if the `month_offset` value is set as `April`, the calendar year begins in April.\n\n* `4-4-5`. Each quarter in the calendar will include two 4-week months followed by one 5-week month.\n* `4-5-4`. Each quarter in the calendar will include two 4-week months with a 5-week month between.\n* `5-4-4`. Each quarter begins with a 5-week month, followed by two 4-week months.\n\nTo start and end the calendar on a specific date, specify the dates in the `MM/DD/YYYY` format. For `MONTH_OFFSET` calendars, ensure that the `start_date` matches the month specified in the `month_offset` attribute.\n\nYou can also set the starting day of the week and customize the prefixes for year and quarter labels.\n\n#### Examples\n\nTo create a calendar from an existing table:\n\n```\n{\n \"name\": \"MyCustomCalendar1\",\n \"table_reference\": {\n \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\",\n \"table_name\": \"MyCalendarTable\",\n \"database_name\": \"RETAILAPPAREL\",\n \"schema_name\": \"PUBLIC\"\n },\n \"creation_method\": \"FROM_EXISTING_TABLE\",\n}\n```\n\nTo create a calendar from scratch:\n\n```\n{\n \"name\": \"MyCustomCalendar1\",\n \"table_reference\": {\n \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\",\n \"table_name\": \"MyCalendarTable\",\n \"database_name\": \"RETAILAPPAREL\",\n \"schema_name\": \"PUBLIC\"\n },\n \"creation_method\": \"FROM_INPUT_PARAMS\",\n \"calendar_type\": \"MONTH_OFFSET\",\n \"month_offset\": \"April\",\n \"start_day_of_week\": \"Monday\",\n \"quarter_name_prefix\": \"Q\",\n \"year_name_prefix\": \"FY\",\n \"start_date\": \"04/01/2025\",\n \"end_date\": \"04/31/2025\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Calendars", "10.12.0.cl" @@ -4333,96 +3237,75 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "update_method": { - "description": "Type of update operation.", - "default": "FROM_INPUT_PARAMS", - "type": "string", - "enum": [ - "FROM_INPUT_PARAMS", - "FROM_EXISTING_TABLE" - ] - }, - "table_reference": { - "description": "Table reference containing connection identifier and table details in this format: `{\"connection_identifier\":\"conn1\", \"database_name\":\"db1\", \"schema_name\":\"sc1\", \"table_name\":\"tb1\"}`.", - "allOf": [ - { - "$ref": "#/components/schemas/ExternalTableInput" - } - ] - }, - "start_date": { - "description": "Start date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.", - "type": "string" - }, - "end_date": { - "description": "End date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.", - "type": "string" - }, - "calendar_type": { - "description": "Type of the calendar.", - "default": "MONTH_OFFSET", - "type": "string", - "enum": [ - "MONTH_OFFSET", - "FOUR_FOUR_FIVE", - "FOUR_FIVE_FOUR", - "FIVE_FOUR_FOUR" - ] - }, - "month_offset": { - "description": "Specify the month in which the fiscal or custom calendar year should start. For example, if you set `month_offset` to \"April\", the custom calendar will treat \"April\" as the first month of the year, and the related attributes such as quarters and start date will be based on this offset. The default value is `January`, which represents the standard calendar year (January to December).", - "default": "January", - "type": "string", - "enum": [ - "January", - "February", - "March", - "April", - "May", - "June", - "July", - "August", - "September", - "October", - "November", - "December" - ] - }, - "start_day_of_week": { - "description": "Specify the starting day of the week", - "default": "Sunday", - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ] - }, - "quarter_name_prefix": { - "description": "Prefix to add before the quarter.", - "default": "", - "type": "string" - }, - "year_name_prefix": { - "description": "Prefix to add before the year.", - "default": "", - "type": "string" - } - }, - "required": [ - "table_reference" - ] + "$ref": "#/components/schemas/CreateCalendarRequest" } } }, "required": true }, + "parameters": [], + "responses": { + "200": { + "description": "Custom calendar created successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalendarResponse" + } + } + } + }, + "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/calendars/{calendar_identifier}/delete": { + "post": { + "operationId": "deleteCalendar", + "description": "\n Version: 10.12.0.cl or later\n\nDeletes a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\nTo delete a custom calendar, specify the calendar ID as a path parameter in the request URL. \n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Custom Calendars", + "10.12.0.cl" + ], "parameters": [ { "in": "path", @@ -4431,12 +3314,12 @@ "schema": { "type": "string" }, - "description": "Unique Id or name of the calendar." + "description": "Unique ID or name of the Calendar." } ], "responses": { "204": { - "description": "Custom calendar updated successfully." + "description": "Custom calendar successfully deleted." }, "400": { "description": "Invalid request.", @@ -4481,61 +3364,19 @@ } } }, - "/api/rest/2.0/metadata/answer/data": { + "/api/rest/2.0/calendars/generate-csv": { "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](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_apis).\n\n\n\n#### Endpoint URL\n", + "operationId": "generateCSV", + "description": "\n Version: 10.12.0.cl or later\n\nExports a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal) in the CSV format.\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nUse this API to download a custom calendar in the CSV file format. In your API request, specify the following parameters.\n\n* Start and end date of the calendar. For \"month offset\" calendars, the start date must match the month defined in the `month_offset` attribute.\n\nYou can also specify optional parameters such as the starting day of the week and prefixes for the quarter and year labels.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Data", - "9.0.0.cl" + "Custom Calendars", + "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "description": "GUID or name of the Answer.", - "type": "string" - }, - "data_format": { - "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", - "default": "COMPACT", - "type": "string", - "enum": [ - "FULL", - "COMPACT" - ] - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records to include in a batch.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "runtime_filter": { - "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", - "type": "object" - }, - "runtime_sort": { - "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", - "type": "object" - }, - "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" - } - }, - "required": [ - "metadata_identifier" - ] + "$ref": "#/components/schemas/GenerateCSVRequest" } } }, @@ -4544,11 +3385,11 @@ "parameters": [], "responses": { "200": { - "description": "Fetching data of specified metadata object is successful.", + "description": "Generate custom calendar data based on specifications, as a CSV file.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnswerDataResponse" + "type": "object" } } } @@ -4596,72 +3437,19 @@ } } }, - "/api/rest/2.0/metadata/liveboard/data": { + "/api/rest/2.0/calendars/search": { "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#### Endpoint URL\n", + "operationId": "searchCalendars", + "description": "\n Version: 10.12.0.cl or later\n\nGets a list of [custom calendars](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nBy default, the API returns a list of custom calendars for all connection objects. To retrieve custom calendar details for a particular connection, specify the connection ID. You can also use other search parameters such as `name_pattern` and `sort_options` as search filters.\n\nThe `name_pattern` parameter filters and returns only those objects that match the specified pattern. Use `%` as a wildcard for pattern matching.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Data", - "9.0.0.cl" + "Custom Calendars", + "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "description": "GUID or name of the Liveboard.", - "type": "string" - }, - "visualization_identifiers": { - "description": "GUIDs or names of the visualizations on the Liveboard.", - "type": "array", - "items": { - "type": "string" - } - }, - "transient_content": { - "description": "Transient content of the Liveboard.", - "type": "string" - }, - "data_format": { - "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", - "default": "COMPACT", - "type": "string", - "enum": [ - "FULL", - "COMPACT" - ] - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records to include in a batch.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "runtime_filter": { - "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", - "type": "object" - }, - "runtime_sort": { - "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", - "type": "object" - }, - "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" - } - }, - "required": [ - "metadata_identifier" - ] + "$ref": "#/components/schemas/SearchCalendarsRequest" } } }, @@ -4670,11 +3458,14 @@ "parameters": [], "responses": { "200": { - "description": "Fetching data of specified metadata object is successful.", + "description": "Custom calendar fetched successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LiveboardDataResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/CalendarResponse" + } } } } @@ -4722,82 +3513,38 @@ } } }, - "/api/rest/2.0/searchdata": { + "/api/rest/2.0/calendars/{calendar_identifier}/update": { "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 (Worksheet or View).\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", + "operationId": "updateCalendar", + "description": "\n Version: 10.12.0.cl or later\n\nUpdates the properties of a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\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 ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nYou can update the properties of a calendar using one of the following methods:\n* `FROM_INPUT_PARAMS` to update the calendar properties with the values defined in the API request.\n* `FROM_EXISTING_TABLE` Creates a calendar from the parameters defined in the API request.\n\nTo update a custom calendar, specify the calendar ID as a path parameter in the request URL and the following parameters in the request body: \n\n* Connection ID and Table name\n* Database and schema name attributes:\n For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. \n However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not.\n Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional.\n\nThe API allows you to modify the calendar type, month offset value, start and end date, starting day of the week, and prefixes assigned to the year and quarter labels. \n\n#### Examples\n\nUpdate a custom calendar using an existing Table in ThoughtSpot:\n\n```\n{\n \"update_method\": \"FROM_EXISTING_TABLE\",\n \"table_reference\": {\n \"connection_identifier\": \"Connection1\",\n \"database_name\": \"db1\",\n \"table_name\": \"custom_calendar_2025\",\n \"schame_name\": \"schemaVar\"\n }\n}\n```\n\nUpdate a custom calendar with the attributes defined in the API request:\n\n```\n{\n \"update_method\": \"FROM_INPUT_PARAMS\",\n \"table_reference\": {\n \"connection_identifier\": \"Connection1\",\n \"database_name\": \"db1\",\n \"table_name\": \"custom_calendar_2025\",\n \"schame_name\": \"schemaVar\"\n },\n \"month_offset\": \"August\",\n \"start_day_of_week\": \"Monday\",\n \"start_date\": \"08/01/2025\",\n \"end_date\": \"07/31/2026\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Data", - "9.0.0.cl" + "Custom Calendars", + "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "query_string": { - "description": "Query string with search tokens. For example, [Sales][Region]. See [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api)", - "type": "string" - }, - "logical_table_identifier": { - "description": "GUID of the data source object, such as a Worksheet, View, or Table. You can find the GUID of a data object from the UI or via API. See [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_query) for more details.", - "type": "string" - }, - "data_format": { - "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", - "default": "COMPACT", - "type": "string", - "enum": [ - "FULL", - "COMPACT" - ] - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records to include in a batch.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "runtime_filter": { - "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", - "type": "object" - }, - "runtime_sort": { - "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", - "type": "object" - }, - "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" - } - }, - "required": [ - "query_string", - "logical_table_identifier" - ] + "$ref": "#/components/schemas/UpdateCalendarRequest" } } }, "required": true }, - "parameters": [], + "parameters": [ + { + "in": "path", + "name": "calendar_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique Id or name of the calendar." + } + ], "responses": { - "200": { - "description": "Fetching data of specified metadata object is successful.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchDataResponse" - } - } - } + "204": { + "description": "Custom calendar updated successfully." }, "400": { "description": "Invalid request.", @@ -4842,47 +3589,266 @@ } } }, - "/api/rest/2.0/dbt/dbt-connection": { + "/api/rest/2.0/metadata/answer/data": { "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**) 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", + "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](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": [ - "DBT", - "9.9.0.cl" + "Data", + "9.0.0.cl" ], "requestBody": { "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "connection_name": { - "description": "Name of the connection.", - "type": "string" - }, - "database_name": { - "description": "Name of the Database.", - "type": "string" - }, - "import_type": { - "description": "Mention type of Import", - "default": "DBT_CLOUD", - "type": "string", - "enum": [ - "DBT_CLOUD", - "ZIP_FILE" - ] - }, - "access_token": { - "description": "Access token is mandatory when Import_Type is DBT_CLOUD.", - "type": "string" - }, - "dbt_url": { - "description": "DBT URL is mandatory when Import_Type is DBT_CLOUD.", - "type": "string" - }, - "account_id": { - "description": "Account ID is mandatory when Import_Type is DBT_CLOUD", + "$ref": "#/components/schemas/FetchAnswerDataRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Fetching data of specified metadata object is successful.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnswerDataResponse" + } + } + } + }, + "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/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#### Endpoint URL\n", + "tags": [ + "Data", + "9.0.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FetchLiveboardDataRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Fetching data of specified metadata object is successful.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LiveboardDataResponse" + } + } + } + }, + "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/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 (Worksheet or View).\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" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchDataRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Fetching data of specified metadata object is successful.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchDataResponse" + } + } + } + }, + "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/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**) 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" + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "connection_name": { + "description": "Name of the connection.", + "type": "string" + }, + "database_name": { + "description": "Name of the Database.", + "type": "string" + }, + "import_type": { + "description": "Mention type of Import", + "default": "DBT_CLOUD", + "type": "string", + "enum": [ + "DBT_CLOUD", + "ZIP_FILE" + ] + }, + "access_token": { + "description": "Access token is mandatory when Import_Type is DBT_CLOUD.", + "type": "string" + }, + "dbt_url": { + "description": "DBT URL is mandatory when Import_Type is DBT_CLOUD.", + "type": "string" + }, + "account_id": { + "description": "Account ID is mandatory when Import_Type is DBT_CLOUD", "type": "string" }, "project_id": { @@ -5425,7 +4391,7 @@ "/api/rest/2.0/customization/email": { "post": { "operationId": "createEmailCustomization", - "description": "\nBeta Version: 10.10.0.cl or later\n\nCreates a customization configuration for the notification email.\n\n#### Pre-requisites\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**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo create a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \t\"cta_text_font_color\": \"#FFFFFF\",\n \t\"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \t\"product_name\": \"ThoughtSpot\",\n \t\"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \t\"replacement_value_for_answer\": \"Chart\",\n \t\"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \t\"hide_manage_notification\": false,\n \t\"hide_mobile_app_nudge\": false,\n \t\"hide_privacy_policy\": false,\n \t\"hide_ts_vocabulary_definitions\": false,\n \t\"hide_error_message\": false,\n \t\"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \t\"hide_modify_alert\": false,\n \t\"company_website_url\": \"https://your-website.com/\",\n \t\"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", + "description": "\nBeta Version: 10.10.0.cl or later\n\nCreates a customization configuration for the notification email.\n\n#### Pre-requisites\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**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo create a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \"cta_text_font_color\": \"#FFFFFF\",\n \"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \"product_name\": \"ThoughtSpot\",\n \"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \"replacement_value_for_answer\": \"Chart\",\n \"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \"hide_manage_notification\": false,\n \"hide_mobile_app_nudge\": false,\n \"hide_privacy_policy\": false,\n \"hide_ts_vocabulary_definitions\": false,\n \"hide_error_message\": false,\n \"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \"hide_modify_alert\": false,\n \"company_website_url\": \"https://your-website.com/\",\n \"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false,\n\t \"hide_logo_url\" : false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.10.0.cl" @@ -5434,24 +4400,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "template_properties": { - "description": "Email customization configuration as key value pair", - "allOf": [ - { - "$ref": "#/components/schemas/Template_Properties_Input_Create" - } - ] - }, - "org_identifier": { - "description": "Unique ID or name of org
Version: 10.12.0.cl or later", - "type": "string" - } - }, - "required": [ - "template_properties" - ] + "$ref": "#/components/schemas/CreateEmailCustomizationRequest" } } }, @@ -5571,16 +4520,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "org_identifiers": { - "description": "Unique identifier of the organization.", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/DeleteOrgEmailCustomizationRequest" } } }, @@ -5646,16 +4586,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "org_identifiers": { - "description": "Unique ID or name of org
Version: 10.12.0.cl or later", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/SearchEmailCustomizationRequest" } } }, @@ -5712,7 +4643,7 @@ "/api/rest/2.0/customization/email/update": { "post": { "operationId": "updateEmailCustomization", - "description": "\nBeta Version: 10.12.0.cl or later\n\nUpdates a customization configuration for the notification email.\n\n#### Pre-requisites\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**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo update a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \t\"cta_text_font_color\": \"#FFFFFF\",\n \t\"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \t\"product_name\": \"ThoughtSpot\",\n \t\"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \t\"replacement_value_for_answer\": \"Chart\",\n \t\"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \t\"hide_manage_notification\": false,\n \t\"hide_mobile_app_nudge\": false,\n \t\"hide_privacy_policy\": false,\n \t\"hide_ts_vocabulary_definitions\": false,\n \t\"hide_error_message\": false,\n \t\"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \t\"hide_modify_alert\": false,\n \t\"company_website_url\": \"https://your-website.com/\",\n \t\"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", + "description": "\nBeta Version: 10.12.0.cl or later\n\nUpdates a customization configuration for the notification email.\n\n#### Pre-requisites\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**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo update a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \t\"cta_text_font_color\": \"#FFFFFF\",\n \t\"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \t\"product_name\": \"ThoughtSpot\",\n \t\"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \t\"replacement_value_for_answer\": \"Chart\",\n \t\"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \t\"hide_manage_notification\": false,\n \t\"hide_mobile_app_nudge\": false,\n \t\"hide_privacy_policy\": false,\n \t\"hide_ts_vocabulary_definitions\": false,\n \t\"hide_error_message\": false,\n \t\"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \t\"hide_modify_alert\": false,\n \t\"company_website_url\": \"https://your-website.com/\",\n \t\"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false,\n\t \"hide_logo_url\" : false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.12.0.cl" @@ -5721,24 +4652,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "template_properties": { - "description": "Email customization configuration as key value pair", - "allOf": [ - { - "$ref": "#/components/schemas/Template_Properties_Input_Create" - } - ] - }, - "org_identifier": { - "description": "Unique ID or name of org", - "type": "string" - } - }, - "required": [ - "template_properties" - ] + "$ref": "#/components/schemas/UpdateEmailCustomizationRequest" } } }, @@ -5850,115 +4764,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the group. The group name must be unique.", - "type": "string" - }, - "display_name": { - "description": "Display name for the group.", - "type": "string" - }, - "default_liveboard_identifiers": { - "description": "GUID of the Liveboards to assign as default Liveboards to the users in the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "Description of the group", - "type": "string" - }, - "privileges": { - "description": "Privileges to assign to the group", - "type": "array", - "items": { - "type": "string", - "enum": [ - "ADMINISTRATION", - "AUTHORING", - "USERDATAUPLOADING", - "DATADOWNLOADING", - "USERMANAGEMENT", - "DATAMANAGEMENT", - "SHAREWITHALL", - "JOBSCHEDULING", - "A3ANALYSIS", - "EXPERIMENTALFEATUREPRIVILEGE", - "BYPASSRLS", - "RANALYSIS", - "DEVELOPER", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "SYNCMANAGEMENT", - "CAN_CREATE_CATALOG", - "DISABLE_PINBOARD_CREATION", - "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "ALLOW_NON_EMBED_FULL_APP_ACCESS", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "CAN_MODIFY_FOLDERS", - "CAN_MANAGE_VARIABLES", - "CAN_VIEW_FOLDERS", - "PREVIEW_DOCUMENT_SEARCH", - "CAN_SETUP_VERSION_CONTROL", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - }, - "sub_group_identifiers": { - "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "description": "Group type.", - "default": "LOCAL_GROUP", - "type": "string", - "enum": [ - "LOCAL_GROUP", - "LDAP_GROUP", - "TEAM_GROUP", - "TENANT_GROUP" - ] - }, - "user_identifiers": { - "description": "GUID or name of the users to assign to the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "description": "Visibility of the group. To make a group visible to other users and groups,\nset the visibility to SHAREABLE.", - "default": "SHARABLE", - "type": "string", - "enum": [ - "SHARABLE", - "NON_SHARABLE" - ] - }, - "role_identifiers": { - "description": "Role identifiers of the roles that should be assigned to the group.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "name", - "display_name" - ] + "$ref": "#/components/schemas/CreateUserGroupRequest" } } }, @@ -6097,28 +4903,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "groups": { - "description": "Details of groups which are to be imported", - "type": "array", - "items": { - "$ref": "#/components/schemas/GroupsImportListInput" - } - }, - "delete_unspecified_groups": { - "description": "If set to true, removes groups that are not specified in the API request.", - "default": false, - "type": "boolean", - "nullable": true - }, - "dry_run": { - "description": "If true, the API performs a test operation and returns user IDs whose\ndata will be edited after the import.", - "default": true, - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/ImportUserGroupsRequest" } } }, @@ -6191,162 +4976,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "default_liveboard_identifiers": { - "description": "GUID of Liveboards that are assigned as default Liveboards to the users in the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "Description of the group", - "type": "string" - }, - "display_name": { - "description": "Display name of the group", - "type": "string" - }, - "name_pattern": { - "description": "A pattern to match case-insensitive name of the Group object.", - "type": "string" - }, - "group_identifier": { - "description": "GUID or name of the group", - "type": "string" - }, - "org_identifiers": { - "description": "ID or name of the Org to which the group belongs", - "type": "array", - "items": { - "type": "string" - } - }, - "privileges": { - "description": "Privileges assigned to the group.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "ADMINISTRATION", - "AUTHORING", - "USERDATAUPLOADING", - "DATADOWNLOADING", - "USERMANAGEMENT", - "DATAMANAGEMENT", - "SHAREWITHALL", - "JOBSCHEDULING", - "A3ANALYSIS", - "EXPERIMENTALFEATUREPRIVILEGE", - "BYPASSRLS", - "RANALYSIS", - "DEVELOPER", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "SYNCMANAGEMENT", - "CAN_CREATE_CATALOG", - "DISABLE_PINBOARD_CREATION", - "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE", - "APPLICATION_ADMINISTRATION", - "SYSTEM_INFO_ADMINISTRATION", - "ORG_ADMINISTRATION", - "ROLE_ADMINISTRATION", - "AUTHENTICATION_ADMINISTRATION", - "BILLING_INFO_ADMINISTRATION", - "CAN_MANAGE_CUSTOM_CALENDAR", - "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "ALLOW_NON_EMBED_FULL_APP_ACCESS", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "PREVIEW_DOCUMENT_SEARCH", - "CAN_MODIFY_FOLDERS", - "CAN_MANAGE_VARIABLES", - "CAN_VIEW_FOLDERS", - "CAN_SETUP_VERSION_CONTROL", - "CAN_MANAGE_WEBHOOKS", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - }, - "sub_group_identifiers": { - "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "description": "Group type.", - "type": "string", - "enum": [ - "LOCAL_GROUP", - "LDAP_GROUP", - "TEAM_GROUP", - "TENANT_GROUP" - ] - }, - "user_identifiers": { - "description": "GUID or name of the users assigned to the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "description": "Visibility of the group. To make a group visible to other users and groups,\nset the visibility to SHAREABLE.", - "type": "string", - "enum": [ - "SHARABLE", - "NON_SHARABLE" - ] - }, - "role_identifiers": { - "description": "Filter groups with a list of Roles assigned to a group", - "type": "array", - "items": { - "type": "string" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "sort_options": { - "description": "Sort options to filter group details.", - "allOf": [ - { - "$ref": "#/components/schemas/SortOptions" - } - ] - }, - "include_users": { - "description": "
Version: 10.10.0.cl or later
\n\nDefine Parameter to consider if the users should be included in group search response.", - "default": true, - "type": "boolean", - "nullable": true - }, - "include_sub_groups": { - "description": "
Version: 10.10.0.cl or later
\n\nDefine Parameter to consider if the sub groups should be included in group search response.", - "default": true, - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/SearchUserGroupsRequest" } } }, @@ -6422,119 +5052,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the group to modify.", - "type": "string" - }, - "default_liveboard_identifiers": { - "description": "ID of the Liveboards to be assigned as default Liveboards to the users in the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "Description for the group.", - "type": "string" - }, - "display_name": { - "description": "Display name of the group.", - "type": "string" - }, - "privileges": { - "description": "Privileges to assign to the group.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "ADMINISTRATION", - "AUTHORING", - "USERDATAUPLOADING", - "DATADOWNLOADING", - "USERMANAGEMENT", - "DATAMANAGEMENT", - "SHAREWITHALL", - "JOBSCHEDULING", - "A3ANALYSIS", - "EXPERIMENTALFEATUREPRIVILEGE", - "BYPASSRLS", - "RANALYSIS", - "DEVELOPER", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "SYNCMANAGEMENT", - "CAN_CREATE_CATALOG", - "DISABLE_PINBOARD_CREATION", - "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "ALLOW_NON_EMBED_FULL_APP_ACCESS", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "CAN_MODIFY_FOLDERS", - "CAN_MANAGE_VARIABLES", - "CAN_VIEW_FOLDERS", - "PREVIEW_DOCUMENT_SEARCH", - "CAN_SETUP_VERSION_CONTROL", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - }, - "sub_group_identifiers": { - "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "description": "Type of the group", - "type": "string", - "enum": [ - "LOCAL_GROUP", - "LDAP_GROUP", - "TEAM_GROUP", - "TENANT_GROUP" - ] - }, - "user_identifiers": { - "description": "GUID or name of the users to assign to the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "description": "Visibility of the group. To make a group visible to other users and\ngroups, set the visibility to SHAREABLE.", - "type": "string", - "enum": [ - "SHARABLE", - "NON_SHARABLE" - ] - }, - "role_identifiers": { - "description": "Role identifiers of the Roles that should be assigned to the group.", - "type": "array", - "items": { - "type": "string" - } - }, - "operation": { - "description": "Type of update operation. Default operation type is REPLACE", - "default": "REPLACE", - "type": "string", - "enum": [ - "ADD", - "REMOVE", - "REPLACE" - ] - } - } + "$ref": "#/components/schemas/UpdateUserGroupRequest" } } }, @@ -6598,47 +5116,19 @@ } } }, - "/api/rest/2.0/logs/fetch": { + "/api/rest/2.0/jobs/history/communication-channels/search": { "post": { - "operationId": "fetchLogs", - "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", + "operationId": "searchChannelHistory", + "description": "\n Version: 26.4.0.cl or later\n\nSearches delivery history for communication channels such as webhooks. Returns channel-level delivery status for each job execution record. Use this to monitor channel health and delivery success rates across events.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n**NOTE**: When `channel_type` is `WEBHOOK`, the following constraints apply:\n\n- `job_ids`, `channel_identifiers`, and `events` each accept at most one element.\n- When `job_ids` is provided, it is used as the sole lookup key and other filter fields are ignored.\n- When `job_ids` is not provided, `channel_identifiers` and `events` are both required. Each must contain exactly one element, and the event object must include the `identifier` field.\n- Records older than the configured retention period are not returned.\n\n\n\n\n#### Endpoint URL\n", "tags": [ - "Log", - "9.0.0.cl" + "Jobs", + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "log_type": { - "description": "Name of the log type", - "type": "string", - "enum": [ - "SECURITY_AUDIT" - ] - }, - "start_epoch_time_in_millis": { - "description": "Start time in EPOCH format", - "type": "number", - "format": "float" - }, - "end_epoch_time_in_millis": { - "description": "End time in EPOCH format", - "type": "number", - "format": "float" - }, - "get_all_logs": { - "description": "Fetch all the logs. This is available from 9.10.5.cl", - "default": true, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "log_type" - ] + "$ref": "#/components/schemas/SearchChannelHistoryRequest" } } }, @@ -6647,13 +5137,89 @@ "parameters": [], "responses": { "200": { - "description": "Log fetched successfully.", + "description": "Channel status logs retrieved successfully.", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogResponse" + "$ref": "#/components/schemas/SearchChannelHistoryResponse" + }, + "examples": { + "example_1": { + "description": "Search webhook channel history by channel identifier and event", + "value": { + "jobs": [ + { + "id": "n.6170538a-a4d4-4712-91bf-39b353db2b72", + "status": "SUCCESS", + "creation_time_in_millis": 1771599720674, + "event": { + "type": "LIVEBOARD_SCHEDULE", + "id": "2bb2ff83-b8d9-4d2b-8913-b2589bb6831b", + "name": "schedule-identifier", + "run_id": "90c4f1b0-08c9-4a6c-8e61-49cffd9f1550" + }, + "recipients": [ + { + "type": "USER", + "id": "d211f619-8b72-45d3-92a7-69dde41159c7", + "name": "admin-user", + "email": "admin@example.com" + } + ], + "detail": "", + "try_count": 1 + }, + { + "id": "n.5c5bbedb-c425-48c0-8b54-a17267b08e7c", + "status": "SUCCESS", + "creation_time_in_millis": 1771599600508, + "event": { + "type": "LIVEBOARD_SCHEDULE", + "id": "2bb2ff83-b8d9-4d2b-8913-b2589bb6831b", + "name": "schedule-identifier", + "run_id": "b9834966-fe85-4fa9-8a10-9889c01d4826" + }, + "recipients": [ + { + "type": "USER", + "id": "d211f619-8b72-45d3-92a7-69dde41159c7", + "name": "admin-user", + "email": "admin@example.com" + } + ], + "detail": "", + "try_count": 1 + } + ] + } + }, + "example_2": { + "description": "Search webhook channel history by job ID", + "value": { + "jobs": [ + { + "id": "n.5c5bbedb-c425-48c0-8b54-a17267b08e7c", + "status": "SUCCESS", + "creation_time_in_millis": 1771599600508, + "event": { + "type": "LIVEBOARD_SCHEDULE", + "id": "2bb2ff83-b8d9-4d2b-8913-b2589bb6831b", + "name": "schedule-identifier", + "run_id": "b9834966-fe85-4fa9-8a10-9889c01d4826" + }, + "recipients": [ + { + "type": "USER", + "id": "d211f619-8b72-45d3-92a7-69dde41159c7", + "name": "admin-user", + "email": "admin@example.com" + } + ], + "detail": "", + "try_count": 1 + } + ] + } } } } @@ -6702,47 +5268,19 @@ } } }, - "/api/rest/2.0/metadata/worksheets/convert": { + "/api/rest/2.0/logs/fetch": { "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", + "operationId": "fetchLogs", + "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": [ - "Metadata", - "10.6.0.cl" + "Log", + "9.0.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 - } - } + "$ref": "#/components/schemas/FetchLogsRequest" } } }, @@ -6751,11 +5289,14 @@ "parameters": [], "responses": { "200": { - "description": "Conversion of worksheets to model done successfully.", + "description": "Log fetched successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResponseWorksheetToModelConversion" + "type": "array", + "items": { + "$ref": "#/components/schemas/LogResponse" + } } } } @@ -6803,44 +5344,19 @@ } } }, - "/api/rest/2.0/metadata/copyobject": { + "/api/rest/2.0/metadata/worksheets/convert": { "post": { - "operationId": "copyObject", - "description": "\nMakes a copy of an Answer or Liveboard
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", + "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.3.0.cl" + "10.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "description": { - "description": "Description of the new object", - "type": "string" - }, - "identifier": { - "description": "GUID of metadata object to be copied (answer id or liveboard id)", - "type": "string" - }, - "type": { - "description": "Type of metadata object", - "type": "string", - "enum": [ - "LIVEBOARD", - "ANSWER" - ] - }, - "title": { - "description": "Title of the new object", - "type": "string" - } - }, - "required": [ - "identifier" - ] + "$ref": "#/components/schemas/ConvertWorksheetToModelRequest" } } }, @@ -6849,11 +5365,11 @@ "parameters": [], "responses": { "200": { - "description": "Successfully created a copy of the object", + "description": "Conversion of worksheets to model done successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResponseCopyObject" + "$ref": "#/components/schemas/ResponseWorksheetToModelConversion" } } } @@ -6888,16 +5404,6 @@ } } }, - "404": { - "description": "Object not found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "500": { "description": "Unexpected error", "content": { @@ -6911,37 +5417,102 @@ } } }, - "/api/rest/2.0/metadata/delete": { + "/api/rest/2.0/metadata/copyobject": { "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. \n\n\n\n\n#### Endpoint URL\n", + "operationId": "copyObject", + "description": "\nMakes a copy of an Answer or Liveboard
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", - "9.0.0.cl" + "10.3.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/DeleteMetadataTypeInput" - } - }, - "delete_disabled_objects": { - "description": "Indicates whether to delete disabled metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "metadata" - ] + "$ref": "#/components/schemas/CopyObjectRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Successfully created a copy of the object", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseCopyObject" + } + } + } + }, + "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" + } + } + } + }, + "404": { + "description": "Object not found", + "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/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. \n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Metadata", + "9.0.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteMetadataRequest" } } }, @@ -7007,76 +5578,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ExportMetadataTypeInput" - } - }, - "export_associated": { - "description": "Indicates whether to export associated metadata objects of specified metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - }, - "export_fqn": { - "description": "Adds FQNs of the referenced objects. For example, if you are exporting a Liveboard and its associated objects,\nthe API returns the Liveboard TML data with the FQNs of the referenced worksheet.\nIf the exported TML data includes FQNs, you don't need to manually add FQNs of the referenced objects during TML import.", - "default": false, - "type": "boolean", - "nullable": true - }, - "edoc_format": { - "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": [ - "JSON", - "YAML" - ] - }, - "export_schema_version": { - "description": "Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.", - "default": "DEFAULT", - "type": "string", - "enum": [ - "DEFAULT", - "V1", - "V2" - ] - }, - "export_dependent": { - "description": "Indicates whether to export table while exporting connection.", - "default": false, - "type": "boolean", - "nullable": true - }, - "export_connection_as_dependent": { - "description": "Indicates whether to export connection as dependent while exporting table/worksheet/answer/liveboard.\nThis will only be active when export_associated is true.", - "default": false, - "type": "boolean", - "nullable": true - }, - "all_orgs_override": { - "description": "Indicates whether to export is happening from all orgs context.", - "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": [ - "metadata" - ] + "$ref": "#/components/schemas/ExportMetadataTMLRequest" } } }, @@ -7152,54 +5654,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_type": { - "description": "Type of metadata object to export, can be one of USER | ROLE | USER_GROUP", - "type": "string", - "enum": [ - "USER", - "USER_GROUP", - "ROLE" - ] - }, - "batch_offset": { - "description": "Indicates the position within the complete set from where the API should begin returning objects.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "batch_size": { - "description": "Determines the number of objects or items to be retrieved in a single request.", - "default": 20, - "type": "integer", - "format": "int32" - }, - "edoc_format": { - "description": "TML EDOC content format.", - "default": "JSON", - "type": "string", - "enum": [ - "JSON", - "YAML" - ] - }, - "export_dependent": { - "description": "Indicates whether to export dependent metadata objects of specified metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - }, - "all_orgs_override": { - "description": "Indicates whether to export is happening from all orgs context.", - "default": false, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "metadata_type" - ] + "$ref": "#/components/schemas/ExportMetadataTMLBatchedRequest" } } }, @@ -7272,16 +5727,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "description": "ID or name of an Answer.", - "type": "string" - } - }, - "required": [ - "metadata_identifier" - ] + "$ref": "#/components/schemas/FetchAnswerSqlQueryRequest" } } }, @@ -7354,51 +5800,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "task_ids": { - "description": "List of task IDs to fetch status for.", - "type": "array", - "items": { - "type": "string" - } - }, - "task_status": { - "description": "List of task statuses to filter on. Valid values: [IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED]", - "type": "array", - "items": { - "type": "string", - "enum": [ - "COMPLETED", - "IN_QUEUE", - "IN_PROGRESS", - "FAILED" - ] - } - }, - "author_identifier": { - "description": "Author GUID or name of async import tasks to filter on.", - "type": "string" - }, - "record_offset": { - "description": "The offset point, starting from where the task status should be included in the response.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of task statuses that should be included in the response starting from offset position.", - "default": 5, - "type": "integer", - "format": "int32" - }, - "include_import_response": { - "description": "Boolean flag to specify whether to include import response in the task status objects.", - "default": false, - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/FetchAsyncImportTaskStatusRequest" } } }, @@ -7471,23 +5873,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "description": "ID or name of the Liveboard.", - "type": "string" - }, - "visualization_identifiers": { - "description": "Unique ID or name of visualizations.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "metadata_identifier" - ] + "$ref": "#/components/schemas/FetchLiveboardSqlQueryRequest" } } }, @@ -7560,54 +5946,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_tmls": { - "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" - } - }, - "import_policy": { - "description": "Specifies the import policy for the TML import.", - "default": "PARTIAL", - "type": "string", - "enum": [ - "PARTIAL", - "ALL_OR_NONE", - "VALIDATE_ONLY", - "PARTIAL_OBJECT" - ] - }, - "create_new": { - "description": "If selected, creates TML objects with new GUIDs.", - "default": false, - "type": "boolean", - "nullable": true - }, - "all_orgs_override": { - "description": "If import is happening from all orgs context.", - "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": [ - "metadata_tmls" - ] + "$ref": "#/components/schemas/ImportMetadataTMLRequest" } } }, @@ -7683,54 +6022,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_tmls": { - "description": "Details of TML objects.", - "type": "array", - "items": { - "type": "string" - } - }, - "create_new": { - "description": "If selected, creates TML objects with new GUIDs.", - "default": false, - "type": "boolean", - "nullable": true - }, - "all_orgs_override": { - "description": "If import is happening from all orgs context.", - "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" - ] + "$ref": "#/components/schemas/ImportMetadataTMLAsyncRequest" } } }, @@ -7795,6 +6087,7 @@ "post": { "operationId": "parameterizeMetadata", "description": "\nParameterize fields in metadata objects.
Beta Version: 10.9.0.cl or later\n\nAllows parameterizing fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n\n\n\n#### Endpoint URL\n", + "deprecated": true, "tags": [ "Metadata", "10.9.0.cl" @@ -7803,44 +6096,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_type": { - "description": "Type of metadata object to parameterize.", - "type": "string", - "enum": [ - "LOGICAL_TABLE", - "CONNECTION", - "CONNECTION_CONFIG" - ] - }, - "metadata_identifier": { - "description": "Unique ID or name of the metadata object to parameterize.", - "type": "string" - }, - "field_type": { - "description": "Type of field in the metadata to parameterize.", - "type": "string", - "enum": [ - "ATTRIBUTE", - "CONNECTION_PROPERTY" - ] - }, - "field_name": { - "description": "Name of the field which needs to be parameterized.", - "type": "string" - }, - "variable_identifier": { - "description": "Unique ID or name of the variable to use for parameterization", - "type": "string" - } - }, - "required": [ - "metadata_identifier", - "field_type", - "field_name", - "variable_identifier" - ] + "$ref": "#/components/schemas/ParameterizeMetadataRequest" } } }, @@ -7894,186 +6150,19 @@ } } }, - "/api/rest/2.0/metadata/search": { + "/api/rest/2.0/metadata/parameterize-fields": { "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 filter metadata objects within type `LOGICAL_TABLE`, set the `subtypes` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE` & subtypes as `[WORKSHEET]`.\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- To get discoverable objects when linientmodel is enabled you can use `include_discoverable_objects` as true else false. Default value is true.\n- For liveboard metadata type, to get the newer format, set the `liveboard_response_format` as V2. Default value is V1.\n- To retrieve only objects that are published, set the `include_only_published_objects` as true. Default value is false.\n\n**NOTE**: The following parameters support pagination of metadata records:\n\n- `tag_identifiers`\n- `type`\n- `subtypes`\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`\n- `include_only_published_objects`\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", + "operationId": "parameterizeMetadataFields", + "description": "\nParameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE.
Version: 26.4.0.cl or later\n\nAllows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table, the field type must be `ATTRIBUTE` and field names can include:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_names specifies the exact properties of the Connection or Connection Config that need to be parameterized.\n\nFor Connection Config, supported field names include:\n* impersonate_user\n\nYou can parameterize multiple fields at once by providing an array of field names.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", - "9.0.0.cl" + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects such as Liveboards, Answers, and Worksheets.", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetadataListItemInput" - } - }, - "permissions": { - "description": "Object permission details to search by.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionInput" - } - }, - "created_by_user_identifiers": { - "description": "GUID or name of user who created the metadata object.", - "type": "array", - "items": { - "type": "string" - } - }, - "dependent_object_version": { - "description": "Version of the dependent table of the metadata objects like Worksheets.", - "default": "V1", - "type": "string", - "enum": [ - "V1", - "V2" - ] - }, - "exclude_objects": { - "description": "List of metadata objects to exclude from search.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ExcludeMetadataListItemInput" - } - }, - "favorite_object_options": { - "description": "Options to sort the API response by objects set as favorites\nfor the logged-in user or the users specified in the API request.", - "allOf": [ - { - "$ref": "#/components/schemas/FavoriteObjectOptionsInput" - } - ] - }, - "include_auto_created_objects": { - "description": "Includes system-generated metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_dependent_objects": { - "description": "Includes dependents of the metadata object specified in the API request.\nFor example, a worksheet can consist of dependent objects such as Liveboards or Answers.", - "default": false, - "type": "boolean", - "nullable": true - }, - "dependent_objects_record_size": { - "description": "The maximum number of dependents to include per metadata object.", - "default": 50, - "type": "integer", - "format": "int32" - }, - "include_details": { - "description": "Includes complete details of the metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_headers": { - "description": "Includes headers of the metadata objects.", - "default": true, - "type": "boolean", - "nullable": true - }, - "include_hidden_objects": { - "description": "Includes details of the hidden objects, such as a column in a worksheet or a table.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_incomplete_objects": { - "description": "Includes objects with incomplete metadata.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_visualization_headers": { - "description": "Includes visualization headers of the specified Liveboard object.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_worksheet_search_assist_data": { - "description": "If search assistance lessons are configured on a worksheet,\nthe API returns the search assist data for Worksheet objects.", - "type": "boolean", - "nullable": true - }, - "modified_by_user_identifiers": { - "description": "Includes ID or names of the users who modified the metadata object.", - "type": "array", - "items": { - "type": "string" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included. It is recommended to use a smaller `record_size` when fetching dependent objects or any of the additional metadata detail options.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "sort_options": { - "description": "Sort options to filter metadata details.", - "allOf": [ - { - "$ref": "#/components/schemas/MetadataSearchSortOptions" - } - ] - }, - "tag_identifiers": { - "description": "Tags to filter metadata objects by", - "type": "array", - "items": { - "type": "string" - } - }, - "include_stats": { - "description": "Indicates whether to include stats of the metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_discoverable_objects": { - "description": "
Version: 10.7.0.cl or later
\n\nBoolean to indicate whether to include discoverable metadata objects.", - "default": true, - "type": "boolean", - "nullable": true - }, - "show_resolved_parameters": { - "description": "
Version: 10.9.0.cl or later
\n\nIndicates whether to show resolved parameterised values.", - "default": false, - "type": "boolean", - "nullable": true - }, - "liveboard_response_version": { - "description": "Indicates the model version of Liveboard to be attached in metadata detail.", - "default": "V1", - "type": "string", - "enum": [ - "V1", - "V2" - ] - }, - "include_only_published_objects": { - "description": "
Version: 10.11.0.cl or later
\n\nIf only published objects should be returned", - "default": false, - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/ParameterizeMetadataFieldsRequest" } } }, @@ -8081,7 +6170,73 @@ }, "parameters": [], "responses": { - "200": { + "204": { + "description": "Parameterize 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/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 filter metadata objects within type `LOGICAL_TABLE`, set the `subtypes` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE` & subtypes as `[WORKSHEET]`.\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- To get discoverable objects when linientmodel is enabled you can use `include_discoverable_objects` as true else false. Default value is true.\n- For liveboard metadata type, to get the newer format, set the `liveboard_response_format` as V2. Default value is V1.\n- To retrieve only objects that are published, set the `include_only_published_objects` as true. Default value is false.\n\n**NOTE**: The following parameters support pagination of metadata records:\n\n- `tag_identifiers`\n- `type`\n- `subtypes`\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`\n- `include_only_published_objects`\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" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchMetadataRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { "description": "Metadata objects search result.", "content": { "application/json": { @@ -8149,44 +6304,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_type": { - "description": "Type of metadata object to unparameterize.", - "type": "string", - "enum": [ - "LOGICAL_TABLE", - "CONNECTION", - "CONNECTION_CONFIG" - ] - }, - "metadata_identifier": { - "description": "Unique ID or name of the metadata object to unparameterize.", - "type": "string" - }, - "field_type": { - "description": "Type of field in the metadata to unparameterize.", - "type": "string", - "enum": [ - "ATTRIBUTE", - "CONNECTION_PROPERTY" - ] - }, - "field_name": { - "description": "Name of the field which needs to be unparameterized.", - "type": "string" - }, - "value": { - "description": "The value to use in place of the variable for the field", - "type": "string" - } - }, - "required": [ - "metadata_identifier", - "field_type", - "field_name", - "value" - ] + "$ref": "#/components/schemas/UnparameterizeMetadataRequest" } } }, @@ -8252,23 +6370,7 @@ "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": [ - "headers_update" - ] + "$ref": "#/components/schemas/UpdateMetadataHeaderRequest" } } }, @@ -8334,19 +6436,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "List of metadata objects to update their object IDs.", - "type": "array", - "items": { - "$ref": "#/components/schemas/UpdateObjIdInput" - } - } - }, - "required": [ - "metadata" - ] + "$ref": "#/components/schemas/UpdateMetadataObjIdRequest" } } }, @@ -8412,20 +6502,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the Org.", - "type": "string" - }, - "description": { - "description": "Description of the Org.", - "type": "string" - } - }, - "required": [ - "name" - ] + "$ref": "#/components/schemas/CreateOrgRequest" } } }, @@ -8575,40 +6652,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "org_identifier": { - "description": "ID or name of the Org", - "type": "string" - }, - "description": { - "description": "Description of the Org", - "type": "string" - }, - "visibility": { - "description": "Visibility of the Org", - "type": "string", - "enum": [ - "SHOW", - "HIDDEN" - ] - }, - "status": { - "description": "Status of the Org", - "type": "string", - "enum": [ - "ACTIVE", - "IN_ACTIVE" - ] - }, - "user_identifiers": { - "description": "GUIDs or names of the users for which you want to retrieve the Orgs data", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/SearchOrgsRequest" } } }, @@ -8704,41 +6748,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the Org", - "type": "string" - }, - "description": { - "description": "Description of the Org", - "type": "string" - }, - "user_identifiers": { - "description": "Add Users to an Org", - "type": "array", - "items": { - "type": "string" - } - }, - "group_identifiers": { - "description": "Add Default Groups to an Org", - "type": "array", - "items": { - "type": "string" - } - }, - "operation": { - "description": "Type of update operation. Default operation type is ADD", - "default": "ADD", - "type": "string", - "enum": [ - "ADD", - "REMOVE", - "REPLACE" - ] - } - } + "$ref": "#/components/schemas/UpdateOrgRequest" } } }, @@ -8814,53 +6824,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "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", - "type": "string", - "enum": [ - "CSV", - "PDF", - "XLSX", - "PNG" - ] - }, - "runtime_filter": { - "description": "JSON string representing runtime filter.\n{ col1:region, op1: EQ, val1: northeast }", - "type": "object" - }, - "runtime_sort": { - "description": "JSON string representing runtime sort.\n{ sortCol1: region, asc1 :true, sortCol2 : date }", - "type": "object" - }, - "runtime_param_override": { - "description": "JSON object for setting values of parameters in runtime.", - "type": "object" - }, - "regional_settings": { - "description": "Options for specific region specific overrides to support date/number/string/currency formatting.", - "allOf": [ - { - "$ref": "#/components/schemas/RegionalSettingsInput" - } - ] - } - } + "$ref": "#/components/schemas/ExportAnswerReportRequest" } } }, @@ -8920,7 +6884,7 @@ "/api/rest/2.0/report/liveboard": { "post": { "operationId": "exportLiveboardReport", - "description": "\n Version: 9.0.0.cl or later\n\nExports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format.\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 generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\nThe default `file_format` is CSV. For PDF exports, 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 available for PNG exports. CSV and XLSX exports do not support customization options.\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**NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports.\n\n**NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in CSV format. All visualizations in the Liveboard can be exported as individual CSV files. If multiple visualizations are selected or if the entire Liveboard is exported, the output is returned as a .zip file containing the CSV files for each visualization.\n\n**NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in XLSX format. All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). XLSX exports are limited to 255 worksheets (tabs) per workbook.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nExports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format.\nThe default `file_format` is CSV.\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 generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\n**NOTE**: \n\n* The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n\n* Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\n* To 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* Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports.\n\n* Starting with the ThoughtSpot Cloud 26.2.0.cl release,\n\n * Liveboards can be exported in CSV format. \n * All visualizations within a Liveboard can be exported as individual CSV files. \n * When exporting multiple visualizations or the entire Liveboard, the system returns the report as a compressed ZIP file containing the separate CSV files for each visualization.\n\n * Liveboards can also be exported in XLSX format. \n * All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). \n * XLSX exports are limited to a maximum of 255 worksheets (tabs) per workbook.\n\n\n\n#### Endpoint URL\n", "tags": [ "Reports", "9.0.0.cl" @@ -8929,89 +6893,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "description": "GUID or name of the Liveboard object.", - "type": "string" - }, - "tab_identifiers": { - "description": "GUID or name of the tab of the Liveboard object.
Version: 10.9.0.cl or later", - "type": "array", - "items": { - "type": "string" - } - }, - "personalised_view_identifier": { - "description": "GUID or name of the personalised view of the Liveboard object.
Version: 10.9.0.cl or later", - "type": "string" - }, - "visualization_identifiers": { - "description": "GUID or name of visualizations on the Liveboard. If this parameter is\nnot defined, the API returns a report with all visualizations saved on a Liveboard.", - "type": "array", - "items": { - "type": "string" - } - }, - "transient_content": { - "description": "Transient content of the Liveboard.", - "type": "string" - }, - "file_format": { - "description": "Export file format.", - "default": "PDF", - "type": "string", - "enum": [ - "PDF", - "PNG", - "CSV", - "XLSX" - ] - }, - "runtime_filter": { - "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"region\", \"op1\": \"EQ\", \"val1\": \"northeast\" }. You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", - "type": "object" - }, - "override_filters": { - "description": "Applied to the liveboard and overrides any filters already applied on the same columns in liveboard.\nFollowing example illustrate different kinds of filters:\n{\n \"override_filters\": [\n {\n \"column_name\": \"Color\",\n \"generic_filter\": {\n \"op\": \"IN\",\n \"values\": [\n \"almond\",\n \"turquoise\"\n ]\n },\n \"negate\": false\n },\n {\n \"column_name\": \"Commit Date\",\n \"date_filter\": {\n \"datePeriod\": \"HOUR\",\n \"number\": 3,\n \"type\": \"LAST_N_PERIOD\",\n \"op\": \"EQ\"\n }\n },\n {\n \"column_name\": \"Sales\",\n \"generic_filter\": {\n \"op\": \"BW_INC\",\n \"values\": [\n \"100000\",\n \"70000\"\n ]\n },\n \"negate\": true\n }\n ]\n}", - "type": "object" - }, - "runtime_sort": { - "description": "JSON string representing runtime sort. For example, {\"sortCol1\": \"region\", \"asc1\" : true}. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", - "type": "object" - }, - "pdf_options": { - "description": "Options for PDF export.", - "allOf": [ - { - "$ref": "#/components/schemas/PdfOptionsInput" - } - ] - }, - "png_options": { - "description": "Options for PNG export.", - "allOf": [ - { - "$ref": "#/components/schemas/PngOptionsInput" - } - ] - }, - "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 specific overrides to support date/number/string/currency formatting.", - "allOf": [ - { - "$ref": "#/components/schemas/RegionalSettingsInput" - } - ] - } - }, - "required": [ - "metadata_identifier" - ] + "$ref": "#/components/schemas/ExportLiveboardReportRequest" } } }, @@ -9080,75 +6962,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Unique name of the Role.", - "type": "string" - }, - "description": { - "description": "Description of the Role.", - "type": "string" - }, - "privileges": { - "description": "Privileges granted to the Role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "USERDATAUPLOADING", - "DATADOWNLOADING", - "DATAMANAGEMENT", - "SHAREWITHALL", - "JOBSCHEDULING", - "A3ANALYSIS", - "BYPASSRLS", - "DISABLE_PINBOARD_CREATION", - "DEVELOPER", - "APPLICATION_ADMINISTRATION", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "SYSTEM_INFO_ADMINISTRATION", - "SYNCMANAGEMENT", - "ORG_ADMINISTRATION", - "ROLE_ADMINISTRATION", - "AUTHENTICATION_ADMINISTRATION", - "BILLING_INFO_ADMINISTRATION", - "CONTROL_TRUSTED_AUTH", - "TAGMANAGEMENT", - "LIVEBOARD_VERIFIER", - "CAN_MANAGE_CUSTOM_CALENDAR", - "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "CAN_CREATE_CATALOG", - "ALLOW_NON_EMBED_FULL_APP_ACCESS", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "PREVIEW_DOCUMENT_SEARCH", - "CAN_MANAGE_VARIABLES", - "CAN_MODIFY_FOLDERS", - "CAN_VIEW_FOLDERS", - "CAN_SETUP_VERSION_CONTROL", - "PREVIEW_THOUGHTSPOT_SAGE", - "CAN_MANAGE_WEBHOOKS", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - }, - "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": [ - "name" - ] + "$ref": "#/components/schemas/CreateRoleRequest" } } }, @@ -9287,122 +7101,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "role_identifiers": { - "description": "unique ID or name of the Roles", - "type": "array", - "items": { - "type": "string" - } - }, - "org_identifiers": { - "description": "Unique Id or name of the Organisation", - "type": "array", - "items": { - "type": "string" - } - }, - "group_identifiers": { - "description": "Unique Id or name of the User Group", - "type": "array", - "items": { - "type": "string" - } - }, - "privileges": { - "description": "Privileges assigned to the Role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "UNKNOWN", - "ADMINISTRATION", - "AUTHORING", - "USERDATAUPLOADING", - "DATADOWNLOADING", - "USERMANAGEMENT", - "SECURITYMANAGEMENT", - "LOGICALMODELING", - "DATAMANAGEMENT", - "TAGMANAGEMENT", - "SHAREWITHALL", - "SYSTEMMANAGEMENT", - "JOBSCHEDULING", - "A3ANALYSIS", - "EXPERIMENTALFEATUREPRIVILEGE", - "BYPASSRLS", - "RANALYSIS", - "DISABLE_PINBOARD_CREATION", - "DEVELOPER", - "APPLICATION_ADMINISTRATION", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "BACKUP_ADMINISTRATION", - "SYSTEM_INFO_ADMINISTRATION", - "ENABLESPOTAPPCREATION", - "SYNCMANAGEMENT", - "ORG_ADMINISTRATION", - "ROLE_ADMINISTRATION", - "AUTHENTICATION_ADMINISTRATION", - "BILLING_INFO_ADMINISTRATION", - "PREVIEW_THOUGHTSPOT_SAGE", - "LIVEBOARD_VERIFIER", - "CAN_MANAGE_CUSTOM_CALENDAR", - "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_CONFIGURE_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "CONTROL_TRUSTED_AUTH", - "CAN_CREATE_CATALOG", - "ALLOW_NON_EMBED_FULL_APP_ACCESS", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "CAN_VIEW_FOLDERS", - "CAN_MODIDY_FOLDERS", - "CAN_MANAGE_VARIABLES", - "PREVIEW_DOCUMENT_SEARCH", - "CAN_SETUP_VERSION_CONTROL", - "CAN_MANAGE_WEBHOOKS", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - }, - "deprecated": { - "description": "Indicates whether the Role is deprecated.", - "type": "boolean", - "deprecated": true, - "nullable": true - }, - "external": { - "description": "Indicates whether the Role is external", - "type": "boolean", - "deprecated": true, - "nullable": true - }, - "shared_via_connection": { - "description": "Indicates whether the Role is shared via connection", - "type": "boolean", - "deprecated": true, - "nullable": true - }, - "permissions": { - "description": "Permission details of the Role", - "type": "array", - "items": { - "type": "string", - "enum": [ - "READ_ONLY", - "MODIFY", - "NO_ACCESS" - ] - }, - "deprecated": true - } - } + "$ref": "#/components/schemas/SearchRolesRequest" } } }, @@ -9478,67 +7177,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the Role.", - "type": "string" - }, - "description": { - "description": "Description of the Role.", - "type": "string" - }, - "privileges": { - "description": "Privileges granted to the role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "USERDATAUPLOADING", - "DATADOWNLOADING", - "DATAMANAGEMENT", - "SHAREWITHALL", - "JOBSCHEDULING", - "A3ANALYSIS", - "BYPASSRLS", - "DISABLE_PINBOARD_CREATION", - "DEVELOPER", - "APPLICATION_ADMINISTRATION", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "SYSTEM_INFO_ADMINISTRATION", - "SYNCMANAGEMENT", - "ORG_ADMINISTRATION", - "ROLE_ADMINISTRATION", - "AUTHENTICATION_ADMINISTRATION", - "BILLING_INFO_ADMINISTRATION", - "CONTROL_TRUSTED_AUTH", - "TAGMANAGEMENT", - "LIVEBOARD_VERIFIER", - "CAN_MANAGE_CUSTOM_CALENDAR", - "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "CAN_CREATE_CATALOG", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "CAN_MODIFY_FOLDERS", - "CAN_MANAGE_VARIABLES", - "CAN_VIEW_FOLDERS", - "PREVIEW_DOCUMENT_SEARCH", - "PREVIEW_THOUGHTSPOT_SAGE", - "CAN_MANAGE_WEBHOOKS", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - } - }, - "required": [ - "name" - ] + "$ref": "#/components/schemas/UpdateRoleRequest" } } }, @@ -9621,719 +7260,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the scheduled job.", - "type": "string" - }, - "description": { - "description": "Description of the job.", - "type": "string" - }, - "metadata_type": { - "description": "Type of the metadata object.", - "type": "string", - "enum": [ - "LIVEBOARD" - ] - }, - "metadata_identifier": { - "description": "Unique ID or name of the metadata object.", - "type": "string" - }, - "file_format": { - "description": "Export file format.", - "default": "PDF", - "type": "string", - "enum": [ - "CSV", - "PDF", - "XLSX" - ] - }, - "liveboard_options": { - "description": "Options to specify details of Liveboard.", - "allOf": [ - { - "$ref": "#/components/schemas/LiveboardOptionsInput" - } - ] - }, - "pdf_options": { - "description": "PDF layout and orientation settings. Applicable only if the `file_format` is specified as `PDF`.", - "allOf": [ - { - "$ref": "#/components/schemas/SchedulesPdfOptionsInput" - } - ] - }, - "time_zone": { - "description": "Time zone", - "default": "America/Los_Angeles", - "type": "string", - "enum": [ - "Africa/Abidjan", - "Africa/Accra", - "Africa/Addis_Ababa", - "Africa/Algiers", - "Africa/Asmara", - "Africa/Asmera", - "Africa/Bamako", - "Africa/Bangui", - "Africa/Banjul", - "Africa/Bissau", - "Africa/Blantyre", - "Africa/Brazzaville", - "Africa/Bujumbura", - "Africa/Cairo", - "Africa/Casablanca", - "Africa/Ceuta", - "Africa/Conakry", - "Africa/Dakar", - "Africa/Dar_es_Salaam", - "Africa/Djibouti", - "Africa/Douala", - "Africa/El_Aaiun", - "Africa/Freetown", - "Africa/Gaborone", - "Africa/Harare", - "Africa/Johannesburg", - "Africa/Juba", - "Africa/Kampala", - "Africa/Khartoum", - "Africa/Kigali", - "Africa/Kinshasa", - "Africa/Lagos", - "Africa/Libreville", - "Africa/Lome", - "Africa/Luanda", - "Africa/Lubumbashi", - "Africa/Lusaka", - "Africa/Malabo", - "Africa/Maputo", - "Africa/Maseru", - "Africa/Mbabane", - "Africa/Mogadishu", - "Africa/Monrovia", - "Africa/Nairobi", - "Africa/Ndjamena", - "Africa/Niamey", - "Africa/Nouakchott", - "Africa/Ouagadougou", - "Africa/Porto-Novo", - "Africa/Sao_Tome", - "Africa/Timbuktu", - "Africa/Tripoli", - "Africa/Tunis", - "Africa/Windhoek", - "America/Adak", - "America/Anchorage", - "America/Anguilla", - "America/Antigua", - "America/Araguaina", - "America/Argentina/Buenos_Aires", - "America/Argentina/Catamarca", - "America/Argentina/ComodRivadavia", - "America/Argentina/Cordoba", - "America/Argentina/Jujuy", - "America/Argentina/La_Rioja", - "America/Argentina/Mendoza", - "America/Argentina/Rio_Gallegos", - "America/Argentina/Salta", - "America/Argentina/San_Juan", - "America/Argentina/San_Luis", - "America/Argentina/Tucuman", - "America/Argentina/Ushuaia", - "America/Aruba", - "America/Asuncion", - "America/Atikokan", - "America/Atka", - "America/Bahia", - "America/Bahia_Banderas", - "America/Barbados", - "America/Belem", - "America/Belize", - "America/Blanc-Sablon", - "America/Boa_Vista", - "America/Bogota", - "America/Boise", - "America/Buenos_Aires", - "America/Cambridge_Bay", - "America/Campo_Grande", - "America/Cancun", - "America/Caracas", - "America/Catamarca", - "America/Cayenne", - "America/Cayman", - "America/Chicago", - "America/Chihuahua", - "America/Coral_Harbour", - "America/Cordoba", - "America/Costa_Rica", - "America/Creston", - "America/Cuiaba", - "America/Curacao", - "America/Danmarkshavn", - "America/Dawson", - "America/Dawson_Creek", - "America/Denver", - "America/Detroit", - "America/Dominica", - "America/Edmonton", - "America/Eirunepe", - "America/El_Salvador", - "America/Ensenada", - "America/Fort_Nelson", - "America/Fort_Wayne", - "America/Fortaleza", - "America/Glace_Bay", - "America/Godthab", - "America/Goose_Bay", - "America/Grand_Turk", - "America/Grenada", - "America/Guadeloupe", - "America/Guatemala", - "America/Guayaquil", - "America/Guyana", - "America/Halifax", - "America/Havana", - "America/Hermosillo", - "America/Indiana/Indianapolis", - "America/Indiana/Knox", - "America/Indiana/Marengo", - "America/Indiana/Petersburg", - "America/Indiana/Tell_City", - "America/Indiana/Vevay", - "America/Indiana/Vincennes", - "America/Indiana/Winamac", - "America/Indianapolis", - "America/Inuvik", - "America/Iqaluit", - "America/Jamaica", - "America/Jujuy", - "America/Juneau", - "America/Kentucky/Louisville", - "America/Kentucky/Monticello", - "America/Knox_IN", - "America/Kralendijk", - "America/La_Paz", - "America/Lima", - "America/Los_Angeles", - "America/Louisville", - "America/Lower_Princes", - "America/Maceio", - "America/Managua", - "America/Manaus", - "America/Marigot", - "America/Martinique", - "America/Matamoros", - "America/Mazatlan", - "America/Mendoza", - "America/Menominee", - "America/Merida", - "America/Metlakatla", - "America/Mexico_City", - "America/Miquelon", - "America/Moncton", - "America/Monterrey", - "America/Montevideo", - "America/Montreal", - "America/Montserrat", - "America/Nassau", - "America/New_York", - "America/Nipigon", - "America/Nome", - "America/Noronha", - "America/North_Dakota/Beulah", - "America/North_Dakota/Center", - "America/North_Dakota/New_Salem", - "America/Nuuk", - "America/Ojinaga", - "America/Panama", - "America/Pangnirtung", - "America/Paramaribo", - "America/Phoenix", - "America/Port-au-Prince", - "America/Port_of_Spain", - "America/Porto_Acre", - "America/Porto_Velho", - "America/Puerto_Rico", - "America/Punta_Arenas", - "America/Rainy_River", - "America/Rankin_Inlet", - "America/Recife", - "America/Regina", - "America/Resolute", - "America/Rio_Branco", - "America/Rosario", - "America/Santa_Isabel", - "America/Santarem", - "America/Santiago", - "America/Santo_Domingo", - "America/Sao_Paulo", - "America/Scoresbysund", - "America/Shiprock", - "America/Sitka", - "America/St_Barthelemy", - "America/St_Johns", - "America/St_Kitts", - "America/St_Lucia", - "America/St_Thomas", - "America/St_Vincent", - "America/Swift_Current", - "America/Tegucigalpa", - "America/Thule", - "America/Thunder_Bay", - "America/Tijuana", - "America/Toronto", - "America/Tortola", - "America/Vancouver", - "America/Virgin", - "America/Whitehorse", - "America/Winnipeg", - "America/Yakutat", - "America/Yellowknife", - "Antarctica/Casey", - "Antarctica/Davis", - "Antarctica/DumontDUrville", - "Antarctica/Macquarie", - "Antarctica/Mawson", - "Antarctica/McMurdo", - "Antarctica/Palmer", - "Antarctica/Rothera", - "Antarctica/South_Pole", - "Antarctica/Syowa", - "Antarctica/Troll", - "Antarctica/Vostok", - "Arctic/Longyearbyen", - "Asia/Aden", - "Asia/Almaty", - "Asia/Amman", - "Asia/Anadyr", - "Asia/Aqtau", - "Asia/Aqtobe", - "Asia/Ashgabat", - "Asia/Ashkhabad", - "Asia/Atyrau", - "Asia/Baghdad", - "Asia/Bahrain", - "Asia/Baku", - "Asia/Bangkok", - "Asia/Barnaul", - "Asia/Beirut", - "Asia/Bishkek", - "Asia/Brunei", - "Asia/Calcutta", - "Asia/Chita", - "Asia/Choibalsan", - "Asia/Chongqing", - "Asia/Chungking", - "Asia/Colombo", - "Asia/Dacca", - "Asia/Damascus", - "Asia/Dhaka", - "Asia/Dili", - "Asia/Dubai", - "Asia/Dushanbe", - "Asia/Famagusta", - "Asia/Gaza", - "Asia/Harbin", - "Asia/Hebron", - "Asia/Ho_Chi_Minh", - "Asia/Hong_Kong", - "Asia/Hovd", - "Asia/Irkutsk", - "Asia/Istanbul", - "Asia/Jakarta", - "Asia/Jayapura", - "Asia/Jerusalem", - "Asia/Kabul", - "Asia/Kamchatka", - "Asia/Karachi", - "Asia/Kashgar", - "Asia/Kathmandu", - "Asia/Katmandu", - "Asia/Khandyga", - "Asia/Kolkata", - "Asia/Krasnoyarsk", - "Asia/Kuala_Lumpur", - "Asia/Kuching", - "Asia/Kuwait", - "Asia/Macao", - "Asia/Macau", - "Asia/Magadan", - "Asia/Makassar", - "Asia/Manila", - "Asia/Muscat", - "Asia/Nicosia", - "Asia/Novokuznetsk", - "Asia/Novosibirsk", - "Asia/Omsk", - "Asia/Oral", - "Asia/Phnom_Penh", - "Asia/Pontianak", - "Asia/Pyongyang", - "Asia/Qatar", - "Asia/Qostanay", - "Asia/Qyzylorda", - "Asia/Rangoon", - "Asia/Riyadh", - "Asia/Saigon", - "Asia/Sakhalin", - "Asia/Samarkand", - "Asia/Seoul", - "Asia/Shanghai", - "Asia/Singapore", - "Asia/Srednekolymsk", - "Asia/Taipei", - "Asia/Tashkent", - "Asia/Tbilisi", - "Asia/Tehran", - "Asia/Tel_Aviv", - "Asia/Thimbu", - "Asia/Thimphu", - "Asia/Tokyo", - "Asia/Tomsk", - "Asia/Ujung_Pandang", - "Asia/Ulaanbaatar", - "Asia/Ulan_Bator", - "Asia/Urumqi", - "Asia/Ust-Nera", - "Asia/Vientiane", - "Asia/Vladivostok", - "Asia/Yakutsk", - "Asia/Yangon", - "Asia/Yekaterinburg", - "Asia/Yerevan", - "Atlantic/Azores", - "Atlantic/Bermuda", - "Atlantic/Canary", - "Atlantic/Cape_Verde", - "Atlantic/Faeroe", - "Atlantic/Faroe", - "Atlantic/Jan_Mayen", - "Atlantic/Madeira", - "Atlantic/Reykjavik", - "Atlantic/South_Georgia", - "Atlantic/St_Helena", - "Atlantic/Stanley", - "Australia/ACT", - "Australia/Adelaide", - "Australia/Brisbane", - "Australia/Broken_Hill", - "Australia/Canberra", - "Australia/Currie", - "Australia/Darwin", - "Australia/Eucla", - "Australia/Hobart", - "Australia/LHI", - "Australia/Lindeman", - "Australia/Lord_Howe", - "Australia/Melbourne", - "Australia/NSW", - "Australia/North", - "Australia/Perth", - "Australia/Queensland", - "Australia/South", - "Australia/Sydney", - "Australia/Tasmania", - "Australia/Victoria", - "Australia/West", - "Australia/Yancowinna", - "Brazil/Acre", - "Brazil/DeNoronha", - "Brazil/East", - "Brazil/West", - "CET", - "CST6CDT", - "Canada/Atlantic", - "Canada/Central", - "Canada/Eastern", - "Canada/Mountain", - "Canada/Newfoundland", - "Canada/Pacific", - "Canada/Saskatchewan", - "Canada/Yukon", - "Chile/Continental", - "Chile/EasterIsland", - "Cuba", - "EET", - "EST5EDT", - "Egypt", - "Eire", - "Etc/GMT", - "Etc/GMT+0", - "Etc/GMT+1", - "Etc/GMT+10", - "Etc/GMT+11", - "Etc/GMT+12", - "Etc/GMT+2", - "Etc/GMT+3", - "Etc/GMT+4", - "Etc/GMT+5", - "Etc/GMT+6", - "Etc/GMT+7", - "Etc/GMT+8", - "Etc/GMT+9", - "Etc/GMT-0", - "Etc/GMT-1", - "Etc/GMT-10", - "Etc/GMT-11", - "Etc/GMT-12", - "Etc/GMT-13", - "Etc/GMT-14", - "Etc/GMT-2", - "Etc/GMT-3", - "Etc/GMT-4", - "Etc/GMT-5", - "Etc/GMT-6", - "Etc/GMT-7", - "Etc/GMT-8", - "Etc/GMT-9", - "Etc/GMT0", - "Etc/Greenwich", - "Etc/UCT", - "Etc/UTC", - "Etc/Universal", - "Etc/Zulu", - "Europe/Amsterdam", - "Europe/Andorra", - "Europe/Astrakhan", - "Europe/Athens", - "Europe/Belfast", - "Europe/Belgrade", - "Europe/Berlin", - "Europe/Bratislava", - "Europe/Brussels", - "Europe/Bucharest", - "Europe/Budapest", - "Europe/Busingen", - "Europe/Chisinau", - "Europe/Copenhagen", - "Europe/Dublin", - "Europe/Gibraltar", - "Europe/Guernsey", - "Europe/Helsinki", - "Europe/Isle_of_Man", - "Europe/Istanbul", - "Europe/Jersey", - "Europe/Kaliningrad", - "Europe/Kiev", - "Europe/Kirov", - "Europe/Kyiv", - "Europe/Lisbon", - "Europe/Ljubljana", - "Europe/London", - "Europe/Luxembourg", - "Europe/Madrid", - "Europe/Malta", - "Europe/Mariehamn", - "Europe/Minsk", - "Europe/Monaco", - "Europe/Moscow", - "Europe/Nicosia", - "Europe/Oslo", - "Europe/Paris", - "Europe/Podgorica", - "Europe/Prague", - "Europe/Riga", - "Europe/Rome", - "Europe/Samara", - "Europe/San_Marino", - "Europe/Sarajevo", - "Europe/Saratov", - "Europe/Simferopol", - "Europe/Skopje", - "Europe/Sofia", - "Europe/Stockholm", - "Europe/Tallinn", - "Europe/Tirane", - "Europe/Tiraspol", - "Europe/Ulyanovsk", - "Europe/Uzhgorod", - "Europe/Vaduz", - "Europe/Vatican", - "Europe/Vienna", - "Europe/Vilnius", - "Europe/Volgograd", - "Europe/Warsaw", - "Europe/Zagreb", - "Europe/Zaporozhye", - "Europe/Zurich", - "GB", - "GB-Eire", - "GMT", - "GMT0", - "Greenwich", - "Hongkong", - "Iceland", - "Indian/Antananarivo", - "Indian/Chagos", - "Indian/Christmas", - "Indian/Cocos", - "Indian/Comoro", - "Indian/Kerguelen", - "Indian/Mahe", - "Indian/Maldives", - "Indian/Mauritius", - "Indian/Mayotte", - "Indian/Reunion", - "Iran", - "Israel", - "Jamaica", - "Japan", - "Kwajalein", - "Libya", - "MET", - "MST7MDT", - "Mexico/BajaNorte", - "Mexico/BajaSur", - "Mexico/General", - "NZ", - "NZ-CHAT", - "Navajo", - "PRC", - "PST8PDT", - "Pacific/Apia", - "Pacific/Auckland", - "Pacific/Bougainville", - "Pacific/Chatham", - "Pacific/Chuuk", - "Pacific/Easter", - "Pacific/Efate", - "Pacific/Enderbury", - "Pacific/Fakaofo", - "Pacific/Fiji", - "Pacific/Funafuti", - "Pacific/Galapagos", - "Pacific/Gambier", - "Pacific/Guadalcanal", - "Pacific/Guam", - "Pacific/Honolulu", - "Pacific/Johnston", - "Pacific/Kanton", - "Pacific/Kiritimati", - "Pacific/Kosrae", - "Pacific/Kwajalein", - "Pacific/Majuro", - "Pacific/Marquesas", - "Pacific/Midway", - "Pacific/Nauru", - "Pacific/Niue", - "Pacific/Norfolk", - "Pacific/Noumea", - "Pacific/Pago_Pago", - "Pacific/Palau", - "Pacific/Pitcairn", - "Pacific/Pohnpei", - "Pacific/Ponape", - "Pacific/Port_Moresby", - "Pacific/Rarotonga", - "Pacific/Saipan", - "Pacific/Samoa", - "Pacific/Tahiti", - "Pacific/Tarawa", - "Pacific/Tongatapu", - "Pacific/Truk", - "Pacific/Wake", - "Pacific/Wallis", - "Pacific/Yap", - "Poland", - "Portugal", - "ROK", - "Singapore", - "SystemV/AST4", - "SystemV/AST4ADT", - "SystemV/CST6", - "SystemV/CST6CDT", - "SystemV/EST5", - "SystemV/EST5EDT", - "SystemV/HST10", - "SystemV/MST7", - "SystemV/MST7MDT", - "SystemV/PST8", - "SystemV/PST8PDT", - "SystemV/YST9", - "SystemV/YST9YDT", - "Turkey", - "UCT", - "US/Alaska", - "US/Aleutian", - "US/Arizona", - "US/Central", - "US/East-Indiana", - "US/Eastern", - "US/Hawaii", - "US/Indiana-Starke", - "US/Michigan", - "US/Mountain", - "US/Pacific", - "US/Samoa", - "UTC", - "Universal", - "W-SU", - "WET", - "Zulu", - "EST", - "HST", - "MST", - "ACT", - "AET", - "AGT", - "ART", - "AST", - "BET", - "BST", - "CAT", - "CNT", - "CST", - "CTT", - "EAT", - "ECT", - "IET", - "IST", - "JST", - "MIT", - "NET", - "NST", - "PLT", - "PNT", - "PRT", - "PST", - "SST", - "VST" - ] - }, - "frequency": { - "description": "Frequency settings for the scheduled job.", - "allOf": [ - { - "$ref": "#/components/schemas/FrequencyInput" - } - ] - }, - "recipient_details": { - "description": "Recipients of the scheduled job notifications. Add the GUID or name of the ThoughtSpot users or groups as recipients in the `principals` array. If a recipient is not a ThoughtSpot user, specify email address.", - "allOf": [ - { - "$ref": "#/components/schemas/RecipientDetailsInput" - } - ] - }, - "personalised_view_id": { - "description": "Personalised view id of the liveboard to be scheduled.", - "type": "string" - } - }, - "required": [ - "name", - "description", - "metadata_type", - "metadata_identifier", - "time_zone", - "recipient_details" - ] + "$ref": "#/components/schemas/CreateScheduleRequest" } } }, @@ -10472,49 +7399,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects associated with the scheduled jobs.", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetadataInput" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included.", - "type": "integer", - "format": "int32" - }, - "sort_options": { - "description": "Sort options.", - "allOf": [ - { - "$ref": "#/components/schemas/SortingOptions" - } - ] - }, - "history_runs_options": { - "description": "Options while fetching history runs for the schedule.", - "allOf": [ - { - "$ref": "#/components/schemas/ScheduleHistoryRunsOptionsInput" - } - ] - }, - "schedule_identifiers": { - "description": "unique ID or name of the Schedule", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/SearchSchedulesRequest" } } }, @@ -10590,717 +7475,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the scheduled job.", - "type": "string" - }, - "description": { - "description": "Description of the scheduled job.", - "type": "string" - }, - "metadata_type": { - "description": "Type of metadata object.", - "type": "string", - "enum": [ - "LIVEBOARD" - ] - }, - "metadata_identifier": { - "description": "Unique ID or name of the metadata object.", - "type": "string" - }, - "file_format": { - "description": "Export file format.", - "type": "string", - "enum": [ - "CSV", - "PDF", - "XLSX" - ] - }, - "liveboard_options": { - "description": "Options to specify the details of a Liveboard.", - "allOf": [ - { - "$ref": "#/components/schemas/LiveboardOptionsInput" - } - ] - }, - "pdf_options": { - "description": "Options for PDF export.", - "allOf": [ - { - "$ref": "#/components/schemas/SchedulesPdfOptionsInput" - } - ] - }, - "time_zone": { - "description": "Time zone", - "type": "string", - "enum": [ - "Africa/Abidjan", - "Africa/Accra", - "Africa/Addis_Ababa", - "Africa/Algiers", - "Africa/Asmara", - "Africa/Asmera", - "Africa/Bamako", - "Africa/Bangui", - "Africa/Banjul", - "Africa/Bissau", - "Africa/Blantyre", - "Africa/Brazzaville", - "Africa/Bujumbura", - "Africa/Cairo", - "Africa/Casablanca", - "Africa/Ceuta", - "Africa/Conakry", - "Africa/Dakar", - "Africa/Dar_es_Salaam", - "Africa/Djibouti", - "Africa/Douala", - "Africa/El_Aaiun", - "Africa/Freetown", - "Africa/Gaborone", - "Africa/Harare", - "Africa/Johannesburg", - "Africa/Juba", - "Africa/Kampala", - "Africa/Khartoum", - "Africa/Kigali", - "Africa/Kinshasa", - "Africa/Lagos", - "Africa/Libreville", - "Africa/Lome", - "Africa/Luanda", - "Africa/Lubumbashi", - "Africa/Lusaka", - "Africa/Malabo", - "Africa/Maputo", - "Africa/Maseru", - "Africa/Mbabane", - "Africa/Mogadishu", - "Africa/Monrovia", - "Africa/Nairobi", - "Africa/Ndjamena", - "Africa/Niamey", - "Africa/Nouakchott", - "Africa/Ouagadougou", - "Africa/Porto-Novo", - "Africa/Sao_Tome", - "Africa/Timbuktu", - "Africa/Tripoli", - "Africa/Tunis", - "Africa/Windhoek", - "America/Adak", - "America/Anchorage", - "America/Anguilla", - "America/Antigua", - "America/Araguaina", - "America/Argentina/Buenos_Aires", - "America/Argentina/Catamarca", - "America/Argentina/ComodRivadavia", - "America/Argentina/Cordoba", - "America/Argentina/Jujuy", - "America/Argentina/La_Rioja", - "America/Argentina/Mendoza", - "America/Argentina/Rio_Gallegos", - "America/Argentina/Salta", - "America/Argentina/San_Juan", - "America/Argentina/San_Luis", - "America/Argentina/Tucuman", - "America/Argentina/Ushuaia", - "America/Aruba", - "America/Asuncion", - "America/Atikokan", - "America/Atka", - "America/Bahia", - "America/Bahia_Banderas", - "America/Barbados", - "America/Belem", - "America/Belize", - "America/Blanc-Sablon", - "America/Boa_Vista", - "America/Bogota", - "America/Boise", - "America/Buenos_Aires", - "America/Cambridge_Bay", - "America/Campo_Grande", - "America/Cancun", - "America/Caracas", - "America/Catamarca", - "America/Cayenne", - "America/Cayman", - "America/Chicago", - "America/Chihuahua", - "America/Coral_Harbour", - "America/Cordoba", - "America/Costa_Rica", - "America/Creston", - "America/Cuiaba", - "America/Curacao", - "America/Danmarkshavn", - "America/Dawson", - "America/Dawson_Creek", - "America/Denver", - "America/Detroit", - "America/Dominica", - "America/Edmonton", - "America/Eirunepe", - "America/El_Salvador", - "America/Ensenada", - "America/Fort_Nelson", - "America/Fort_Wayne", - "America/Fortaleza", - "America/Glace_Bay", - "America/Godthab", - "America/Goose_Bay", - "America/Grand_Turk", - "America/Grenada", - "America/Guadeloupe", - "America/Guatemala", - "America/Guayaquil", - "America/Guyana", - "America/Halifax", - "America/Havana", - "America/Hermosillo", - "America/Indiana/Indianapolis", - "America/Indiana/Knox", - "America/Indiana/Marengo", - "America/Indiana/Petersburg", - "America/Indiana/Tell_City", - "America/Indiana/Vevay", - "America/Indiana/Vincennes", - "America/Indiana/Winamac", - "America/Indianapolis", - "America/Inuvik", - "America/Iqaluit", - "America/Jamaica", - "America/Jujuy", - "America/Juneau", - "America/Kentucky/Louisville", - "America/Kentucky/Monticello", - "America/Knox_IN", - "America/Kralendijk", - "America/La_Paz", - "America/Lima", - "America/Los_Angeles", - "America/Louisville", - "America/Lower_Princes", - "America/Maceio", - "America/Managua", - "America/Manaus", - "America/Marigot", - "America/Martinique", - "America/Matamoros", - "America/Mazatlan", - "America/Mendoza", - "America/Menominee", - "America/Merida", - "America/Metlakatla", - "America/Mexico_City", - "America/Miquelon", - "America/Moncton", - "America/Monterrey", - "America/Montevideo", - "America/Montreal", - "America/Montserrat", - "America/Nassau", - "America/New_York", - "America/Nipigon", - "America/Nome", - "America/Noronha", - "America/North_Dakota/Beulah", - "America/North_Dakota/Center", - "America/North_Dakota/New_Salem", - "America/Nuuk", - "America/Ojinaga", - "America/Panama", - "America/Pangnirtung", - "America/Paramaribo", - "America/Phoenix", - "America/Port-au-Prince", - "America/Port_of_Spain", - "America/Porto_Acre", - "America/Porto_Velho", - "America/Puerto_Rico", - "America/Punta_Arenas", - "America/Rainy_River", - "America/Rankin_Inlet", - "America/Recife", - "America/Regina", - "America/Resolute", - "America/Rio_Branco", - "America/Rosario", - "America/Santa_Isabel", - "America/Santarem", - "America/Santiago", - "America/Santo_Domingo", - "America/Sao_Paulo", - "America/Scoresbysund", - "America/Shiprock", - "America/Sitka", - "America/St_Barthelemy", - "America/St_Johns", - "America/St_Kitts", - "America/St_Lucia", - "America/St_Thomas", - "America/St_Vincent", - "America/Swift_Current", - "America/Tegucigalpa", - "America/Thule", - "America/Thunder_Bay", - "America/Tijuana", - "America/Toronto", - "America/Tortola", - "America/Vancouver", - "America/Virgin", - "America/Whitehorse", - "America/Winnipeg", - "America/Yakutat", - "America/Yellowknife", - "Antarctica/Casey", - "Antarctica/Davis", - "Antarctica/DumontDUrville", - "Antarctica/Macquarie", - "Antarctica/Mawson", - "Antarctica/McMurdo", - "Antarctica/Palmer", - "Antarctica/Rothera", - "Antarctica/South_Pole", - "Antarctica/Syowa", - "Antarctica/Troll", - "Antarctica/Vostok", - "Arctic/Longyearbyen", - "Asia/Aden", - "Asia/Almaty", - "Asia/Amman", - "Asia/Anadyr", - "Asia/Aqtau", - "Asia/Aqtobe", - "Asia/Ashgabat", - "Asia/Ashkhabad", - "Asia/Atyrau", - "Asia/Baghdad", - "Asia/Bahrain", - "Asia/Baku", - "Asia/Bangkok", - "Asia/Barnaul", - "Asia/Beirut", - "Asia/Bishkek", - "Asia/Brunei", - "Asia/Calcutta", - "Asia/Chita", - "Asia/Choibalsan", - "Asia/Chongqing", - "Asia/Chungking", - "Asia/Colombo", - "Asia/Dacca", - "Asia/Damascus", - "Asia/Dhaka", - "Asia/Dili", - "Asia/Dubai", - "Asia/Dushanbe", - "Asia/Famagusta", - "Asia/Gaza", - "Asia/Harbin", - "Asia/Hebron", - "Asia/Ho_Chi_Minh", - "Asia/Hong_Kong", - "Asia/Hovd", - "Asia/Irkutsk", - "Asia/Istanbul", - "Asia/Jakarta", - "Asia/Jayapura", - "Asia/Jerusalem", - "Asia/Kabul", - "Asia/Kamchatka", - "Asia/Karachi", - "Asia/Kashgar", - "Asia/Kathmandu", - "Asia/Katmandu", - "Asia/Khandyga", - "Asia/Kolkata", - "Asia/Krasnoyarsk", - "Asia/Kuala_Lumpur", - "Asia/Kuching", - "Asia/Kuwait", - "Asia/Macao", - "Asia/Macau", - "Asia/Magadan", - "Asia/Makassar", - "Asia/Manila", - "Asia/Muscat", - "Asia/Nicosia", - "Asia/Novokuznetsk", - "Asia/Novosibirsk", - "Asia/Omsk", - "Asia/Oral", - "Asia/Phnom_Penh", - "Asia/Pontianak", - "Asia/Pyongyang", - "Asia/Qatar", - "Asia/Qostanay", - "Asia/Qyzylorda", - "Asia/Rangoon", - "Asia/Riyadh", - "Asia/Saigon", - "Asia/Sakhalin", - "Asia/Samarkand", - "Asia/Seoul", - "Asia/Shanghai", - "Asia/Singapore", - "Asia/Srednekolymsk", - "Asia/Taipei", - "Asia/Tashkent", - "Asia/Tbilisi", - "Asia/Tehran", - "Asia/Tel_Aviv", - "Asia/Thimbu", - "Asia/Thimphu", - "Asia/Tokyo", - "Asia/Tomsk", - "Asia/Ujung_Pandang", - "Asia/Ulaanbaatar", - "Asia/Ulan_Bator", - "Asia/Urumqi", - "Asia/Ust-Nera", - "Asia/Vientiane", - "Asia/Vladivostok", - "Asia/Yakutsk", - "Asia/Yangon", - "Asia/Yekaterinburg", - "Asia/Yerevan", - "Atlantic/Azores", - "Atlantic/Bermuda", - "Atlantic/Canary", - "Atlantic/Cape_Verde", - "Atlantic/Faeroe", - "Atlantic/Faroe", - "Atlantic/Jan_Mayen", - "Atlantic/Madeira", - "Atlantic/Reykjavik", - "Atlantic/South_Georgia", - "Atlantic/St_Helena", - "Atlantic/Stanley", - "Australia/ACT", - "Australia/Adelaide", - "Australia/Brisbane", - "Australia/Broken_Hill", - "Australia/Canberra", - "Australia/Currie", - "Australia/Darwin", - "Australia/Eucla", - "Australia/Hobart", - "Australia/LHI", - "Australia/Lindeman", - "Australia/Lord_Howe", - "Australia/Melbourne", - "Australia/NSW", - "Australia/North", - "Australia/Perth", - "Australia/Queensland", - "Australia/South", - "Australia/Sydney", - "Australia/Tasmania", - "Australia/Victoria", - "Australia/West", - "Australia/Yancowinna", - "Brazil/Acre", - "Brazil/DeNoronha", - "Brazil/East", - "Brazil/West", - "CET", - "CST6CDT", - "Canada/Atlantic", - "Canada/Central", - "Canada/Eastern", - "Canada/Mountain", - "Canada/Newfoundland", - "Canada/Pacific", - "Canada/Saskatchewan", - "Canada/Yukon", - "Chile/Continental", - "Chile/EasterIsland", - "Cuba", - "EET", - "EST5EDT", - "Egypt", - "Eire", - "Etc/GMT", - "Etc/GMT+0", - "Etc/GMT+1", - "Etc/GMT+10", - "Etc/GMT+11", - "Etc/GMT+12", - "Etc/GMT+2", - "Etc/GMT+3", - "Etc/GMT+4", - "Etc/GMT+5", - "Etc/GMT+6", - "Etc/GMT+7", - "Etc/GMT+8", - "Etc/GMT+9", - "Etc/GMT-0", - "Etc/GMT-1", - "Etc/GMT-10", - "Etc/GMT-11", - "Etc/GMT-12", - "Etc/GMT-13", - "Etc/GMT-14", - "Etc/GMT-2", - "Etc/GMT-3", - "Etc/GMT-4", - "Etc/GMT-5", - "Etc/GMT-6", - "Etc/GMT-7", - "Etc/GMT-8", - "Etc/GMT-9", - "Etc/GMT0", - "Etc/Greenwich", - "Etc/UCT", - "Etc/UTC", - "Etc/Universal", - "Etc/Zulu", - "Europe/Amsterdam", - "Europe/Andorra", - "Europe/Astrakhan", - "Europe/Athens", - "Europe/Belfast", - "Europe/Belgrade", - "Europe/Berlin", - "Europe/Bratislava", - "Europe/Brussels", - "Europe/Bucharest", - "Europe/Budapest", - "Europe/Busingen", - "Europe/Chisinau", - "Europe/Copenhagen", - "Europe/Dublin", - "Europe/Gibraltar", - "Europe/Guernsey", - "Europe/Helsinki", - "Europe/Isle_of_Man", - "Europe/Istanbul", - "Europe/Jersey", - "Europe/Kaliningrad", - "Europe/Kiev", - "Europe/Kirov", - "Europe/Kyiv", - "Europe/Lisbon", - "Europe/Ljubljana", - "Europe/London", - "Europe/Luxembourg", - "Europe/Madrid", - "Europe/Malta", - "Europe/Mariehamn", - "Europe/Minsk", - "Europe/Monaco", - "Europe/Moscow", - "Europe/Nicosia", - "Europe/Oslo", - "Europe/Paris", - "Europe/Podgorica", - "Europe/Prague", - "Europe/Riga", - "Europe/Rome", - "Europe/Samara", - "Europe/San_Marino", - "Europe/Sarajevo", - "Europe/Saratov", - "Europe/Simferopol", - "Europe/Skopje", - "Europe/Sofia", - "Europe/Stockholm", - "Europe/Tallinn", - "Europe/Tirane", - "Europe/Tiraspol", - "Europe/Ulyanovsk", - "Europe/Uzhgorod", - "Europe/Vaduz", - "Europe/Vatican", - "Europe/Vienna", - "Europe/Vilnius", - "Europe/Volgograd", - "Europe/Warsaw", - "Europe/Zagreb", - "Europe/Zaporozhye", - "Europe/Zurich", - "GB", - "GB-Eire", - "GMT", - "GMT0", - "Greenwich", - "Hongkong", - "Iceland", - "Indian/Antananarivo", - "Indian/Chagos", - "Indian/Christmas", - "Indian/Cocos", - "Indian/Comoro", - "Indian/Kerguelen", - "Indian/Mahe", - "Indian/Maldives", - "Indian/Mauritius", - "Indian/Mayotte", - "Indian/Reunion", - "Iran", - "Israel", - "Jamaica", - "Japan", - "Kwajalein", - "Libya", - "MET", - "MST7MDT", - "Mexico/BajaNorte", - "Mexico/BajaSur", - "Mexico/General", - "NZ", - "NZ-CHAT", - "Navajo", - "PRC", - "PST8PDT", - "Pacific/Apia", - "Pacific/Auckland", - "Pacific/Bougainville", - "Pacific/Chatham", - "Pacific/Chuuk", - "Pacific/Easter", - "Pacific/Efate", - "Pacific/Enderbury", - "Pacific/Fakaofo", - "Pacific/Fiji", - "Pacific/Funafuti", - "Pacific/Galapagos", - "Pacific/Gambier", - "Pacific/Guadalcanal", - "Pacific/Guam", - "Pacific/Honolulu", - "Pacific/Johnston", - "Pacific/Kanton", - "Pacific/Kiritimati", - "Pacific/Kosrae", - "Pacific/Kwajalein", - "Pacific/Majuro", - "Pacific/Marquesas", - "Pacific/Midway", - "Pacific/Nauru", - "Pacific/Niue", - "Pacific/Norfolk", - "Pacific/Noumea", - "Pacific/Pago_Pago", - "Pacific/Palau", - "Pacific/Pitcairn", - "Pacific/Pohnpei", - "Pacific/Ponape", - "Pacific/Port_Moresby", - "Pacific/Rarotonga", - "Pacific/Saipan", - "Pacific/Samoa", - "Pacific/Tahiti", - "Pacific/Tarawa", - "Pacific/Tongatapu", - "Pacific/Truk", - "Pacific/Wake", - "Pacific/Wallis", - "Pacific/Yap", - "Poland", - "Portugal", - "ROK", - "Singapore", - "SystemV/AST4", - "SystemV/AST4ADT", - "SystemV/CST6", - "SystemV/CST6CDT", - "SystemV/EST5", - "SystemV/EST5EDT", - "SystemV/HST10", - "SystemV/MST7", - "SystemV/MST7MDT", - "SystemV/PST8", - "SystemV/PST8PDT", - "SystemV/YST9", - "SystemV/YST9YDT", - "Turkey", - "UCT", - "US/Alaska", - "US/Aleutian", - "US/Arizona", - "US/Central", - "US/East-Indiana", - "US/Eastern", - "US/Hawaii", - "US/Indiana-Starke", - "US/Michigan", - "US/Mountain", - "US/Pacific", - "US/Samoa", - "UTC", - "Universal", - "W-SU", - "WET", - "Zulu", - "EST", - "HST", - "MST", - "ACT", - "AET", - "AGT", - "ART", - "AST", - "BET", - "BST", - "CAT", - "CNT", - "CST", - "CTT", - "EAT", - "ECT", - "IET", - "IST", - "JST", - "MIT", - "NET", - "NST", - "PLT", - "PNT", - "PRT", - "PST", - "SST", - "VST" - ] - }, - "frequency": { - "description": "Frequency of the scheduled job run.", - "allOf": [ - { - "$ref": "#/components/schemas/FrequencyInput" - } - ] - }, - "recipient_details": { - "description": "Recipients of the scheduled job notifications. You can add the ID or name of the ThoughtSpot users or groups as recipients in the `principals` array. If a recipient is not a ThoughtSpot user, specify email address.", - "allOf": [ - { - "$ref": "#/components/schemas/RecipientDetailsInput" - } - ] - }, - "status": { - "description": "Status of the schedule", - "type": "string", - "enum": [ - "ACTIVE", - "PAUSE" - ] - }, - "personalised_view_id": { - "description": "Personalised view id of the liveboard to be scheduled.", - "type": "string" - } - } + "$ref": "#/components/schemas/UpdateScheduleRequest" } } }, @@ -11376,28 +7551,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "GUID or name of the metadata object.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AuthorMetadataTypeInput" - } - }, - "user_identifier": { - "description": "GUID or name of the user who you want to assign as the author.", - "type": "string" - }, - "current_owner_identifier": { - "description": "GUID or name of the current author. When defined, the metadata objects\nauthored by the specified owner are filtered for the API operation.", - "type": "string" - } - }, - "required": [ - "metadata", - "user_identifier" - ] + "$ref": "#/components/schemas/AssignChangeAuthorRequest" } } }, @@ -11463,19 +7617,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "tables": { - "description": "Array of table identifier objects for which to fetch column security rules", - "type": "array", - "items": { - "$ref": "#/components/schemas/ColumnSecurityRuleTableInput" - } - } - }, - "required": [ - "tables" - ] + "$ref": "#/components/schemas/FetchColumnSecurityRulesRequest" } } }, @@ -11551,38 +7693,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects for which you want to fetch object privileges. For now only LOGICAL_TABLE is supported. It may be extended to other metadata types in the future.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ObjectPrivilegesMetadataInput" - } - }, - "principals": { - "description": "User or group objects for which you want to fetch object privileges.\nIf not specified, the API returns all users and groups that\nhave object privileges on the specified metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PrincipalsInput" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included for each metadata type.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included for each metadata type.", - "default": 20, - "type": "integer", - "format": "int32" - } - }, - "required": [ - "metadata" - ] + "$ref": "#/components/schemas/FetchObjectPrivilegesRequest" } } }, @@ -11655,50 +7766,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "principals": { - "description": "GUID or name of the user or group.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PrincipalsInput" - } - }, - "metadata": { - "description": "Metadata objects for which you want to fetch permission details.\nIf not specified, the API returns permission details for all\nmetadata objects that the specified users and groups can access.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionsMetadataTypeInput" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included for each metadata type.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included for each metadata type.", - "default": -1, - "type": "integer", - "format": "int32" - }, - "default_metadata_type": { - "description": "When no metadata objects input is passed, metadata objects of this type are fetched.", - "type": "string", - "enum": [ - "ALL", - "LIVEBOARD", - "ANSWER", - "LOGICAL_TABLE", - "LOGICAL_COLUMN", - "CONNECTION" - ] - } - }, - "required": [ - "principals" - ] + "$ref": "#/components/schemas/FetchPermissionsOfPrincipalsRequest" } } }, @@ -11807,48 +7875,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "GUID or name of the metadata object.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionsMetadataTypeInput" - } - }, - "principals": { - "description": "User or group objects for which you want to fetch permissions.\nIf not specified, the API returns all users and groups that\ncan access the specified metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PrincipalsInput" - } - }, - "include_dependent_objects": { - "description": "Indicates whether to fetch permissions of dependent metadata objects.", - "default": false, - "type": "boolean", - "nullable": true - }, - "record_offset": { - "description": "The starting record number from where the records should be included for each metadata type.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included for each metadata type.", - "default": -1, - "type": "integer", - "format": "int32" - }, - "permission_type": { - "description": "
Version: 10.3.0.cl or later
\n\nSpecifies the type of permission. Valid values are:\n EFFECTIVE - If the user permission to the metadata objects is granted by the privileges assigned to the groups to which they belong.\n DEFINED - If a user or user group received access to metadata objects via object sharing by another user.", - "type": "string" - } - }, - "required": [ - "metadata" - ] + "$ref": "#/components/schemas/FetchPermissionsOnMetadataRequest" } } }, @@ -11977,55 +8004,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "operation": { - "description": "Operation to perform to manage object privileges. Available operations are: `ADD`, `REMOVE`.", - "type": "string", - "enum": [ - "ADD", - "REMOVE" - ] - }, - "metadata_type": { - "description": "Type of metadata objects on which you want to perform the operation. For now only LOGICAL_TABLE is supported. It may be extended to other metadata types in the future.", - "type": "string", - "enum": [ - "LOGICAL_TABLE" - ] - }, - "object_privilege_types": { - "description": "List of object privilege types on which you want to perform the operation.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "SPOTTER_COACHING_PRIVILEGE" - ] - } - }, - "metadata_identifiers": { - "description": "List of metadata identifiers (GUID or name) on which you want to perform the operation.", - "type": "array", - "items": { - "type": "string" - } - }, - "principals": { - "description": "User or group objects (GUID or name) to which you want to apply the given operation and given object privileges.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PrincipalsInput" - } - } - }, - "required": [ - "operation", - "metadata_type", - "object_privilege_types", - "metadata_identifiers", - "principals" - ] + "$ref": "#/components/schemas/ManageObjectPrivilegeRequest" } } }, @@ -12091,32 +8070,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects to be published.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PublishMetadataListItem" - } - }, - "org_identifiers": { - "description": "Unique ID or name of orgs to which metadata objects should be published.", - "type": "array", - "items": { - "type": "string" - } - }, - "skip_validation": { - "description": "Skip validations of objects to be published.", - "type": "boolean", - "nullable": true - } - }, - "required": [ - "metadata", - "org_identifiers" - ] + "$ref": "#/components/schemas/PublishMetadataRequest" } } }, @@ -12173,7 +8127,7 @@ "/api/rest/2.0/security/metadata/share": { "post": { "operationId": "shareMetadata", - "description": "\n Version: 9.0.0.cl or later\n\nAllows sharing one or several metadata objects with users and groups in ThoughtSpot.\n\nRequires edit access to the metadata object.\n\nThe API endpoint allows sharing only the following types of metadata objects:\n* Liveboards\n* Visualizations\n* Answers\n* Worksheets\n* Views\n* Connections\n\nYou can provide `READ_ONLY` or `MODIFY` access when sharing an object with another user or group. With `READ_ONLY` access grants view access to the shared object, whereas `MODIFY` provides edit access.\n\nTo prevent a user or group from accessing the shared object, specify the GUID or name of the principal and set `shareMode` to `NO_ACCESS`.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nAllows sharing one or several metadata objects with users and groups in ThoughtSpot.\n\nRequires edit access to the metadata object.\n\n#### Supported metadata objects:\n* Liveboards\n* Visualizations\n* Answers\n* Models\n* Views\n* Connections\n\n#### Object permissions\n\nYou can provide `READ_ONLY` or `MODIFY` access when sharing an object with another user or group. The `READ_ONLY` permission grants view access to the shared object, whereas `MODIFY` provides edit access.\n\nTo prevent a user or group from accessing the shared object, specify the GUID or name of the principal and set `shareMode` to `NO_ACCESS`.\n\n#### Sharing a visualization\n\n* Sharing a visualization implicitly shares the entire Liveboard with the recipient. \n* Object permissions set for a shared visualization also apply to the Liveboard unless overridden by another API request or via UI.\n* If email notifications for object sharing are enabled, a notification with a link to the shared visualization will be sent to the recipient’s email address. Although this link opens the shared visualization, recipients can also access other visualizations in the Liveboard.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "9.0.0.cl" @@ -12182,82 +8136,7 @@ "content": { "application/json": { "schema": { - "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.\n4. LOGICAL_COLUMN\n5. Connection", - "type": "string", - "enum": [ - "LIVEBOARD", - "ANSWER", - "LOGICAL_TABLE", - "LOGICAL_COLUMN", - "CONNECTION" - ] - }, - "metadata_identifiers": { - "description": "Unique ID or name of metadata objects. Note: All the names should belong to same metadata_type", - "type": "array", - "items": { - "type": "string" - } - }, - "metadata": { - "description": "Metadata details for sharing objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShareMetadataTypeInput" - } - }, - "permissions": { - "description": "Permission details for sharing the objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SharePermissionsInput" - } - }, - "visualization_identifiers": { - "description": "Options to specify details of Liveboard. First Liveboard encountered in payload is considered to be the corresponding Liveboard.", - "type": "array", - "items": { - "type": "string" - } - }, - "emails": { - "description": "Email IDs to which notifications will be sent.", - "default": [], - "type": "array", - "items": { - "type": "string" - } - }, - "message": { - "description": "Message to be included in notification.", - "type": "string" - }, - "enable_custom_url": { - "description": "Sends object URLs in the customized format in email notifications.", - "default": false, - "type": "boolean", - "nullable": true - }, - "notify_on_share": { - "description": "Flag to notify user when any object is shared.", - "default": true, - "type": "boolean", - "nullable": true - }, - "has_lenient_discoverability": { - "description": "Flag to make the object discoverable.", - "default": false, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "permissions", - "message" - ] + "$ref": "#/components/schemas/ShareMetadataRequest" } } }, @@ -12323,37 +8202,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "force": { - "description": "Force unpublishes the object. This will break all the dependent objects in the unpublished orgs.", - "type": "boolean", - "nullable": true - }, - "include_dependencies": { - "description": "Should we unpublish all the dependencies for the objects specified.\nThe dependencies will be unpublished if no other published object is using it.", - "type": "boolean" - }, - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/PublishMetadataListItem" - } - }, - "org_identifiers": { - "description": "Unique ID or name of orgs.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "include_dependencies", - "metadata", - "org_identifiers" - ] + "$ref": "#/components/schemas/UnpublishMetadataRequest" } } }, @@ -12419,32 +8268,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "identifier": { - "description": "GUID or name of the table for which we want to create column security rules", - "type": "string" - }, - "obj_identifier": { - "description": "The object ID of the table", - "type": "string" - }, - "clear_csr": { - "description": "If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed", - "type": "boolean", - "nullable": true - }, - "column_security_rules": { - "description": "Array where each object defines the security rule for a specific column", - "type": "array", - "items": { - "$ref": "#/components/schemas/ColumnSecurityRuleUpdate" - } - } - }, - "required": [ - "column_security_rules" - ] + "$ref": "#/components/schemas/UpdateColumnSecurityRulesRequest" } } }, @@ -12510,23 +8334,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "cluster_preferences": { - "description": "Cluster-level default configurations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EventChannelConfigInput" - } - }, - "org_preferences": { - "description": "Org-specific configurations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrgChannelConfigInput" - } - } - } + "$ref": "#/components/schemas/ConfigureCommunicationChannelPreferencesRequest" } } }, @@ -12583,7 +8391,7 @@ "/api/rest/2.0/system/security-settings/configure": { "post": { "operationId": "configureSecuritySettings", - "description": "\nBeta Version: 26.2.0.cl or later\n\nConfigure security settings for your ThoughtSpot application instance.\n- Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration.\n- Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege.\nSee [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details.\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.2.0.cl or later\n\nConfigure security settings for your ThoughtSpot application instance.\n- Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration.\n- Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege.\nSee [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details.\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "26.2.0.cl" @@ -12592,24 +8400,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "cluster_preferences": { - "description": "Cluster-level security preferences.", - "allOf": [ - { - "$ref": "#/components/schemas/SecuritySettingsClusterPreferencesInput" - } - ] - }, - "org_preferences": { - "description": "Org-level security preferences for the current org.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SecuritySettingsOrgPreferencesInput" - } - } - } + "$ref": "#/components/schemas/ConfigureSecuritySettingsRequest" } } }, @@ -12902,26 +8693,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "cluster_preferences": { - "description": "Event types to search for in cluster-level preferences.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "LIVEBOARD_SCHEDULE" - ] - } - }, - "org_preferences": { - "description": "Org-specific search criteria.", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrgPreferenceSearchCriteriaInput" - } - } - } + "$ref": "#/components/schemas/SearchCommunicationChannelPreferencesRequest" } } }, @@ -13015,7 +8787,7 @@ "/api/rest/2.0/system/security-settings/search": { "post": { "operationId": "searchSecuritySettings", - "description": "\nBeta Version: 26.2.0.cl or later\n\nFetch security settings for your ThoughtSpot application instance.\n- Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages.\n- Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org.\n- If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\nSee [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details.\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.2.0.cl or later\n\nFetch security settings for your ThoughtSpot application instance.\n- Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages.\n- Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org.\n- If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\nSee [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details.\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "26.2.0.cl" @@ -13024,17 +8796,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "scope": { - "description": "Scope of security settings to retrieve. CLUSTER returns cluster-level settings,\nORG returns org-level settings for the current org.\nIf not specified, returns both cluster and org settings based on user privileges.", - "type": "string", - "enum": [ - "CLUSTER", - "ORG" - ] - } - } + "$ref": "#/components/schemas/SearchSecuritySettingsRequest" } } }, @@ -13171,16 +8933,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "configuration": { - "description": "Configuration JSON with the key-value pair of configuration attributes to be updated.", - "type": "object" - } - }, - "required": [ - "configuration" - ] + "$ref": "#/components/schemas/UpdateSystemConfigRequest" } } }, @@ -13234,6 +8987,79 @@ } } }, + "/api/rest/2.0/system/communication-channels/validate": { + "post": { + "operationId": "validateCommunicationChannel", + "description": "\nBeta Version: 26.4.0.cl or later\n\nValidates a communication channel configuration to ensure it is properly set up and can receive events.\n- Use `channel_type` to specify the type of communication channel to validate (e.g., WEBHOOK).\n- Use `channel_identifier` to provide the unique identifier or name for the communication channel.\n- Use `event_type` to specify the event type to validate for this channel.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. For webhook channels, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "System", + "26.4.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateCommunicationChannelRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "communication channel configuration validated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommunicationChannelValidateResponse" + } + } + } + }, + "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/tags/assign": { "post": { "operationId": "assignTag", @@ -13246,27 +9072,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/TagMetadataTypeInput" - } - }, - "tag_identifiers": { - "description": "GUID or name of the tag.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "metadata", - "tag_identifiers" - ] + "$ref": "#/components/schemas/AssignTagRequest" } } }, @@ -13332,20 +9138,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the tag.", - "type": "string" - }, - "color": { - "description": "Hex color code to be assigned to the tag. For example, #ff78a9.", - "type": "string" - } - }, - "required": [ - "name" - ] + "$ref": "#/components/schemas/CreateTagRequest" } } }, @@ -13502,21 +9295,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "tag_identifier": { - "description": "Name or Id of the tag.", - "type": "string" - }, - "name_pattern": { - "description": "A pattern to match case-insensitive name of the Tag object.", - "type": "string" - }, - "color": { - "description": "Color of the tag.", - "type": "string" - } - } + "$ref": "#/components/schemas/SearchTagsRequest" } } }, @@ -13626,27 +9405,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/TagMetadataTypeInput" - } - }, - "tag_identifiers": { - "description": "GUID or name of the tag.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "metadata", - "tag_identifiers" - ] + "$ref": "#/components/schemas/UnassignTagRequest" } } }, @@ -13712,17 +9471,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the tag.", - "type": "string" - }, - "color": { - "description": "Hex color code to be assigned to the tag. For example, #ff78a9.", - "type": "string" - } - } + "$ref": "#/components/schemas/UpdateTagRequest" } } }, @@ -13798,30 +9547,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "user_identifier": { - "description": "Unique ID or name of the user.", - "type": "string" - }, - "auth_token": { - "description": "Auth token for the user.", - "type": "string" - }, - "password": { - "description": "New password for the user to access the account.", - "type": "string" - }, - "properties": { - "description": "Properties of the user.", - "type": "string" - } - }, - "required": [ - "user_identifier", - "auth_token", - "password" - ] + "$ref": "#/components/schemas/ActivateUserRequest" } } }, @@ -13894,26 +9620,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "current_password": { - "description": "Current password of the user.", - "type": "string" - }, - "new_password": { - "description": "New password for the user.", - "type": "string" - }, - "user_identifier": { - "description": "GUID or name of the user.", - "type": "string" - } - }, - "required": [ - "current_password", - "new_password", - "user_identifier" - ] + "$ref": "#/components/schemas/ChangeUserPasswordRequest" } } }, @@ -13979,163 +9686,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the user. The username string must be unique.", - "type": "string" - }, - "display_name": { - "description": "A unique display name string for the user account, usually their first and last name", - "type": "string" - }, - "password": { - "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": { - "description": "Email of the user account", - "type": "string" - }, - "account_type": { - "description": "Type of the account.", - "default": "LOCAL_USER", - "type": "string", - "enum": [ - "LOCAL_USER", - "LDAP_USER", - "SAML_USER", - "OIDC_USER", - "REMOTE_USER" - ] - }, - "account_status": { - "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": [ - "ACTIVE", - "INACTIVE", - "EXPIRED", - "LOCKED", - "PENDING", - "SUSPENDED" - ] - }, - "org_identifiers": { - "description": "List of Org IDs to which the user belongs.", - "type": "array", - "items": { - "type": "string" - } - }, - "group_identifiers": { - "description": "GUIDs or names of the groups to which the newly created user belongs.", - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "description": "Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object.", - "default": "SHARABLE", - "type": "string", - "enum": [ - "SHARABLE", - "NON_SHARABLE" - ] - }, - "notify_on_share": { - "description": "User preference for receiving email notifications when another ThoughtSpot\nuser shares a metadata object such as Answer, Liveboard, or Worksheet.", - "default": true, - "type": "boolean", - "nullable": true - }, - "show_onboarding_experience": { - "description": "The user preference for revisiting the onboarding experience.", - "default": true, - "type": "boolean", - "nullable": true - }, - "onboarding_experience_completed": { - "description": "flag to get the on-boarding experience is completed or not.", - "default": false, - "type": "boolean", - "nullable": true - }, - "home_liveboard_identifier": { - "description": "GUID of the Liveboard to set a default Liveboard for the user.\nThoughtSpot displays this Liveboard on the Home page when the user logs in.", - "type": "string" - }, - "favorite_metadata": { - "description": "Metadata objects to add to the user's favorites list.", - "type": "array", - "items": { - "$ref": "#/components/schemas/FavoriteMetadataInput" - } - }, - "preferred_locale": { - "description": "Locale for the user. When setting this value, do not set use_browser_language\nto true, otherwise the browser's language setting will take precedence and the\npreferred_locale value will be ignored.", - "type": "string", - "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", - "de-CH", - "en-NZ", - "es-MX", - "en-AU", - "zh-Hant", - "ko-KR", - "en-DE" - ] - }, - "use_browser_language": { - "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", - "type": "boolean", - "nullable": true - }, - "extended_properties": { - "description": "Properties for the user", - "type": "object" - }, - "extended_preferences": { - "description": "Preferences for the user", - "type": "object" - }, - "trigger_welcome_email": { - "description": "Flag to indicate whether welcome email should be sent to user. This parameter is applied only on clusters on which IAM is disabled.", - "type": "boolean", - "nullable": true - }, - "trigger_activation_email": { - "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 - } - }, - "required": [ - "name", - "display_name", - "email" - ] + "$ref": "#/components/schemas/CreateUserRequest" } } }, @@ -14208,21 +9759,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "user_identifier": { - "description": "Unique ID or name of the user.", - "type": "string" - }, - "base_url": { - "description": "Base url of the cluster.", - "type": "string" - } - }, - "required": [ - "user_identifier", - "base_url" - ] + "$ref": "#/components/schemas/DeactivateUserRequest" } } }, @@ -14361,16 +9898,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "user_identifiers": { - "description": "GUID or name of the users for force logging out their sessions.", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/ForceLogoutUsersRequest" } } }, @@ -14436,35 +9964,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "users": { - "description": "List of users needs to be imported.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportUser" - } - }, - "default_password": { - "description": "The default password to assign to users if they do not have a password assigned in ThoughtSpot.", - "type": "string" - }, - "dry_run": { - "description": "If true, the API performs a test operation and returns user IDs whose data will be edited after the import.", - "default": true, - "type": "boolean", - "nullable": true - }, - "delete_unspecified_users": { - "description": "If set to true, removes the users that are not specified in the API request.", - "default": false, - "type": "boolean", - "nullable": true - } - }, - "required": [ - "users" - ] + "$ref": "#/components/schemas/ImportUsersRequest" } } }, @@ -14537,21 +10037,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "new_password": { - "description": "New password for the user.", - "type": "string" - }, - "user_identifier": { - "description": "GUID or name of the user.", - "type": "string" - } - }, - "required": [ - "new_password", - "user_identifier" - ] + "$ref": "#/components/schemas/ResetUserPasswordRequest" } } }, @@ -14617,187 +10103,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "user_identifier": { - "description": "GUID / name of the user to search", - "type": "string" - }, - "display_name": { - "description": "A unique display name string for the user account, usually their first and last name", - "type": "string" - }, - "name_pattern": { - "description": "A pattern to match case-insensitive name of the User object.", - "type": "string" - }, - "visibility": { - "description": "Visibility of the user", - "type": "string", - "enum": [ - "SHARABLE", - "NON_SHARABLE" - ] - }, - "email": { - "description": "Email of the user account", - "type": "string" - }, - "group_identifiers": { - "description": "GUID or name of the group to which the user belongs", - "type": "array", - "items": { - "type": "string" - } - }, - "privileges": { - "description": "Privileges assigned to the user", - "type": "array", - "items": { - "type": "string", - "enum": [ - "ADMINISTRATION", - "AUTHORING", - "USERDATAUPLOADING", - "DATADOWNLOADING", - "USERMANAGEMENT", - "DATAMANAGEMENT", - "SHAREWITHALL", - "JOBSCHEDULING", - "A3ANALYSIS", - "EXPERIMENTALFEATUREPRIVILEGE", - "BYPASSRLS", - "RANALYSIS", - "DEVELOPER", - "USER_ADMINISTRATION", - "GROUP_ADMINISTRATION", - "SYNCMANAGEMENT", - "CAN_CREATE_CATALOG", - "DISABLE_PINBOARD_CREATION", - "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE", - "APPLICATION_ADMINISTRATION", - "SYSTEM_INFO_ADMINISTRATION", - "ORG_ADMINISTRATION", - "ROLE_ADMINISTRATION", - "AUTHENTICATION_ADMINISTRATION", - "BILLING_INFO_ADMINISTRATION", - "CAN_MANAGE_CUSTOM_CALENDAR", - "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", - "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS", - "ALLOW_NON_EMBED_FULL_APP_ACCESS", - "CAN_ACCESS_ANALYST_STUDIO", - "CAN_MANAGE_ANALYST_STUDIO", - "PREVIEW_DOCUMENT_SEARCH", - "CAN_MODIFY_FOLDERS", - "CAN_MANAGE_VARIABLES", - "CAN_VIEW_FOLDERS", - "CAN_SETUP_VERSION_CONTROL", - "CAN_MANAGE_WEBHOOKS", - "CAN_DOWNLOAD_VISUALS", - "CAN_DOWNLOAD_DETAILED_DATA", - "CAN_USE_SPOTTER" - ] - } - }, - "account_type": { - "description": "Type of the account", - "type": "string", - "enum": [ - "LOCAL_USER", - "LDAP_USER", - "SAML_USER", - "OIDC_USER", - "REMOTE_USER" - ] - }, - "account_status": { - "description": "Current status of the user account.", - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE", - "EXPIRED", - "LOCKED", - "PENDING", - "SUSPENDED" - ] - }, - "notify_on_share": { - "description": "User preference for receiving email notifications when another ThoughtSpot user\nshares a metadata object such as Answer, Liveboard, or Worksheet.", - "type": "boolean", - "nullable": true - }, - "show_onboarding_experience": { - "description": "The user preference for revisiting the onboarding experience", - "type": "boolean", - "nullable": true - }, - "onboarding_experience_completed": { - "description": "Indicates if the user has completed the onboarding walkthrough", - "type": "boolean", - "nullable": true - }, - "org_identifiers": { - "description": "IDs or names of the Orgs to which the user belongs", - "type": "array", - "items": { - "type": "string" - } - }, - "home_liveboard_identifier": { - "description": "Unique ID or name of the user's home Liveboard.", - "type": "string" - }, - "favorite_metadata": { - "description": "Metadata objects which are assigned as favorites of the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/FavoriteMetadataInput" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included.", - "default": 10, - "type": "integer", - "format": "int32" - }, - "sort_options": { - "description": "Sort options.", - "allOf": [ - { - "$ref": "#/components/schemas/SortOptions" - } - ] - }, - "role_identifiers": { - "description": "Filters by the role assigned to the user.", - "type": "array", - "items": { - "type": "string" - } - }, - "include_favorite_metadata": { - "description": "Indicates if the user's favorite objects should be displayed.", - "default": false, - "type": "boolean", - "nullable": true - }, - "include_variable_values": { - "description": "Indicates if the user's formula variable values should be included in the response.", - "default": false, - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/SearchUsersRequest" } } }, @@ -14873,148 +10179,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the user. The username string must be unique.", - "type": "string" - }, - "display_name": { - "description": "A unique display name string for the user account, usually their first and last name", - "type": "string" - }, - "visibility": { - "description": "Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object.", - "type": "string", - "enum": [ - "SHARABLE", - "NON_SHARABLE" - ] - }, - "email": { - "description": "Email of the user account", - "type": "string" - }, - "account_status": { - "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", - "SUSPENDED" - ] - }, - "notify_on_share": { - "description": "User preference for receiving email notifications when another ThoughtSpot user\nshares a metadata object such as Answer, Liveboard, or Worksheet.", - "type": "boolean", - "nullable": true - }, - "show_onboarding_experience": { - "description": "The user preference for revisiting the onboarding experience.", - "type": "boolean", - "nullable": true - }, - "onboarding_experience_completed": { - "description": "Indicates if the user has completed the onboarding and allows turning off the onboarding walkthrough.", - "type": "boolean", - "nullable": true - }, - "account_type": { - "description": "Type of the account.", - "type": "string", - "enum": [ - "LOCAL_USER", - "LDAP_USER", - "SAML_USER", - "OIDC_USER", - "REMOTE_USER" - ] - }, - "group_identifiers": { - "description": "GUIDs or names of the groups.", - "type": "array", - "items": { - "type": "string" - } - }, - "home_liveboard_identifier": { - "description": "GUID of the Liveboard to set a default Liveboard for the user. ThoughtSpot displays\nthis Liveboard on the Home page when the user logs in.", - "type": "string" - }, - "favorite_metadata": { - "description": "Metadata objects to add to the user's favorites list.", - "type": "array", - "items": { - "$ref": "#/components/schemas/FavoriteMetadataInput" - } - }, - "org_identifiers": { - "description": "IDs of the Orgs.", - "type": "array", - "items": { - "type": "string" - } - }, - "operation": { - "description": "Type of update operation. Default operation type is REPLACE", - "default": "REPLACE", - "type": "string", - "enum": [ - "ADD", - "REMOVE", - "REPLACE" - ] - }, - "preferred_locale": { - "description": "Locale for the user. When setting this value, do not set use_browser_language\nto true, otherwise the browser's language setting will take precedence and the\npreferred_locale value will be ignored.", - "type": "string", - "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", - "de-CH", - "en-NZ", - "es-MX", - "en-AU", - "zh-Hant", - "ko-KR", - "en-DE" - ] - }, - "use_browser_language": { - "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", - "type": "boolean", - "nullable": true - }, - "extended_properties": { - "description": "Properties for the user", - "type": "object" - }, - "extended_preferences": { - "description": "Preferences for the user", - "type": "object" - } - } + "$ref": "#/components/schemas/UpdateUserRequest" } } }, @@ -15090,45 +10255,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "type": { - "description": "Type of variable", - "type": "string", - "enum": [ - "CONNECTION_PROPERTY", - "TABLE_MAPPING", - "CONNECTION_PROPERTY_PER_PRINCIPAL", - "FORMULA_VARIABLE" - ] - }, - "name": { - "description": "Name of the variable. This is unique across the cluster.", - "type": "string" - }, - "is_sensitive": { - "description": "If the variable contains sensitive values like passwords", - "default": false, - "type": "boolean", - "nullable": true - }, - "data_type": { - "description": "Variable Data Type, only for formula_variable type, leave empty for others
Version: 10.15.0.cl or later", - "type": "string", - "enum": [ - "VARCHAR", - "INT32", - "INT64", - "DOUBLE", - "DATE", - "DATE_TIME" - ] - } - }, - "required": [ - "type", - "name" - ] + "$ref": "#/components/schemas/CreateVariableRequest" } } }, @@ -15193,6 +10320,7 @@ "post": { "operationId": "deleteVariable", "description": "\nDelete a variable
Beta Version: 10.14.0.cl or later\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifier (ID or name)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable doesn't exist\n* The variable is being used by other objects \n\n\n\n#### Endpoint URL\n", + "deprecated": true, "tags": [ "Variable", "10.14.0.cl" @@ -15255,56 +10383,19 @@ } } }, - "/api/rest/2.0/template/variables/search": { + "/api/rest/2.0/template/variables/delete": { "post": { - "operationId": "searchVariables", - "description": "\nSearch variables
Beta Version: 10.14.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports searching variables by:\n* Variable identifier (ID or name)\n* Variable type\n* Name pattern (case-insensitive, supports % for wildcard)\n\nThe search results can be formatted in three ways:\n* METADATA - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n\nThe values can be filtered by scope:\n* org_identifier\n* principal_identifier\n* model_identifier\n\n\n\n\n#### Endpoint URL\n", + "operationId": "deleteVariables", + "description": "\nDelete variable(s)
Beta Version: 26.4.0.cl or later\n\nAllows deleting multiple variables from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifiers (IDs or names)\n\nThe operation will fail if:\n* The user lacks required permissions\n* Any of the variables don't exist\n* Any of the variables are being used by other objects\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", - "10.14.0.cl" + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "variable_details": { - "description": "Variable details", - "type": "array", - "items": { - "$ref": "#/components/schemas/VariableDetailInput" - } - }, - "value_scope": { - "description": "Array of scope filters", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueScopeInput" - } - }, - "record_offset": { - "description": "The starting record number from where the records should be included", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of records that should be included", - "default": 10, - "type": "integer", - "format": "int32" - }, - "response_content": { - "description": "Format in which we want the output", - "default": "METADATA", - "type": "string", - "enum": [ - "METADATA", - "METADATA_AND_VALUES" - ] - } - } + "$ref": "#/components/schemas/DeleteVariablesRequest" } } }, @@ -15312,18 +10403,8 @@ }, "parameters": [], "responses": { - "200": { - "description": "List of variables is successful.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Variable" - } - } - } - } + "204": { + "description": "Deletion of variable(s) is successful." }, "400": { "description": "Invalid request.", @@ -15368,28 +10449,19 @@ } } }, - "/api/rest/2.0/template/variables/{identifier}/update": { + "/api/rest/2.0/template/variables/{identifier}/update-values": { "post": { - "operationId": "updateVariable", - "description": "\nUpdate a variable's name
Beta Version: 10.14.0.cl or later\n\nAllows updating a variable's name in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows updating:\n* The variable name\n\n\n\n#### Endpoint URL\n", + "operationId": "putVariableValues", + "description": "\nUpdate values for a variable
Beta Version: 26.4.0.cl or later\n\nAllows updating values for a specific variable in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to the variable\n* Replacing existing values\n* Deleting values from the variable\n* Resetting all values\n\nWhen updating variable values, you need to specify:\n* The variable identifier (ID or name)\n* The values to add/replace/remove\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constraints for the given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", - "10.14.0.cl" + "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "New name of the variable.", - "type": "string" - } - }, - "required": [ - "name" - ] + "$ref": "#/components/schemas/PutVariableValuesRequest" } } }, @@ -15403,12 +10475,12 @@ "schema": { "type": "string" }, - "description": "Unique id or name of the variable to update." + "description": "Unique ID or name of the variable" } ], "responses": { "204": { - "description": "Variable name updated successfully." + "description": "Variable values updated successfully." }, "400": { "description": "Invalid request.", @@ -15453,10 +10525,10 @@ } } }, - "/api/rest/2.0/template/variables/update-values": { + "/api/rest/2.0/template/variables/search": { "post": { - "operationId": "updateVariableValues", - "description": "\nUpdate values for multiple variables
Beta Version: 10.14.0.cl or later\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to variables\n* Replacing existing values\n* Deleting values from variables\n\nWhen updating variable values, you need to specify:\n* The variable identifiers\n* The values to add/replace/remove for each variable\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constrains for a given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", + "operationId": "searchVariables", + "description": "\nSearch variables
Beta Version: 10.14.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports searching variables by:\n* Variable identifier (ID or name)\n* Variable type\n* Name pattern (case-insensitive, supports % for wildcard)\n\nThe search results can be formatted in three ways:\n* METADATA - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n\nThe values can be filtered by scope:\n* org_identifier\n* principal_identifier\n* model_identifier\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "10.14.0.cl" @@ -15465,27 +10537,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "variable_assignment": { - "description": "Array of variable assignment objects specifying the variable identifier, values to assign, and the operation type (ADD, REMOVE, REPLACE, or RESET) to perform on each variable.", - "type": "array", - "items": { - "$ref": "#/components/schemas/VariableUpdateAssignmentInput" - } - }, - "variable_value_scope": { - "description": "Array of scope objects defining where the variable values apply, including organization context, optional principal constraints (user or group), model reference for formula variables, and priority for conflict resolution.", - "type": "array", - "items": { - "$ref": "#/components/schemas/VariableUpdateScopeInput" - } - } - }, - "required": [ - "variable_assignment", - "variable_value_scope" - ] + "$ref": "#/components/schemas/SearchVariablesRequest" } } }, @@ -15493,8 +10545,18 @@ }, "parameters": [], "responses": { - "204": { - "description": "Variable values updated successfully." + "200": { + "description": "List of variables is successful.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Variable" + } + } + } + } }, "400": { "description": "Invalid request.", @@ -15539,62 +10601,38 @@ } } }, - "/api/rest/2.0/vcs/git/branches/commit": { + "/api/rest/2.0/template/variables/{identifier}/update": { "post": { - "operationId": "commitBranch", - "description": "\n Version: 9.2.0.cl or later\n\nCommits TML files of metadata objects to the Git branch configured on your instance.\n\nRequires at least edit access to objects used in the commit operation.\n\nBefore using this endpoint to push your commits:\n\n* Enable Git integration on your instance.\n* Make sure the Git repository and branch details are configured on your instance.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n", + "operationId": "updateVariable", + "description": "\nUpdate a variable's name
Beta Version: 10.14.0.cl or later\n\nAllows updating a variable's name in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows updating:\n* The variable name\n\n\n\n#### Endpoint URL\n", "tags": [ - "Version Control", - "9.2.0.cl" + "Variable", + "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetadataObject" - } - }, - "delete_aware": { - "description": "Delete the tml files from version control repo if it does not exist in the ThoughSpot instance", - "default": true, - "type": "boolean", - "nullable": true - }, - "branch_name": { - "description": " Name of the remote branch where object should be pushed\n \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered.", - "type": "string" - }, - "comment": { - "description": "Comment to be added to the commit", - "type": "string" - } - }, - "required": [ - "metadata", - "comment" - ] + "$ref": "#/components/schemas/UpdateVariableRequest" } } }, "required": true }, - "parameters": [], + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique id or name of the variable to update." + } + ], "responses": { - "200": { - "description": "Successfully committed the metadata objects", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommitResponse" - } - } - } + "204": { + "description": "Variable name updated successfully." }, "400": { "description": "Invalid request.", @@ -15639,63 +10677,20 @@ } } }, - "/api/rest/2.0/vcs/git/config/create": { + "/api/rest/2.0/template/variables/update-values": { "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\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) 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 / itHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n", + "operationId": "updateVariableValues", + "description": "\nUpdate values for multiple variables
Beta Version: 10.14.0.cl or later\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to variables\n* Replacing existing values\n* Deleting values from variables\n\nWhen updating variable values, you need to specify:\n* The variable identifiers\n* The values to add/replace/remove for each variable\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constrains for a given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", + "deprecated": true, "tags": [ - "Version Control", - "9.2.0.cl" + "Variable", + "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "repository_url": { - "description": "URL for connecting to remote repository", - "type": "string" - }, - "username": { - "description": "Username to authenticate connection to remote repository", - "type": "string" - }, - "access_token": { - "description": "Access token corresponding to the user to authenticate connection to remote repository", - "type": "string" - }, - "org_identifier": { - "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", - "type": "string" - }, - "branch_names": { - "description": "List the remote branches to configure. Example:[development, production]", - "type": "array", - "items": { - "type": "string" - } - }, - "commit_branch_name": { - "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.
Version: 9.7.0.cl or later", - "type": "string" - }, - "enable_guid_mapping": { - "description": "Maintain mapping of guid for the deployment to an instance
Version: 9.4.0.cl or later", - "default": true, - "type": "boolean", - "nullable": true - }, - "configuration_branch_name": { - "description": " Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.\n \n\nNote: If no branch name is specified, then by default, ts_config_files branch is considered. Ensure this branch exists before configuration.
Version: 9.7.0.cl or later", - "type": "string" - } - }, - "required": [ - "repository_url", - "username", - "access_token" - ] + "$ref": "#/components/schemas/UpdateVariableValuesRequest" } } }, @@ -15703,15 +10698,8 @@ }, "parameters": [], "responses": { - "200": { - "description": "Successfully configured local repository", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RepoConfigObject" - } - } - } + "204": { + "description": "Variable values updated successfully." }, "400": { "description": "Invalid request.", @@ -15756,10 +10744,10 @@ } } }, - "/api/rest/2.0/vcs/git/config/delete": { + "/api/rest/2.0/vcs/git/branches/commit": { "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\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n", + "operationId": "commitBranch", + "description": "\n Version: 9.2.0.cl or later\n\nCommits TML files of metadata objects to the Git branch configured on your instance.\n\nRequires at least edit access to objects used in the commit operation.\n\nBefore using this endpoint to push your commits:\n\n* Enable Git integration on your instance.\n* Make sure the Git repository and branch details are configured on your instance.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" @@ -15768,14 +10756,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "cluster_level": { - "description": " Applicable when Orgs is enabled in the cluster\n \n\nIndicator to consider cluster level or org level config. Set it to false to delete configuration from current org. If set to true, then the configuration at cluster level and orgs that inherited the configuration from cluster level will be deleted.
Version: 9.5.0.cl or later", - "type": "boolean", - "nullable": true - } - } + "$ref": "#/components/schemas/CommitBranchRequest" } } }, @@ -15783,15 +10764,161 @@ }, "parameters": [], "responses": { - "204": { - "description": "Successfully deleted local repository configuration" - }, - "400": { - "description": "Invalid request.", + "200": { + "description": "Successfully committed the metadata objects", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CommitResponse" + } + } + } + }, + "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/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\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) 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 / itHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Version Control", + "9.2.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConfigRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Successfully configured local repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepoConfigObject" + } + } + } + }, + "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/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\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Version Control", + "9.2.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteConfigRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "204": { + "description": "Successfully deleted local repository configuration" + }, + "400": { + "description": "Invalid request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -15841,39 +10968,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "commit_id": { - "description": " Commit_id against which the files should be picked to deploy.\n \n\nNote: If no commit_id is specified, then the head of the branch is considered.", - "type": "string" - }, - "branch_name": { - "description": "Name of the remote branch where changes should be picked", - "type": "string" - }, - "deploy_type": { - "description": "Indicates if all files or only modified file at specified commit point should be considered", - "default": "DELTA", - "type": "string", - "enum": [ - "FULL", - "DELTA" - ] - }, - "deploy_policy": { - "description": "Define the policy to follow while importing TML in the ThoughtSpot environment. Use “ALL_OR_NONE” to cancel the deployment of all ThoughtSpot objects if at least one of them fails to import. Use “Partial” to import ThoughtSpot objects that validate successfully even if other objects in the same deploy operations fail to import.", - "default": "ALL_OR_NONE", - "type": "string", - "enum": [ - "ALL_OR_NONE", - "PARTIAL", - "VALIDATE_ONLY" - ] - } - }, - "required": [ - "branch_name" - ] + "$ref": "#/components/schemas/DeployCommitRequest" } } }, @@ -15949,29 +11044,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "description": "Metadata objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetadataObject" - } - }, - "branch_name": { - "description": " Name of the branch where the reverted version should be committed\n \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered.", - "type": "string" - }, - "revert_policy": { - "description": "Policy to apply when reverting a commit. Valid values: [ALL_OR_NONE, PARTIAL]", - "default": "ALL_OR_NONE", - "type": "string", - "enum": [ - "ALL_OR_NONE", - "PARTIAL" - ] - } - } + "$ref": "#/components/schemas/RevertCommitRequest" } } }, @@ -16054,40 +11127,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata_identifier": { - "description": "Unique ID or name of the metadata.", - "type": "string" - }, - "metadata_type": { - "description": "Type of metadata.", - "type": "string", - "enum": [ - "LIVEBOARD", - "ANSWER", - "LOGICAL_TABLE", - "CUSTOM_ACTION" - ] - }, - "branch_name": { - "description": " Name of the branch from which commit history needs to be displayed.\n \n\nNote: If no branch_name is specified, then commits will be returned for the default branch for this configuration.", - "type": "string" - }, - "record_offset": { - "description": " Record offset point in the commit history to display the response.\n \n\nNote: If no record offset is specified, the beginning of the record will be considered.", - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": " Number of history records from record offset point to be displayed in the response.\n \n\nNote: If no record size is specified, then all the records will be considered.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "metadata_identifier" - ] + "$ref": "#/components/schemas/SearchCommitsRequest" } } }, @@ -16163,16 +11203,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "org_identifiers": { - "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/SearchConfigRequest" } } }, @@ -16248,41 +11279,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "username": { - "description": "Username to authenticate connection to version control system", - "type": "string" - }, - "access_token": { - "description": "Access token corresponding to the user to authenticate connection to version control system", - "type": "string" - }, - "org_identifier": { - "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", - "type": "string" - }, - "branch_names": { - "description": "List the remote branches to configure. Example:[development, production]", - "type": "array", - "items": { - "type": "string" - } - }, - "commit_branch_name": { - "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.
Version: 9.7.0.cl or later", - "type": "string" - }, - "enable_guid_mapping": { - "description": "Maintain mapping of guid for the deployment to an instance
Version: 9.4.0.cl or later", - "type": "boolean", - "nullable": true - }, - "configuration_branch_name": { - "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.
Version: 9.7.0.cl or later", - "type": "string" - } - } + "$ref": "#/components/schemas/UpdateConfigRequest" } } }, @@ -16355,21 +11352,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "source_branch_name": { - "description": "Name of the branch from which changes need to be picked for validation", - "type": "string" - }, - "target_branch_name": { - "description": "Name of the branch where files will be merged", - "type": "string" - } - }, - "required": [ - "source_branch_name", - "target_branch_name" - ] + "$ref": "#/components/schemas/ValidateMergeRequest" } } }, @@ -16445,64 +11428,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the webhook configuration.", - "type": "string" - }, - "description": { - "description": "Description of the webhook configuration.", - "type": "string" - }, - "url": { - "description": "The webhook endpoint URL.", - "type": "string" - }, - "url_params": { - "description": "Additional URL parameters as key-value pairs.", - "type": "object" - }, - "events": { - "description": "List of events to subscribe to.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "LIVEBOARD_SCHEDULE" - ] - } - }, - "authentication": { - "description": "Authorization configuration for the webhook.", - "allOf": [ - { - "$ref": "#/components/schemas/WebhookAuthenticationInput" - } - ] - }, - "signature_verification": { - "description": "Configuration for webhook signature verification.", - "allOf": [ - { - "$ref": "#/components/schemas/WebhookSignatureVerificationInput" - } - ] - }, - "storage_destination": { - "description": "Configuration for storage destination.\nExample: {\"storage_type\": \"AWS_S3\", \"storage_config\": {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"thoughtspot-webhooks/\"}}}
Version: 26.3.0.cl or later", - "allOf": [ - { - "$ref": "#/components/schemas/StorageDestinationInput" - } - ] - } - }, - "required": [ - "name", - "url", - "events" - ] + "$ref": "#/components/schemas/CreateWebhookConfigurationRequest" } } }, @@ -16545,8 +11471,18 @@ "algorithm": "SHA256", "secret": "***" }, - "created_at": "2025-08-21T21:57:10.243089030Z", - "last_modified_at": "2025-08-21T21:57:10.243089030Z", + "creation_time_in_millis": 1724277430243, + "modification_time_in_millis": 1724277430243, + "additional_headers": [ + { + "key": "Custom-Header", + "value": "value1" + }, + { + "key": "Custom-Header-2", + "value": "value2" + } + ], "created_by": { "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b", "name": "sarah_chen" @@ -16578,8 +11514,8 @@ "client_secret": "***" } }, - "created_at": "2025-08-21T22:15:30.123456789Z", - "last_modified_at": "2025-08-21T22:15:30.123456789Z", + "creation_time_in_millis": 1724278530123, + "modification_time_in_millis": 1724278530123, "created_by": { "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d", "name": "mike_rodriguez" @@ -16645,19 +11581,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "webhook_identifiers": { - "description": "List of webhook identifiers to delete.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "webhook_identifiers" - ] + "$ref": "#/components/schemas/DeleteWebhookConfigurationsRequest" } } }, @@ -16694,8 +11618,8 @@ "authentication": { "BEARER_TOKEN": "***" }, - "created_at": "2025-08-21T15:30:00.000000000Z", - "last_modified_at": "2025-08-21T15:30:00.000000000Z", + "creation_time_in_millis": 1724274600000, + "modification_time_in_millis": 1724274600000, "created_by": { "id": "1f4e7b2d-9c3a-4e6f-8b1d-3e7c5a9b2f4e", "name": "jennifer_patel" @@ -16719,8 +11643,8 @@ "value": "***" } }, - "created_at": "2025-08-21T16:45:30.123456789Z", - "last_modified_at": "2025-08-21T16:45:30.123456789Z", + "creation_time_in_millis": 1724275530123, + "modification_time_in_millis": 1724275530123, "created_by": { "id": "9a5c2e8f-4b7d-4c1e-9f2a-6c8e3b5d7a4c", "name": "david_thompson" @@ -16751,8 +11675,8 @@ "authentication": { "NO_AUTH": "" }, - "created_at": "2025-08-21T18:20:15.456789012Z", - "last_modified_at": "2025-08-21T18:20:15.456789012Z", + "creation_time_in_millis": 1724276415456, + "modification_time_in_millis": 1724276415456, "created_by": { "id": "6e9c4f2a-8b5d-4e1f-9c3a-5f8b2e7d4a6c", "name": "emma_wang" @@ -16815,6 +11739,149 @@ } } }, + "/api/rest/2.0/webhooks/{webhook_identifier}/storage-config": { + "get": { + "operationId": "getWebhookStorageConfig", + "description": "\nBeta Version: 26.4.0.cl or later\n\nGet storage config information for a webhook configuration. This endpoint provides ThoughtSpot's identity information and IAM policy configuration required for customers to set up cross-account access to their S3 buckets.\n\nThe setup info returned depends on the ThoughtSpot cluster type:\n- For AWS clusters: Returns `aws_config` with STS AssumeRole configuration\n- For GCP clusters: Returns `gcp_config` with STS AssumeRoleWithWebIdentity configuration\n\n**Note:** This endpoint only returns data if the webhook has a storage destination configured.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Webhooks", + "26.4.0.cl" + ], + "parameters": [ + { + "in": "path", + "name": "webhook_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the webhook configuration." + } + ], + "responses": { + "200": { + "description": "Storage setup information retrieved successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StorageSetupInfo" + }, + "examples": { + "example_1": { + "description": "Storage setup info for AWS cluster deployment", + "value": { + "cluster_type": "AWS", + "storage_type": "AWS_S3", + "aws_config": { + "thoughtspot_aws_account_id": "123456789012", + "trust_policy_template": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::123456789012:root" + }, + "Action": "sts:AssumeRole", + "Condition": { + "StringEquals": { + "sts:ExternalId": "ts-webhook-a1b2c3d4-7890" + } + } + } + ] + }, + "setup_instructions": [ + "1. Create an IAM role in your AWS account", + "2. Copy the trust policy template and attach it to your role", + "3. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", + "4. Use the role ARN in your webhook storage configuration" + ] + } + } + }, + "example_2": { + "description": "Storage setup info for GCP cluster deployment", + "value": { + "cluster_type": "GCP", + "storage_type": "AWS_S3", + "gcp_config": { + "thoughtspot_gcp_service_account_id": "115663769112811637952", + "oidc_provider": "accounts.google.com", + "trust_policy_template": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "Federated": "arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com" + }, + "Action": "sts:AssumeRoleWithWebIdentity", + "Condition": { + "StringEquals": { + "accounts.google.com:sub": "115663769112811637952" + } + } + } + ] + }, + "setup_instructions": [ + "1. Add accounts.google.com as an Identity Provider in AWS IAM", + "2. Create an IAM role with Web Identity Federation trust", + "3. Configure the trust policy with ThoughtSpot's GCP service account ID", + "4. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", + "5. Use the role ARN in your webhook storage configuration" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request. Webhook not found or does not have storage destination configured.", + "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/webhooks/search": { "post": { "operationId": "searchWebhookConfigurations", @@ -16827,44 +11894,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "org_identifier": { - "description": "Unique ID or name of the org.", - "type": "string" - }, - "webhook_identifier": { - "description": "Unique ID or name of the webhook.", - "type": "string" - }, - "event_type": { - "description": "Type of webhook event to filter by.", - "type": "string", - "enum": [ - "LIVEBOARD_SCHEDULE" - ] - }, - "record_offset": { - "description": "The offset point, starting from where the webhooks should be included in the response.", - "default": 0, - "type": "integer", - "format": "int32" - }, - "record_size": { - "description": "The number of webhooks that should be included in the response starting from offset position.", - "default": 50, - "type": "integer", - "format": "int32" - }, - "sort_options": { - "description": "Sort option includes sort field and sort order.", - "allOf": [ - { - "$ref": "#/components/schemas/WebhookSortOptionsInput" - } - ] - } - } + "$ref": "#/components/schemas/SearchWebhookConfigurationsRequest" } } }, @@ -16908,8 +11938,18 @@ "algorithm": "SHA256", "secret": "***" }, - "created_at": "2025-08-21T21:57:10.243089030Z", - "last_modified_at": "2025-08-21T22:10:15.123456789Z", + "creation_time_in_millis": 1724277430243, + "modification_time_in_millis": 1724278215123, + "additional_headers": [ + { + "key": "Custom-Header", + "value": "value1" + }, + { + "key": "Custom-Header-2", + "value": "value2" + } + ], "created_by": { "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b", "name": "sarah_chen" @@ -16937,8 +11977,8 @@ "value": "***" } }, - "created_at": "2025-08-21T20:30:45.987654321Z", - "last_modified_at": "2025-08-21T20:30:45.987654321Z", + "creation_time_in_millis": 1724275845987, + "modification_time_in_millis": 1724275845987, "created_by": { "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d", "name": "mike_rodriguez" @@ -17024,59 +12064,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the webhook configuration.", - "type": "string" - }, - "description": { - "description": "Description of the webhook configuration.", - "type": "string" - }, - "url": { - "description": "The webhook endpoint URL.", - "type": "string" - }, - "url_params": { - "description": "Additional URL parameters as key-value pairs.", - "type": "object" - }, - "events": { - "description": "List of events to subscribe to.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "LIVEBOARD_SCHEDULE" - ] - } - }, - "authentication": { - "description": "Authorization configuration for the webhook.", - "allOf": [ - { - "$ref": "#/components/schemas/WebhookAuthenticationInput" - } - ] - }, - "signature_verification": { - "description": "Configuration for webhook signature verification.", - "allOf": [ - { - "$ref": "#/components/schemas/WebhookSignatureVerificationInput" - } - ] - }, - "storage_destination": { - "description": "Configuration for storage destination.\nExample: {\"storage_type\": \"AWS_S3\", \"storage_config\": {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"thoughtspot-webhooks/\"}}}
Version: 26.3.0.cl or later", - "allOf": [ - { - "$ref": "#/components/schemas/StorageDestinationInput" - } - ] - } - } + "$ref": "#/components/schemas/UpdateWebhookConfigurationRequest" } } }, @@ -20761,7 +15749,8 @@ "CONNECTION_PROPERTY", "TABLE_MAPPING", "CONNECTION_PROPERTY_PER_PRINCIPAL", - "FORMULA_VARIABLE" + "FORMULA_VARIABLE", + "USER_PROPERTY" ], "description": "Type of variable", "nullable": true @@ -20825,7 +15814,8 @@ "CONNECTION_PROPERTY", "TABLE_MAPPING", "CONNECTION_PROPERTY_PER_PRINCIPAL", - "FORMULA_VARIABLE" + "FORMULA_VARIABLE", + "USER_PROPERTY" ], "description": "Type of the variable", "nullable": true @@ -21194,6 +16184,14 @@ "description": "Redacted configuration for webhook signature verification.", "nullable": true }, + "additional_headers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookKeyValuePair" + }, + "description": "Additional headers as an array of key-value pairs.
Version: 26.4.0.cl or later", + "nullable": true + }, "creation_time_in_millis": { "type": "number", "format": "float", @@ -21352,6 +16350,24 @@ } } }, + "WebhookKeyValuePair": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "description": "Key-value pair for additional webhook headers." + }, "WebhookUser": { "type": "object", "required": [ @@ -21464,84 +16480,460 @@ } } }, - "GenericInfo": { + "StorageSetupInfo": { "type": "object", + "required": [ + "cluster_type", + "storage_type" + ], "properties": { - "id": { + "cluster_type": { "type": "string", - "nullable": true + "enum": [ + "AWS", + "GCP" + ], + "description": "The type of ThoughtSpot cluster deployment.\nDetermines which authentication method is used for S3 access.\nExample: \"AWS\" or \"GCP\"" }, - "name": { + "storage_type": { "type": "string", + "enum": [ + "AWS_S3" + ], + "description": "Type of storage destination (e.g., AWS_S3)." + }, + "aws_config": { + "$ref": "#/components/schemas/AWSAssumeRoleSetup", + "description": "Setup info for AWS clusters using STS AssumeRole.\nOnly populated when cluster_type is AWS.", + "nullable": true + }, + "gcp_config": { + "$ref": "#/components/schemas/GCPWebIdentitySetup", + "description": "Setup info for GCP clusters using STS AssumeRoleWithWebIdentity.\nOnly populated when cluster_type is GCP.", "nullable": true } - } + }, + "description": "Setup information for customer-managed storage configuration.\nProvides ThoughtSpot's identity information and IAM policy configuration\nrequired for customers to set up cross-account access to their S3 buckets.\nThe response contains cluster-specific configuration based on the cluster_type:\n- For AWS clusters: aws_config will be populated\n- For GCP clusters: gcp_config will be populated\nExample query:\n```graphql\nquery {\n getWebhookStorageConfig(webhook_identifier: \"my-webhook\") {\n cluster_type\n storage_type\n aws_config {\n thoughtspot_aws_account_id\n trust_policy_template\n setup_instructions\n }\n gcp_config {\n thoughtspot_gcp_service_account_id\n oidc_provider\n trust_policy_template\n setup_instructions\n }\n }\n}\n```\nExample AWS response:\n{\n \"cluster_type\": \"AWS\",\n \"storage_type\": \"AWS_S3\",\n \"aws_config\": {\n \"thoughtspot_aws_account_id\": \"123456789012\",\n \"trust_policy_template\": { \"Version\": \"2012-10-17\", \"Statement\": [...] },\n \"setup_instructions\": [\"1. Create an IAM role...\", \"2. Add trust policy...\"]\n },\n \"gcp_config\": null\n}\nExample GCP response:\n{\n \"cluster_type\": \"GCP\",\n \"storage_type\": \"AWS_S3\",\n \"aws_config\": null,\n \"gcp_config\": {\n \"thoughtspot_gcp_service_account_id\": \"115663769112811637952\",\n \"oidc_provider\": \"accounts.google.com\",\n \"trust_policy_template\": { \"Version\": \"2012-10-17\", \"Statement\": [...] },\n \"setup_instructions\": [\"1. Add accounts.google.com as Identity Provider...\"]\n }\n}" }, - "UserGroup": { + "AWSAssumeRoleSetup": { "type": "object", + "required": [ + "thoughtspot_aws_account_id", + "trust_policy_template" + ], "properties": { - "id": { + "thoughtspot_aws_account_id": { "type": "string", - "nullable": true + "description": "ThoughtSpot's AWS Account ID. You must include this in your IAM role's\ntrust policy to allow ThoughtSpot to assume your role.\nExample: \"123456789012\"" }, - "name": { - "type": "string", + "trust_policy_template": { + "type": "object", + "description": "Sample IAM trust policy JSON object that you should attach to your IAM role.\nThe policy includes ThoughtSpot's AWS Account ID and your External ID.\nExample: { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::123456789012:root\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"your-external-id\" } } }] }" + }, + "setup_instructions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Step-by-step instructions to configure your AWS IAM role.\nExample: [\"1. Create an IAM role in your AWS account\", \"2. Add the trust policy with ThoughtSpot's AWS Account ID\"]", "nullable": true } - } + }, + "description": "Setup information for AWS clusters using STS AssumeRole.\nThoughtSpot will use its AWS IAM role to assume your role in your AWS account.\nExample:\n{\n \"thoughtspot_aws_account_id\": \"123456789012\",\n \"trust_policy_template\": {\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Effect\": \"Allow\",\n \"Principal\": { \"AWS\": \"arn:aws:iam::123456789012:root\" },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"your-external-id\" } }\n }]\n },\n \"setup_instructions\": [\n \"1. Create an IAM role in your AWS account\",\n \"2. Copy the trust policy template and attach it to your role\",\n \"3. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role\",\n \"4. Use the role ARN in your webhook storage configuration\"\n ]\n}" }, - "JWT_User_Options": { + "GCPWebIdentitySetup": { "type": "object", + "required": [ + "thoughtspot_gcp_service_account_id", + "trust_policy_template" + ], "properties": { - "parameters": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/Runtime_Filter" - }, - { - "$ref": "#/components/schemas/Runtime_Sort" - }, - { - "$ref": "#/components/schemas/Runtime_Param_Override" - } - ] - } + "thoughtspot_gcp_service_account_id": { + "type": "string", + "description": "ThoughtSpot's GCP service account unique ID (numeric).\nThis is the 'sub' claim in OIDC tokens and must be included in your\nIAM role's trust policy condition.\nExample: \"115663769112811637952\"" }, - "metadata": { + "oidc_provider": { + "type": "string", + "description": "The OIDC identity provider URL. For GCP, this is always 'accounts.google.com'.\nYou must configure this as an Identity Provider in AWS IAM.\nExample: \"accounts.google.com\"", + "nullable": true + }, + "trust_policy_template": { + "type": "object", + "description": "Sample IAM trust policy JSON object for Web Identity Federation.\nThis policy allows ThoughtSpot's GCP service account to assume your AWS role.\nExample: { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Allow\", \"Principal\": { \"Federated\": \"arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com\" }, \"Action\": \"sts:AssumeRoleWithWebIdentity\", \"Condition\": { \"StringEquals\": { \"accounts.google.com:sub\": \"115663769112811637952\" } } }] }" + }, + "setup_instructions": { "type": "array", "items": { - "$ref": "#/components/schemas/JWT_Metadata_Object" + "type": "string" }, + "description": "Step-by-step instructions to configure AWS for GCP Web Identity Federation.\nExample: [\"1. Add accounts.google.com as an Identity Provider in AWS IAM\", \"2. Create an IAM role with Web Identity Federation trust\"]", "nullable": true } }, - "description": "JWT user options to create a JWT token given the payload.\n\n\n*Deprecated in 9.12.0.cl. Use user_parameters instead.*" + "description": "Setup information for GCP clusters using STS AssumeRoleWithWebIdentity.\nThoughtSpot will use its GCP service account to obtain OIDC tokens for AWS access.\nExample:\n{\n \"thoughtspot_gcp_service_account_id\": \"115663769112811637952\",\n \"oidc_provider\": \"accounts.google.com\",\n \"trust_policy_template\": {\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Effect\": \"Allow\",\n \"Principal\": { \"Federated\": \"arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com\" },\n \"Action\": \"sts:AssumeRoleWithWebIdentity\",\n \"Condition\": { \"StringEquals\": { \"accounts.google.com:sub\": \"115663769112811637952\" } }\n }]\n },\n \"setup_instructions\": [\n \"1. Add accounts.google.com as an Identity Provider in AWS IAM\",\n \"2. Create an IAM role with Web Identity Federation trust\",\n \"3. Configure the trust policy with ThoughtSpot's GCP service account ID\",\n \"4. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role\",\n \"5. Use the role ARN in your webhook storage configuration\"\n ]\n}" }, - "JWT_Parameter": { + "CollectionSearchResponse": { "type": "object", + "required": [ + "collections" + ], "properties": { - "runtime_filter": { - "type": "object", - "description": "Runtime filter parameter type in JWT.", + "collections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Collection" + }, + "description": "List of collections matching the search criteria." + }, + "record_offset": { + "type": "integer", + "format": "int32", + "description": "The starting record number from where the records are included.", "nullable": true }, - "runtime_sort": { - "type": "object", - "description": "Runtime sort parameter type in JWT.", + "record_size": { + "type": "integer", + "format": "int32", + "description": "The number of records returned.", "nullable": true }, - "runtime_param_override": { - "type": "object", - "description": "Runtime param override type in JWT.", + "is_last_batch": { + "type": "boolean", + "description": "Indicates if this is the last batch of results.", + "nullable": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Total count of records returned.", "nullable": true } }, - "description": "List of runtime parameters need to set during the session." + "description": "Response object for search collections operation." }, - "JWT_Metadata_Object": { + "Collection": { "type": "object", - "properties": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the collection." + }, + "name": { + "type": "string", + "description": "Name of the collection." + }, + "description": { + "type": "string", + "description": "Description of the collection.", + "nullable": true + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionMetadataItem" + }, + "description": "Metadata objects in the collection.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "Creation timestamp in milliseconds.", + "nullable": true + }, + "updated_at": { + "type": "string", + "description": "Last updated timestamp in milliseconds.", + "nullable": true + }, + "author_name": { + "type": "string", + "description": "Name of the author who created the collection.", + "nullable": true + }, + "author_id": { + "type": "string", + "description": "Unique identifier of the author.", + "nullable": true + }, + "org": { + "$ref": "#/components/schemas/CollectionEntityIdentifier", + "description": "Org associated with the collection.", + "nullable": true + } + }, + "description": "Response object for a collection." + }, + "CollectionMetadataItem": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the metadata object.", + "nullable": true + }, + "identifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionEntityIdentifier" + }, + "description": "List of identifiers for this metadata type.", + "nullable": true + } + }, + "description": "Metadata item in a collection response." + }, + "CollectionEntityIdentifier": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "description": "Unique identifier of the entity.", + "nullable": true + }, + "name": { + "type": "string", + "description": "Name of the entity.", + "nullable": true + } + }, + "description": "Entity identifier with name." + }, + "ChannelHistoryEventInput": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ], + "description": "Type of the event." + }, + "identifier": { + "type": "string", + "description": "Unique ID or name of the event.", + "nullable": true + } + }, + "description": "Event specification for channel history search." + }, + "SearchChannelHistoryResponse": { + "type": "object", + "required": [ + "jobs" + ], + "properties": { + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChannelHistoryJob" + }, + "description": "List of job execution records." + } + }, + "description": "Response wrapper for channel delivery history." + }, + "ChannelHistoryJob": { + "type": "object", + "required": [ + "id", + "status", + "creation_time_in_millis" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for this job." + }, + "status": { + "type": "string", + "enum": [ + "PENDING", + "RETRY", + "SUCCESS", + "FAILED" + ], + "description": "Delivery status of this job." + }, + "creation_time_in_millis": { + "type": "number", + "format": "float", + "description": "Timestamp when this job was created (epoch milliseconds)." + }, + "event": { + "$ref": "#/components/schemas/ChannelHistoryEventInfo", + "description": "Event metadata for the triggering event associated with this job.", + "nullable": true + }, + "recipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobRecipient" + }, + "description": "The users, groups or external recipients for this job.", + "nullable": true + }, + "detail": { + "type": "string", + "description": "Additional delivery details such as HTTP response code or error message.", + "nullable": true + }, + "try_count": { + "type": "integer", + "format": "int32", + "description": "Number of attempts made. 1 indicates first attempt.", + "nullable": true + } + }, + "description": "A single job execution record for a channel." + }, + "ChannelHistoryEventInfo": { + "type": "object", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ], + "description": "Type of the event." + }, + "id": { + "type": "string", + "description": "Unique ID of the event." + }, + "name": { + "type": "string", + "description": "Name of the event.", + "nullable": true + }, + "run_id": { + "type": "string", + "description": "Unique run ID for this event execution.", + "nullable": true + } + }, + "description": "Event metadata for the triggering event associated with a job." + }, + "JobRecipient": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "USER", + "EXTERNAL" + ], + "description": "Type of the recipient." + }, + "id": { + "type": "string", + "description": "Unique ID of the recipient.", + "nullable": true + }, + "name": { + "type": "string", + "description": "Name of the recipient.", + "nullable": true + }, + "email": { + "type": "string", + "description": "Email of the recipient.", + "nullable": true + } + }, + "description": "A recipient (user, group, or external) for a job execution." + }, + "GenericInfo": { + "type": "object", + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + } + } + }, + "UserGroup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + } + } + }, + "JWT_User_Options": { + "type": "object", + "properties": { + "parameters": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/Runtime_Filter" + }, + { + "$ref": "#/components/schemas/Runtime_Sort" + }, + { + "$ref": "#/components/schemas/Runtime_Param_Override" + } + ] + } + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JWT_Metadata_Object" + }, + "nullable": true + } + }, + "description": "JWT user options to create a JWT token given the payload.\n\n\n*Deprecated in 9.12.0.cl. Use user_parameters instead.*" + }, + "JWT_Parameter": { + "type": "object", + "properties": { + "runtime_filter": { + "type": "object", + "description": "Runtime filter parameter type in JWT.", + "nullable": true + }, + "runtime_sort": { + "type": "object", + "description": "Runtime sort parameter type in JWT.", + "nullable": true + }, + "runtime_param_override": { + "type": "object", + "description": "Runtime param override type in JWT.", + "nullable": true + } + }, + "description": "List of runtime parameters need to set during the session." + }, + "JWT_Metadata_Object": { + "type": "object", + "properties": { "identifier": { "type": "string", "nullable": true @@ -22519,6 +17911,126 @@ }, "description": "Input for org-level non-embed access configuration." }, + "CommunicationChannelValidateResponse": { + "type": "object", + "required": [ + "channel_type", + "channel_id", + "event_type", + "job_id", + "result_code" + ], + "properties": { + "channel_type": { + "type": "string", + "enum": [ + "WEBHOOK" + ], + "description": "Type of communication channel that was validated." + }, + "channel_id": { + "type": "string", + "description": "ID of the communication channel (e.g., webhook_id)." + }, + "channel_name": { + "type": "string", + "description": "Name of the communication channel (e.g., webhook name).", + "nullable": true + }, + "event_type": { + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ], + "description": "Event type that was validated." + }, + "job_id": { + "type": "string", + "description": "Unique Job Id of the validation." + }, + "result_code": { + "type": "string", + "enum": [ + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS" + ], + "description": "Overall result of the validation." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChannelValidationDetail" + }, + "description": "Detailed results of various validation sub-steps.", + "nullable": true + } + }, + "description": "Response containing validation results for communication channel configuration." + }, + "ChannelValidationDetail": { + "type": "object", + "required": [ + "validation_step", + "status" + ], + "properties": { + "validation_step": { + "type": "string", + "enum": [ + "HTTP_CONNECTION_CHECK", + "STORAGE_FILE_UPLOAD_CHECK" + ], + "description": "The validation step that was performed." + }, + "status": { + "type": "string", + "enum": [ + "SUCCESS", + "FAILED" + ], + "description": "Status of this validation step." + }, + "http_status": { + "type": "integer", + "format": "int32", + "description": "HTTP status code returned by the channel (if applicable).", + "nullable": true + }, + "error_message": { + "type": "string", + "description": "Error message from the channel or validation process.", + "nullable": true + }, + "aws_s3_info": { + "$ref": "#/components/schemas/ChannelValidationAwsS3Info", + "description": "AWS S3 storage information from the validation step.", + "nullable": true + } + }, + "description": "Validation detail result for a sub-step." + }, + "ChannelValidationAwsS3Info": { + "type": "object", + "properties": { + "bucket_name": { + "type": "string", + "description": "Name of the S3 bucket.", + "nullable": true + }, + "file_name": { + "type": "string", + "description": "Name of the uploaded file.", + "nullable": true + }, + "object_key": { + "type": "string", + "description": "Key of the object in S3 storage.", + "nullable": true + } + }, + "description": "AWS S3 storage information returned from a validation step." + }, "TagMetadataTypeInput": { "type": "object", "required": [ @@ -22700,7 +18212,7 @@ }, "include_obj_id": { "type": "boolean", - "default": false, + "default": true, "description": "Boolean flag to export Object ID of the object. This flag will work only after the Object ID feature has been enabled. Please contact support to enable the feature.", "nullable": true }, @@ -23527,6 +19039,51 @@ } } }, + "SyncMetadataResponse": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "SUCCESS", + "PARTIAL_SUCCESS", + "NO_UPDATE" + ], + "description": "Overall status of the sync operation.", + "nullable": true + }, + "tables_updated": { + "type": "integer", + "format": "int32", + "description": "Number of tables with metadata updates.", + "nullable": true + }, + "columns_updated": { + "type": "integer", + "format": "int32", + "description": "Number of columns with metadata updates.", + "nullable": true + }, + "tables_failed": { + "type": "integer", + "format": "int32", + "description": "Number of tables that failed to sync (for PARTIAL_SUCCESS).", + "nullable": true + }, + "columns_failed": { + "type": "integer", + "format": "int32", + "description": "Number of columns that failed to sync (for PARTIAL_SUCCESS).", + "nullable": true + }, + "message": { + "type": "string", + "description": "Message describing the result.", + "nullable": true + } + }, + "description": "Response from sync metadata operation." + }, "RoleResponse": { "type": "object", "required": [ @@ -24867,6 +20424,52 @@ }, "description": "Input for defining the scope of variable value assignments in batch update operations" }, + "VariablePutAssignmentInput": { + "type": "object", + "required": [ + "assigned_values" + ], + "properties": { + "assigned_values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Values of the variable" + }, + "org_identifier": { + "type": "string", + "description": "The unique name of the org", + "nullable": true + }, + "principal_type": { + "type": "string", + "enum": [ + "USER", + "USER_GROUP" + ], + "description": "Principal type", + "nullable": true + }, + "principal_identifier": { + "type": "string", + "description": "Unique ID or name of the principal", + "nullable": true + }, + "model_identifier": { + "type": "string", + "description": "Unique ID of the model", + "nullable": true + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Priority level", + "nullable": true + } + }, + "description": "Input for variable value put operations" + }, "CreateEmailCustomizationResponse": { "type": "object", "required": [ @@ -25045,6 +20648,11 @@ "type": "boolean", "description": "Whether to hide contact support url.
Version: 26.2.0.cl or later", "nullable": true + }, + "hide_logo_url": { + "type": "boolean", + "description": "Whether to hide logo
Version: 26.4.0.cl or later", + "nullable": true } }, "description": "Email customization configuration properties" @@ -25266,6 +20874,24 @@ }, "description": "Input type for AWS S3 storage configuration." }, + "WebhookKeyValuePairInput": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "description": "Key-value pair input for additional webhook headers." + }, "WebhookDeleteResponse": { "type": "object", "required": [ @@ -25323,6 +20949,74 @@ } } }, + "CollectionMetadataInput": { + "type": "object", + "required": [ + "type", + "identifiers" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "LIVEBOARD", + "ANSWER", + "LOGICAL_TABLE", + "COLLECTION" + ], + "description": "Type of metadata object." + }, + "identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of unique IDs or names of metadata objects." + } + }, + "description": "Input type for metadata to be added to a collection." + }, + "CollectionDeleteResponse": { + "type": "object", + "properties": { + "metadata_deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionDeleteTypeIdentifiers" + }, + "description": "List of metadata objects that were successfully deleted.", + "nullable": true + }, + "metadata_skipped": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionDeleteTypeIdentifiers" + }, + "description": "List of metadata objects that were skipped during deletion.\nObjects may be skipped due to lack of permissions, dependencies, or other constraints.", + "nullable": true + } + }, + "description": "Response object for delete collection operation." + }, + "CollectionDeleteTypeIdentifiers": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the metadata object (e.g., Collection, Worksheet, Table).", + "nullable": true + }, + "identifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericInfo" + }, + "description": "List of metadata identifiers belonging to the given type.", + "nullable": true + } + }, + "description": "Group of metadata objects identified by type." + }, "Runtime_Filter": { "type": "object", "properties": { @@ -25352,6 +21046,6722 @@ } }, "description": "List of runtime parameters need to set during the session." + }, + "CreateAgentConversationRequest": { + "type": "object", + "properties": { + "metadata_context": { + "description": "Context for the conversation.", + "allOf": [ + { + "$ref": "#/components/schemas/ContextPayloadV2Input" + } + ] + }, + "conversation_settings": { + "description": "Conversation settings.", + "allOf": [ + { + "$ref": "#/components/schemas/ConversationSettingsInput" + } + ] + } + }, + "required": [ + "metadata_context", + "conversation_settings" + ] + }, + "CreateConversationRequest": { + "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" + ] + }, + "GetDataSourceSuggestionsRequest": { + "type": "object", + "properties": { + "query": { + "description": "User query used to suggest data sources.", + "type": "string" + } + }, + "required": [ + "query" + ] + }, + "GetNLInstructionsRequest": { + "type": "object", + "properties": { + "data_source_identifier": { + "description": "Unique ID or name of the data-model for which to retrieve NL instructions.", + "type": "string" + } + }, + "required": [ + "data_source_identifier" + ] + }, + "GetRelevantQuestionsRequest": { + "type": "object", + "properties": { + "metadata_context": { + "description": "metadata for the query to enable generation of relevant sub-questions; at least one context identifier is required.", + "allOf": [ + { + "$ref": "#/components/schemas/MetadataContext" + } + ] + }, + "limit_relevant_questions": { + "description": "Maximum number of relevant questions that is allowed in the response, default = 5.", + "type": "integer", + "format": "int32" + }, + "bypass_cache": { + "description": "If true, results are not returned from cache & calculated every time.", + "type": "boolean", + "nullable": true + }, + "query": { + "description": "A user query that requires breaking down into smaller, more manageable analytical questions to facilitate better understanding and analysis.", + "type": "string" + }, + "ai_context": { + "description": "Additional context to guide the response.", + "allOf": [ + { + "$ref": "#/components/schemas/AIContext" + } + ] + } + }, + "required": [ + "metadata_context", + "query" + ] + }, + "QueryGetDecomposedQueryRequest": { + "type": "object", + "properties": { + "answerIds": { + "description": "List of answer unique identifiers (GUIDs) whose data will be used to guide the response.", + "type": "array", + "items": { + "type": "string" + } + }, + "content": { + "description": "User provided content like text data, csv data as a string message to provide context & potentially improve the quality of the response.", + "type": "array", + "items": { + "type": "string" + } + }, + "conversationId": { + "description": "Unique identifier to denote current conversation.", + "type": "string" + }, + "liveboardIds": { + "description": "List of liveboard unique identifiers (GUIDs) whose data will be used to guide the response.", + "type": "array", + "items": { + "type": "string" + } + }, + "maxDecomposedQueries": { + "description": "Maximum number of decomposed queries that is allowed in the response, default = 5.", + "type": "integer", + "format": "int32" + }, + "nlsRequest": { + "description": "NLSRequest object containing user query & instructions.", + "allOf": [ + { + "$ref": "#/components/schemas/Input_eureka_NLSRequest" + } + ] + }, + "worksheetIds": { + "description": "List of worksheetIds to provide context for decomposing user query into analytical queries that can be run on them.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SendAgentMessageRequest": { + "type": "object", + "properties": { + "messages": { + "description": "messages to be sent to the agent", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "messages" + ] + }, + "SendAgentMessageStreamingRequest": { + "type": "object", + "properties": { + "conversation_identifier": { + "description": "Unique identifier for the conversation (used to track context)", + "type": "string" + }, + "messages": { + "description": "messages to be sent to the agent", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "conversation_identifier", + "messages" + ] + }, + "SendMessageRequest": { + "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" + ] + }, + "SetNLInstructionsRequest": { + "type": "object", + "properties": { + "data_source_identifier": { + "description": "Unique ID or name of the data-model for which to set NL instructions.", + "type": "string" + }, + "nl_instructions_info": { + "description": "List of NL instructions to set for the data-model.", + "type": "array", + "items": { + "$ref": "#/components/schemas/NLInstructionsInfoInput" + } + } + }, + "required": [ + "data_source_identifier", + "nl_instructions_info" + ] + }, + "SingleAnswerRequest": { + "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" + ] + }, + "GetCustomAccessTokenRequest": { + "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 or name of the Org context to log in to. If the Org ID or name is not specified but a secret key is provided, the user will be logged into the Org associated with the secret key. If neither the Org ID/name nor the secret key is provided, the user will be logged into the Org context from their previous login session.", + "type": "string" + }, + "persist_option": { + "description": "Indicates whether the specified attributes should be persisted or not. RESET and NONE are not applicable if you are setting variable_values.", + "type": "string", + "enum": [ + "REPLACE", + "APPEND", + "NONE", + "RESET" + ] + }, + "filter_rules": { + "description": "Filter rules.", + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterRules" + } + }, + "parameter_values": { + "description": "Allows developers to assign parameter values for existing parameters to a user at login. Note: Using parameter values for row level security use cases will ultimately be deprecated. Developers can still pass data security values via the Custom Access token via the variable_values field and create RLS rules based on custom variables. Please refer to the [ABAC via RLS documentation](https://developers.thoughtspot.com/docs/abac-user-parameters) for more details.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ParameterValues" + } + }, + "variable_values": { + "description": "List of variable values where `name` references an existing formula variable and `values` is any value from the corresponding column.
Version: 10.14.0.cl or later", + "type": "array", + "items": { + "$ref": "#/components/schemas/VariableValues" + } + }, + "objects": { + "description": "Objects on which the parameter and variable 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. New formula variables won't be created.
Version: 10.5.0.cl or later", + "default": true, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "username", + "persist_option" + ] + }, + "GetFullAccessTokenRequest": { + "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_id": { + "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": "integer", + "format": "int32" + }, + "email": { + "description": "Email address of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", + "type": "string" + }, + "display_name": { + "description": "Indicates display name of the user. Use this parameter to provision a user just-in-time (JIT).", + "type": "string" + }, + "auto_create": { + "description": " Creates a new user if the specified username does not already 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. ", + "default": false, + "type": "boolean", + "nullable": true + }, + "group_identifiers": { + "description": "ID or name of the groups to which the newly created user belongs. Use this parameter to provision a user just-in-time (JIT).", + "type": "array", + "items": { + "type": "string" + } + }, + "user_parameters": { + "description": "
Version: 9.10.5.cl or laterDeprecated: 10.4.0.cl and later
\n\nDefine attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).", + "allOf": [ + { + "$ref": "#/components/schemas/User_Parameter_Options" + } + ] + } + }, + "required": [ + "username" + ] + }, + "GetObjectAccessTokenRequest": { + "type": "object", + "properties": { + "username": { + "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.", + "type": "string" + }, + "object_id": { + "description": "GUID of the ThoughtSpot metadata object that the user can access. The bearer will only have access to the object specified in the API request.", + "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_id": { + "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": "integer", + "format": "int32" + }, + "email": { + "description": "Email address of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", + "type": "string" + }, + "display_name": { + "description": "Display name of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", + "type": "string" + }, + "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. ", + "default": false, + "type": "boolean", + "nullable": true + }, + "group_identifiers": { + "description": "Unique ID or name of the groups to which you want to assign the new user. You can specify this attribute to dynamically assign privileges during just-in-time (JIT) provisioning.", + "type": "array", + "items": { + "type": "string" + } + }, + "user_parameters": { + "description": "
Version: 9.10.5.cl or laterDeprecated: 10.4.0.cl and later
\n\nDefine attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).", + "allOf": [ + { + "$ref": "#/components/schemas/User_Parameter_Options" + } + ] + } + }, + "required": [ + "username" + ] + }, + "LoginRequest": { + "type": "object", + "properties": { + "username": { + "description": "Username of the ThoughtSpot user", + "type": "string" + }, + "password": { + "description": "Password of the user account", + "type": "string" + }, + "org_identifier": { + "description": "ID of the Org context to log in to. If Org ID is not specified, the user will be logged in to the Org context of their previous login session.", + "type": "string" + }, + "remember_me": { + "description": "A flag to remember the user session. When set to true, a session cookie is created and used in subsequent API requests.", + "default": false, + "type": "boolean", + "nullable": true + } + } + }, + "RevokeTokenRequest": { + "type": "object", + "properties": { + "user_identifier": { + "type": "string" + }, + "token": { + "type": "string" + } + } + }, + "ValidateTokenRequest": { + "type": "object", + "properties": { + "token": { + "type": "string" + } + }, + "required": [ + "token" + ] + }, + "CreateCollectionRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the collection.", + "type": "string" + }, + "description": { + "description": "Description of the collection.", + "type": "string" + }, + "metadata": { + "description": "Metadata objects to add to the collection.", + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionMetadataInput" + } + } + }, + "required": [ + "name" + ] + }, + "DeleteCollectionRequest": { + "type": "object", + "properties": { + "collection_identifiers": { + "description": "Unique GUIDs of collections to delete. Note: Collection names cannot be\nused as identifiers since duplicate names are allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "delete_children": { + "description": "Flag to delete child objects of the collection that the user has access to.", + "default": false, + "type": "boolean", + "nullable": true + }, + "dry_run": { + "description": "Preview deletion without actually deleting. When set to true, returns\nwhat would be deleted without performing the actual deletion.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "collection_identifiers" + ] + }, + "SearchCollectionsRequest": { + "type": "object", + "properties": { + "name_pattern": { + "description": "A pattern to match case-insensitive name of the Collection object.\nUse '%' for wildcard match.", + "type": "string" + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included.\n-1 implies no pagination.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "collection_identifiers": { + "description": "Unique GUIDs of collections to search. Note: Collection names cannot be\nused as identifiers since duplicate names are allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "created_by_user_identifiers": { + "description": "Filter collections by author. Provide unique IDs or names of users\nwho created the collections.", + "type": "array", + "items": { + "type": "string" + } + }, + "include_metadata": { + "description": "Include collection metadata items in the response.", + "default": false, + "type": "boolean", + "nullable": true + }, + "sort_options": { + "description": "Sort options.", + "allOf": [ + { + "$ref": "#/components/schemas/SortOptions" + } + ] + } + } + }, + "UpdateCollectionRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the collection.", + "type": "string" + }, + "description": { + "description": "Description of the collection.", + "type": "string" + }, + "metadata": { + "description": "Metadata objects to add, remove, or replace in the collection.", + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionMetadataInput" + } + }, + "operation": { + "description": "Type of update operation. Default operation type is REPLACE.", + "default": "REPLACE", + "type": "string", + "enum": [ + "ADD", + "REMOVE", + "REPLACE" + ] + } + } + }, + "ConnectionConfigurationSearchRequest": { + "type": "object", + "properties": { + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + }, + "configuration_identifier": { + "description": "Unique ID or name of the configuration.", + "type": "string" + }, + "policy_type": { + "description": "Type of policy.", + "type": "string", + "enum": [ + "NO_POLICY", + "PRINCIPALS", + "PROCESSES" + ] + } + }, + "required": [ + "connection_identifier" + ] + }, + "CreateConnectionConfigurationRequest": { + "type": "object", + "properties": { + "name": { + "description": "Unique name for the configuration.", + "type": "string" + }, + "description": { + "description": "Description of the configuration.", + "type": "string" + }, + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + }, + "same_as_parent": { + "description": "Specifies whether the connection configuration should inherit all properties and authentication\ntype from its parent connection. This attribute is only applicable to parameterized connections.\nWhen set to true, the configuration uses only the connection properties and authentication type\ninherited from the parent.
Version: 26.2.0.cl or later", + "default": false, + "type": "boolean", + "nullable": true + }, + "policy_process_options": { + "description": "This attribute is only applicable to parameterized connections. Ensure that the policy is\nset to Processes to allow the configuration to be used exclusively for system processes.
Version: 26.2.0.cl or later", + "allOf": [ + { + "$ref": "#/components/schemas/PolicyProcessOptionsInput" + } + ] + }, + "authentication_type": { + "description": "Type of authentication used for the connection.", + "default": "SERVICE_ACCOUNT", + "type": "string", + "enum": [ + "SERVICE_ACCOUNT", + "KEY_PAIR", + "PERSONAL_ACCESS_TOKEN", + "OAUTH_WITH_SERVICE_PRINCIPAL", + "OAUTH_CLIENT_CREDENTIALS" + ] + }, + "configuration": { + "description": "Configuration properties in JSON.", + "type": "object" + }, + "policy_type": { + "description": "Type of policy.", + "default": "NO_POLICY", + "type": "string", + "enum": [ + "NO_POLICY", + "PRINCIPALS", + "PROCESSES" + ] + }, + "policy_principals": { + "description": "Unique ID or name of the User and User Groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "policy_processes": { + "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING and ROW_COUNT_STATS.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "SAGE_INDEXING", + "ROW_COUNT_STATS" + ] + } + } + }, + "required": [ + "name", + "connection_identifier", + "configuration" + ] + }, + "DeleteConnectionConfigurationRequest": { + "type": "object", + "properties": { + "configuration_identifier": { + "description": "Unique ID or name of the configuration.", + "type": "string" + }, + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + } + }, + "required": [ + "configuration_identifier", + "connection_identifier" + ] + }, + "UpdateConnectionConfigurationRequest": { + "type": "object", + "properties": { + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + }, + "name": { + "description": "Name of the configuration to update.", + "type": "string" + }, + "description": { + "description": "Description of the configuration.", + "type": "string" + }, + "same_as_parent": { + "description": "Specifies whether the connection configuration should inherit all properties and authentication\ntype from its parent connection. This attribute is only applicable to parameterized connections.\nWhen set to true, the configuration uses only the connection properties and authentication type\ninherited from the parent.
Version: 26.2.0.cl or later", + "default": false, + "type": "boolean", + "nullable": true + }, + "policy_process_options": { + "description": "This attribute is only applicable to parameterized connections. Ensure that the policy is\nset to Processes to allow the configuration to be used exclusively for system processes.
Version: 26.2.0.cl or later", + "allOf": [ + { + "$ref": "#/components/schemas/PolicyProcessOptionsInput" + } + ] + }, + "authentication_type": { + "description": "Type of authentication.", + "type": "string", + "enum": [ + "SERVICE_ACCOUNT", + "OAUTH", + "OAUTH_WITH_SERVICE_PRINCIPAL", + "EXTOAUTH", + "KEY_PAIR", + "EXTOAUTH_WITH_PKCE", + "OAUTH_WITH_PKCE", + "PERSONAL_ACCESS_TOKEN", + "OAUTH_CLIENT_CREDENTIALS" + ] + }, + "configuration": { + "description": "Configuration properties in JSON.", + "type": "object" + }, + "policy_type": { + "description": "Type of policy.", + "type": "string", + "enum": [ + "NO_POLICY", + "PRINCIPALS", + "PROCESSES" + ] + }, + "policy_principals": { + "description": "Unique ID or name of the User and User Groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "policy_processes": { + "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING and ROW_COUNT_STATS.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "SAGE_INDEXING", + "ROW_COUNT_STATS" + ] + } + }, + "disable": { + "description": "Indicates whether the configuration enable/disable.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "connection_identifier" + ] + }, + "CreateConnectionRequest": { + "type": "object", + "properties": { + "name": { + "description": "Unique name for the connection.", + "type": "string" + }, + "description": { + "description": "Description of the connection.", + "type": "string" + }, + "data_warehouse_type": { + "description": "Type of the data warehouse.", + "type": "string", + "enum": [ + "SNOWFLAKE", + "AMAZON_REDSHIFT", + "GOOGLE_BIGQUERY", + "AZURE_SYNAPSE", + "TERADATA", + "SAP_HANA", + "STARBURST", + "ORACLE_ADW", + "DATABRICKS", + "DENODO", + "DREMIO", + "TRINO", + "PRESTO", + "POSTGRES", + "SQLSERVER", + "MYSQL", + "GENERIC_JDBC", + "AMAZON_RDS_POSTGRESQL", + "AMAZON_AURORA_POSTGRESQL", + "AMAZON_RDS_MYSQL", + "AMAZON_AURORA_MYSQL", + "LOOKER", + "AMAZON_ATHENA", + "SINGLESTORE", + "GCP_SQLSERVER", + "GCP_ALLOYDB_POSTGRESQL", + "GCP_POSTGRESQL", + "GCP_MYSQL", + "MODE", + "GOOGLE_SHEETS", + "FALCON", + "FALCON_ONPREM", + "CLICKHOUSE" + ] + }, + "data_warehouse_config": { + "description": "Connection configuration attributes in JSON format. To create a connection with tables, include table attributes. See the documentation above for sample JSON.", + "type": "object" + }, + "validate": { + "description": "Validates the connection metadata if tables are included. If you are creating a connection without tables, specify `false`.", + "default": true, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "name", + "data_warehouse_type", + "data_warehouse_config" + ] + }, + "DeleteConnectionRequest": { + "type": "object", + "properties": { + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + } + }, + "required": [ + "connection_identifier" + ] + }, + "RevokeRefreshTokensRequest": { + "type": "object", + "properties": { + "configuration_identifiers": { + "description": "Unique ID or name of the configuration. When provided, the refresh tokens of the users associated with the connection configuration will be revoked.", + "type": "array", + "items": { + "type": "string" + } + }, + "user_identifiers": { + "description": "Unique ID or name of the users. When provided, the refresh tokens of the specified users will be revoked. If the request includes the user ID or name of the connection author, their token will also be revoked.", + "type": "array", + "items": { + "type": "string" + } + }, + "org_identifiers": { + "description": "Unique ID or name of the Org. When provided, the refresh tokens of all users associated with the published connection in the Org will be revoked. This parameter is valid only for published connections. Using it with unpublished connections will result in an error.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SearchConnectionRequest": { + "type": "object", + "properties": { + "connections": { + "description": "List of connections and name pattern", + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionInput" + } + }, + "data_warehouse_types": { + "description": "Array of types of data warehouse defined for the connection.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "SNOWFLAKE", + "AMAZON_REDSHIFT", + "GOOGLE_BIGQUERY", + "AZURE_SYNAPSE", + "TERADATA", + "SAP_HANA", + "STARBURST", + "ORACLE_ADW", + "DATABRICKS", + "DENODO", + "DREMIO", + "TRINO", + "PRESTO", + "POSTGRES", + "SQLSERVER", + "MYSQL", + "GENERIC_JDBC", + "AMAZON_RDS_POSTGRESQL", + "AMAZON_AURORA_POSTGRESQL", + "AMAZON_RDS_MYSQL", + "AMAZON_AURORA_MYSQL", + "LOOKER", + "AMAZON_ATHENA", + "SINGLESTORE", + "GCP_SQLSERVER", + "GCP_ALLOYDB_POSTGRESQL", + "GCP_POSTGRESQL", + "GCP_MYSQL", + "MODE", + "GOOGLE_SHEETS", + "FALCON", + "FALCON_ONPREM", + "CLICKHOUSE" + ] + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "tag_identifiers": { + "description": "Unique ID or name of tags.", + "type": "array", + "items": { + "type": "string" + } + }, + "data_warehouse_object_type": { + "description": "Data warehouse object type.", + "type": "string", + "enum": [ + "DATABASE", + "SCHEMA", + "TABLE", + "COLUMN" + ] + }, + "sort_options": { + "description": "Sort options.", + "allOf": [ + { + "$ref": "#/components/schemas/SortOptionInput" + } + ] + }, + "include_details": { + "description": "Indicates whether to include complete details of the connection objects.", + "type": "boolean", + "nullable": true + }, + "configuration": { + "description": "Configuration values. If empty we are fetching configuration from datasource based on given connection id. If required you can provide config details to fetch specific details. Example input: {}, {\"warehouse\":\"SMALL_WH\",\"database\":\"DEVELOPMENT\"}. This is only applicable when data_warehouse_object_type is selected.", + "type": "object" + }, + "authentication_type": { + "description": "List of authentication types to fetch data_ware_house_objects from external Data warehouse. This is only applicable when data_warehouse_object_type is selected.", + "default": "SERVICE_ACCOUNT", + "type": "string", + "enum": [ + "SERVICE_ACCOUNT", + "OAUTH", + "IAM", + "EXTOAUTH", + "OAUTH_WITH_SERVICE_PRINCIPAL", + "PERSONAL_ACCESS_TOKEN", + "KEY_PAIR", + "OAUTH_WITH_PKCE", + "EXTOAUTH_WITH_PKCE", + "OAUTH_WITH_PEZ", + "OAUTH_CLIENT_CREDENTIALS" + ] + }, + "show_resolved_parameters": { + "description": "
Version: 10.9.0.cl or later
\n\nIndicates whether to show resolved parameterised values.", + "default": false, + "type": "boolean", + "nullable": true + } + } + }, + "SyncMetadataRequest": { + "type": "object", + "properties": { + "tables": { + "description": "Array of tables to sync. Each element can be:\n- String: Table identifier (GUID or name) to sync\n all columns for that table.\n- Object: {tableId: [columnIds]} to sync specific\n columns.\nIf not provided, syncs all tables in the connection.", + "type": "object" + }, + "sync_attributes": { + "description": "List of sync_attributes to sync from CDW.\nThe default value is DESCRIPTION.", + "default": [ + "DESCRIPTION" + ], + "type": "array", + "items": { + "type": "string", + "enum": [ + "DESCRIPTION" + ] + } + } + } + }, + "UpdateConnectionRequest": { + "type": "object", + "properties": { + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + }, + "name": { + "description": "Updated name of the connection.", + "type": "string" + }, + "description": { + "description": "Updated description of the connection.", + "type": "string" + }, + "data_warehouse_config": { + "description": "Configuration of the data warehouse in JSON.", + "type": "object" + }, + "validate": { + "description": "Indicates whether to validate the connection details.", + "default": true, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "connection_identifier" + ] + }, + "UpdateConnectionV2Request": { + "type": "object", + "properties": { + "name": { + "description": "Updated name of the connection.", + "type": "string" + }, + "description": { + "description": "Updated description of the connection.", + "type": "string" + }, + "data_warehouse_config": { + "description": "Configuration of the data warehouse in JSON.", + "type": "object" + }, + "validate": { + "description": "Indicates whether to validate the connection details.", + "default": true, + "type": "boolean", + "nullable": true + } + } + }, + "CreateCustomActionRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the custom action. The custom action name must be unique.", + "type": "string" + }, + "action_details": { + "description": "Action details includes `Type` and Configuration data for Custom Actions, either Callback or URL is required.", + "allOf": [ + { + "$ref": "#/components/schemas/Action_Details_Input_Create" + } + ] + }, + "associate_metadata": { + "description": "Metadata objects to which the custom action needs to be associated.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Associate_Metadata_Input_Create" + } + }, + "default_action_config": { + "description": "Default Custom action configuration. This includes if the custom action is available on all visualizations. By default, a custom action is added to all visualizations and Answers.", + "allOf": [ + { + "$ref": "#/components/schemas/Default_Action_Config_Input_Create" + } + ] + }, + "group_identifiers": { + "description": "Unique ID or name of the groups that can view and access the custom action.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "action_details" + ] + }, + "SearchCustomActionsRequest": { + "type": "object", + "properties": { + "custom_action_identifier": { + "description": "Name or ID of the custom action.", + "type": "string" + }, + "name_pattern": { + "description": "A pattern to match case-insensitive name of the custom-action object.", + "type": "string" + }, + "default_action_config": { + "description": "Default Custom action configuration. This includes if the custom action is available on all visualizations. By default, a custom action is added to all visualizations and Answers.", + "allOf": [ + { + "$ref": "#/components/schemas/Default_Action_Config_Search_Input" + } + ] + }, + "include_group_associations": { + "description": "When set to true, returns the associated groups for a custom action.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_metadata_associations": { + "description": "When set to true, returns the associated metadata for a custom action.", + "default": false, + "type": "boolean", + "nullable": true + }, + "metadata": { + "description": "Search with a given metadata identifier.", + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomActionMetadataTypeInput" + } + }, + "type": { + "description": "Filter the action objects based on type", + "type": "string", + "enum": [ + "CALLBACK", + "URL" + ] + } + } + }, + "UpdateCustomActionRequest": { + "type": "object", + "properties": { + "action_details": { + "description": "Action details includes `Type` and Configuration for Custom Actions, either Callback or URL is required.", + "allOf": [ + { + "$ref": "#/components/schemas/Action_Details_Input" + } + ] + }, + "associate_metadata": { + "description": "Metadata objects to which the custom action needs to be associated.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Associate_Metadata_Input" + } + }, + "default_action_config": { + "description": "Default Custom action configuration. This includes if the custom action available on visualizations and Answers. By default, a custom action is added to all visualizations and Answers.", + "allOf": [ + { + "$ref": "#/components/schemas/Default_Action_Config_Input" + } + ] + }, + "group_identifiers": { + "description": "Unique ID or name of the groups that can view and access the custom action.", + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "description": "Name of the custom action. The custom action name must be unique.", + "type": "string" + }, + "operation": { + "description": "Type of update operation. Default operation type is ADD", + "default": "ADD", + "type": "string", + "enum": [ + "ADD", + "REMOVE" + ] + } + } + }, + "CreateCalendarRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the custom calendar.", + "type": "string" + }, + "creation_method": { + "description": "Type of create operation.", + "type": "string", + "enum": [ + "FROM_INPUT_PARAMS", + "FROM_EXISTING_TABLE" + ] + }, + "table_reference": { + "description": "Table reference containing connection identifier and table details in this format: `{\"connection_identifier\":\"conn1\", \"database_name\":\"db1\", \"schema_name\":\"sc1\", \"table_name\":\"tb1\"}`. The given table will be created if `creation_method` is set as `FROM_INPUT_PARAMS`.", + "allOf": [ + { + "$ref": "#/components/schemas/ExternalTableInput" + } + ] + }, + "start_date": { + "description": "Start date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `creation_method` is set as `FROM_INPUT_PARAMS`.", + "type": "string" + }, + "end_date": { + "description": "End date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `creation_method` is set as `FROM_INPUT_PARAMS`.", + "type": "string" + }, + "calendar_type": { + "description": "Type of the calendar.", + "default": "MONTH_OFFSET", + "type": "string", + "enum": [ + "MONTH_OFFSET", + "FOUR_FOUR_FIVE", + "FOUR_FIVE_FOUR", + "FIVE_FOUR_FOUR" + ] + }, + "month_offset": { + "description": "Specify the month in which the fiscal or custom calendar year should start. For example, if you set `month_offset` to \"April\", the custom calendar will treat \"April\" as the first month of the year, and the related attributes such as quarters and start date will be based on this offset. The default value is `January`, which represents the standard calendar year (January to December).", + "default": "January", + "type": "string", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ] + }, + "start_day_of_week": { + "description": "Specify the starting day of the week.", + "default": "Sunday", + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ] + }, + "quarter_name_prefix": { + "description": "Prefix to add before the quarter.", + "default": "", + "type": "string" + }, + "year_name_prefix": { + "description": "Prefix to add before the year.", + "default": "", + "type": "string" + } + }, + "required": [ + "name", + "creation_method", + "table_reference" + ] + }, + "GenerateCSVRequest": { + "type": "object", + "properties": { + "start_date": { + "description": "Start date for the calendar in `MM/dd/yyyy` format.", + "type": "string" + }, + "end_date": { + "description": "End date for the calendar in `MM/dd/yyyy` format.", + "type": "string" + }, + "calendar_type": { + "description": "Type of the calendar.", + "default": "MONTH_OFFSET", + "type": "string", + "enum": [ + "MONTH_OFFSET", + "FOUR_FOUR_FIVE", + "FOUR_FIVE_FOUR", + "FIVE_FOUR_FOUR" + ] + }, + "month_offset": { + "description": "Month offset to start calendar from `January`.", + "default": "January", + "type": "string", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ] + }, + "start_day_of_week": { + "description": "Specify the starting day of the week.", + "default": "Sunday", + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ] + }, + "quarter_name_prefix": { + "description": "Prefix to add before the quarter.", + "type": "string" + }, + "year_name_prefix": { + "description": "Prefix to add before the year.", + "type": "string" + } + }, + "required": [ + "start_date", + "end_date" + ] + }, + "SearchCalendarsRequest": { + "type": "object", + "properties": { + "connection_identifier": { + "description": "Unique ID or name of the connection.", + "type": "string" + }, + "name_pattern": { + "description": "Pattern to match for calendar names (use '%' for wildcard match).", + "type": "string" + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "sort_options": { + "description": "Sort options.", + "allOf": [ + { + "$ref": "#/components/schemas/SortOption" + } + ] + } + } + }, + "UpdateCalendarRequest": { + "type": "object", + "properties": { + "update_method": { + "description": "Type of update operation.", + "default": "FROM_INPUT_PARAMS", + "type": "string", + "enum": [ + "FROM_INPUT_PARAMS", + "FROM_EXISTING_TABLE" + ] + }, + "table_reference": { + "description": "Table reference containing connection identifier and table details in this format: `{\"connection_identifier\":\"conn1\", \"database_name\":\"db1\", \"schema_name\":\"sc1\", \"table_name\":\"tb1\"}`.", + "allOf": [ + { + "$ref": "#/components/schemas/ExternalTableInput" + } + ] + }, + "start_date": { + "description": "Start date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.", + "type": "string" + }, + "end_date": { + "description": "End date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.", + "type": "string" + }, + "calendar_type": { + "description": "Type of the calendar.", + "default": "MONTH_OFFSET", + "type": "string", + "enum": [ + "MONTH_OFFSET", + "FOUR_FOUR_FIVE", + "FOUR_FIVE_FOUR", + "FIVE_FOUR_FOUR" + ] + }, + "month_offset": { + "description": "Specify the month in which the fiscal or custom calendar year should start. For example, if you set `month_offset` to \"April\", the custom calendar will treat \"April\" as the first month of the year, and the related attributes such as quarters and start date will be based on this offset. The default value is `January`, which represents the standard calendar year (January to December).", + "default": "January", + "type": "string", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ] + }, + "start_day_of_week": { + "description": "Specify the starting day of the week", + "default": "Sunday", + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ] + }, + "quarter_name_prefix": { + "description": "Prefix to add before the quarter.", + "default": "", + "type": "string" + }, + "year_name_prefix": { + "description": "Prefix to add before the year.", + "default": "", + "type": "string" + } + }, + "required": [ + "table_reference" + ] + }, + "FetchAnswerDataRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "description": "GUID or name of the Answer.", + "type": "string" + }, + "data_format": { + "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", + "default": "COMPACT", + "type": "string", + "enum": [ + "FULL", + "COMPACT" + ] + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records to include in a batch.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "runtime_filter": { + "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", + "type": "object" + }, + "runtime_sort": { + "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", + "type": "object" + }, + "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" + } + }, + "required": [ + "metadata_identifier" + ] + }, + "FetchLiveboardDataRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "description": "GUID or name of the Liveboard.", + "type": "string" + }, + "visualization_identifiers": { + "description": "GUIDs or names of the visualizations on the Liveboard.", + "type": "array", + "items": { + "type": "string" + } + }, + "transient_content": { + "description": "Transient content of the Liveboard.", + "type": "string" + }, + "data_format": { + "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", + "default": "COMPACT", + "type": "string", + "enum": [ + "FULL", + "COMPACT" + ] + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records to include in a batch.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "runtime_filter": { + "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", + "type": "object" + }, + "runtime_sort": { + "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", + "type": "object" + }, + "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" + } + }, + "required": [ + "metadata_identifier" + ] + }, + "SearchDataRequest": { + "type": "object", + "properties": { + "query_string": { + "description": "Query string with search tokens. For example, [Sales][Region]. See [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api)", + "type": "string" + }, + "logical_table_identifier": { + "description": "GUID of the data source object, such as a Worksheet, View, or Table. You can find the GUID of a data object from the UI or via API. See [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_query) for more details.", + "type": "string" + }, + "data_format": { + "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", + "default": "COMPACT", + "type": "string", + "enum": [ + "FULL", + "COMPACT" + ] + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records to include in a batch.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "runtime_filter": { + "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", + "type": "object" + }, + "runtime_sort": { + "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", + "type": "object" + }, + "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" + } + }, + "required": [ + "query_string", + "logical_table_identifier" + ] + }, + "CreateEmailCustomizationRequest": { + "type": "object", + "properties": { + "template_properties": { + "description": "Email customization configuration as key value pair", + "allOf": [ + { + "$ref": "#/components/schemas/Template_Properties_Input_Create" + } + ] + }, + "org_identifier": { + "description": "Unique ID or name of org
Version: 10.12.0.cl or later", + "type": "string" + } + }, + "required": [ + "template_properties" + ] + }, + "DeleteOrgEmailCustomizationRequest": { + "type": "object", + "properties": { + "org_identifiers": { + "description": "Unique identifier of the organization.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SearchEmailCustomizationRequest": { + "type": "object", + "properties": { + "org_identifiers": { + "description": "Unique ID or name of org
Version: 10.12.0.cl or later", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UpdateEmailCustomizationRequest": { + "type": "object", + "properties": { + "template_properties": { + "description": "Email customization configuration as key value pair", + "allOf": [ + { + "$ref": "#/components/schemas/Template_Properties_Input_Create" + } + ] + }, + "org_identifier": { + "description": "Unique ID or name of org", + "type": "string" + } + }, + "required": [ + "template_properties" + ] + }, + "CreateUserGroupRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the group. The group name must be unique.", + "type": "string" + }, + "display_name": { + "description": "Display name for the group.", + "type": "string" + }, + "default_liveboard_identifiers": { + "description": "GUID of the Liveboards to assign as default Liveboards to the users in the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "Description of the group", + "type": "string" + }, + "privileges": { + "description": "Privileges to assign to the group", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ADMINISTRATION", + "AUTHORING", + "USERDATAUPLOADING", + "DATADOWNLOADING", + "USERMANAGEMENT", + "DATAMANAGEMENT", + "SHAREWITHALL", + "JOBSCHEDULING", + "A3ANALYSIS", + "EXPERIMENTALFEATUREPRIVILEGE", + "BYPASSRLS", + "RANALYSIS", + "DEVELOPER", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "SYNCMANAGEMENT", + "CAN_CREATE_CATALOG", + "DISABLE_PINBOARD_CREATION", + "LIVEBOARD_VERIFIER", + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "CAN_MODIFY_FOLDERS", + "CAN_MANAGE_VARIABLES", + "CAN_VIEW_FOLDERS", + "PREVIEW_DOCUMENT_SEARCH", + "CAN_SETUP_VERSION_CONTROL", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + }, + "sub_group_identifiers": { + "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "description": "Group type.", + "default": "LOCAL_GROUP", + "type": "string", + "enum": [ + "LOCAL_GROUP", + "LDAP_GROUP", + "TEAM_GROUP", + "TENANT_GROUP" + ] + }, + "user_identifiers": { + "description": "GUID or name of the users to assign to the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "description": "Visibility of the group. To make a group visible to other users and groups,\nset the visibility to SHAREABLE.", + "default": "SHARABLE", + "type": "string", + "enum": [ + "SHARABLE", + "NON_SHARABLE" + ] + }, + "role_identifiers": { + "description": "Role identifiers of the roles that should be assigned to the group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "display_name" + ] + }, + "ImportUserGroupsRequest": { + "type": "object", + "properties": { + "groups": { + "description": "Details of groups which are to be imported", + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupsImportListInput" + } + }, + "delete_unspecified_groups": { + "description": "If set to true, removes groups that are not specified in the API request.", + "default": false, + "type": "boolean", + "nullable": true + }, + "dry_run": { + "description": "If true, the API performs a test operation and returns user IDs whose\ndata will be edited after the import.", + "default": true, + "type": "boolean", + "nullable": true + } + } + }, + "SearchUserGroupsRequest": { + "type": "object", + "properties": { + "default_liveboard_identifiers": { + "description": "GUID of Liveboards that are assigned as default Liveboards to the users in the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "Description of the group", + "type": "string" + }, + "display_name": { + "description": "Display name of the group", + "type": "string" + }, + "name_pattern": { + "description": "A pattern to match case-insensitive name of the Group object.", + "type": "string" + }, + "group_identifier": { + "description": "GUID or name of the group", + "type": "string" + }, + "org_identifiers": { + "description": "ID or name of the Org to which the group belongs", + "type": "array", + "items": { + "type": "string" + } + }, + "privileges": { + "description": "Privileges assigned to the group.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ADMINISTRATION", + "AUTHORING", + "USERDATAUPLOADING", + "DATADOWNLOADING", + "USERMANAGEMENT", + "DATAMANAGEMENT", + "SHAREWITHALL", + "JOBSCHEDULING", + "A3ANALYSIS", + "EXPERIMENTALFEATUREPRIVILEGE", + "BYPASSRLS", + "RANALYSIS", + "DEVELOPER", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "SYNCMANAGEMENT", + "CAN_CREATE_CATALOG", + "DISABLE_PINBOARD_CREATION", + "LIVEBOARD_VERIFIER", + "PREVIEW_THOUGHTSPOT_SAGE", + "APPLICATION_ADMINISTRATION", + "SYSTEM_INFO_ADMINISTRATION", + "ORG_ADMINISTRATION", + "ROLE_ADMINISTRATION", + "AUTHENTICATION_ADMINISTRATION", + "BILLING_INFO_ADMINISTRATION", + "CAN_MANAGE_CUSTOM_CALENDAR", + "CAN_CREATE_OR_EDIT_CONNECTIONS", + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "PREVIEW_DOCUMENT_SEARCH", + "CAN_MODIFY_FOLDERS", + "CAN_MANAGE_VARIABLES", + "CAN_VIEW_FOLDERS", + "CAN_SETUP_VERSION_CONTROL", + "CAN_MANAGE_WEBHOOKS", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + }, + "sub_group_identifiers": { + "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "description": "Group type.", + "type": "string", + "enum": [ + "LOCAL_GROUP", + "LDAP_GROUP", + "TEAM_GROUP", + "TENANT_GROUP" + ] + }, + "user_identifiers": { + "description": "GUID or name of the users assigned to the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "description": "Visibility of the group. To make a group visible to other users and groups,\nset the visibility to SHAREABLE.", + "type": "string", + "enum": [ + "SHARABLE", + "NON_SHARABLE" + ] + }, + "role_identifiers": { + "description": "Filter groups with a list of Roles assigned to a group", + "type": "array", + "items": { + "type": "string" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "sort_options": { + "description": "Sort options to filter group details.", + "allOf": [ + { + "$ref": "#/components/schemas/SortOptions" + } + ] + }, + "include_users": { + "description": "
Version: 10.10.0.cl or later
\n\nDefine Parameter to consider if the users should be included in group search response.", + "default": true, + "type": "boolean", + "nullable": true + }, + "include_sub_groups": { + "description": "
Version: 10.10.0.cl or later
\n\nDefine Parameter to consider if the sub groups should be included in group search response.", + "default": true, + "type": "boolean", + "nullable": true + } + } + }, + "UpdateUserGroupRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the group to modify.", + "type": "string" + }, + "default_liveboard_identifiers": { + "description": "ID of the Liveboards to be assigned as default Liveboards to the users in the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "Description for the group.", + "type": "string" + }, + "display_name": { + "description": "Display name of the group.", + "type": "string" + }, + "privileges": { + "description": "Privileges to assign to the group.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ADMINISTRATION", + "AUTHORING", + "USERDATAUPLOADING", + "DATADOWNLOADING", + "USERMANAGEMENT", + "DATAMANAGEMENT", + "SHAREWITHALL", + "JOBSCHEDULING", + "A3ANALYSIS", + "EXPERIMENTALFEATUREPRIVILEGE", + "BYPASSRLS", + "RANALYSIS", + "DEVELOPER", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "SYNCMANAGEMENT", + "CAN_CREATE_CATALOG", + "DISABLE_PINBOARD_CREATION", + "LIVEBOARD_VERIFIER", + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "CAN_MODIFY_FOLDERS", + "CAN_MANAGE_VARIABLES", + "CAN_VIEW_FOLDERS", + "PREVIEW_DOCUMENT_SEARCH", + "CAN_SETUP_VERSION_CONTROL", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + }, + "sub_group_identifiers": { + "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "description": "Type of the group", + "type": "string", + "enum": [ + "LOCAL_GROUP", + "LDAP_GROUP", + "TEAM_GROUP", + "TENANT_GROUP" + ] + }, + "user_identifiers": { + "description": "GUID or name of the users to assign to the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "description": "Visibility of the group. To make a group visible to other users and\ngroups, set the visibility to SHAREABLE.", + "type": "string", + "enum": [ + "SHARABLE", + "NON_SHARABLE" + ] + }, + "role_identifiers": { + "description": "Role identifiers of the Roles that should be assigned to the group.", + "type": "array", + "items": { + "type": "string" + } + }, + "operation": { + "description": "Type of update operation. Default operation type is REPLACE", + "default": "REPLACE", + "type": "string", + "enum": [ + "ADD", + "REMOVE", + "REPLACE" + ] + } + } + }, + "SearchChannelHistoryRequest": { + "type": "object", + "properties": { + "channel_type": { + "description": "Type of communication channel to search history for.", + "type": "string", + "enum": [ + "WEBHOOK" + ] + }, + "job_ids": { + "description": "List of job execution record IDs to retrieve.", + "type": "array", + "items": { + "type": "string" + } + }, + "channel_identifiers": { + "description": "List of channel IDs or names to filter by.", + "type": "array", + "items": { + "type": "string" + } + }, + "channel_status": { + "description": "Filter by channel delivery status.", + "type": "string", + "enum": [ + "PENDING", + "RETRY", + "SUCCESS", + "FAILED" + ] + }, + "events": { + "description": "Filter by events that triggered the channel.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ChannelHistoryEventInput" + } + }, + "start_epoch_time_in_millis": { + "description": "Filter records created on or after this time (epoch milliseconds).", + "type": "number", + "format": "float" + } + }, + "required": [ + "channel_type" + ] + }, + "FetchLogsRequest": { + "type": "object", + "properties": { + "log_type": { + "description": "Name of the log type", + "type": "string", + "enum": [ + "SECURITY_AUDIT" + ] + }, + "start_epoch_time_in_millis": { + "description": "Start time in EPOCH format", + "type": "number", + "format": "float" + }, + "end_epoch_time_in_millis": { + "description": "End time in EPOCH format", + "type": "number", + "format": "float" + }, + "get_all_logs": { + "description": "Fetch all the logs. This is available from 9.10.5.cl", + "default": true, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "log_type" + ] + }, + "ConvertWorksheetToModelRequest": { + "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 + } + } + }, + "CopyObjectRequest": { + "type": "object", + "properties": { + "description": { + "description": "Description of the new object", + "type": "string" + }, + "identifier": { + "description": "GUID of metadata object to be copied (answer id or liveboard id)", + "type": "string" + }, + "type": { + "description": "Type of metadata object", + "type": "string", + "enum": [ + "LIVEBOARD", + "ANSWER" + ] + }, + "title": { + "description": "Title of the new object", + "type": "string" + } + }, + "required": [ + "identifier" + ] + }, + "DeleteMetadataRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/DeleteMetadataTypeInput" + } + }, + "delete_disabled_objects": { + "description": "Indicates whether to delete disabled metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "metadata" + ] + }, + "ExportMetadataTMLRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ExportMetadataTypeInput" + } + }, + "export_associated": { + "description": "Indicates whether to export associated metadata objects of specified metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "export_fqn": { + "description": "Adds FQNs of the referenced objects. For example, if you are exporting a Liveboard and its associated objects,\nthe API returns the Liveboard TML data with the FQNs of the referenced worksheet.\nIf the exported TML data includes FQNs, you don't need to manually add FQNs of the referenced objects during TML import.", + "default": false, + "type": "boolean", + "nullable": true + }, + "edoc_format": { + "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": [ + "JSON", + "YAML" + ] + }, + "export_schema_version": { + "description": "Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.", + "default": "DEFAULT", + "type": "string", + "enum": [ + "DEFAULT", + "V1", + "V2" + ] + }, + "export_dependent": { + "description": "Indicates whether to export table while exporting connection.", + "default": false, + "type": "boolean", + "nullable": true + }, + "export_connection_as_dependent": { + "description": "Indicates whether to export connection as dependent while exporting table/worksheet/answer/liveboard.\nThis will only be active when export_associated is true.", + "default": false, + "type": "boolean", + "nullable": true + }, + "all_orgs_override": { + "description": "Indicates whether to export is happening from all orgs context.", + "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": [ + "metadata" + ] + }, + "ExportMetadataTMLBatchedRequest": { + "type": "object", + "properties": { + "metadata_type": { + "description": "Type of metadata object to export, can be one of USER | ROLE | USER_GROUP", + "type": "string", + "enum": [ + "USER", + "USER_GROUP", + "ROLE" + ] + }, + "batch_offset": { + "description": "Indicates the position within the complete set from where the API should begin returning objects.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "batch_size": { + "description": "Determines the number of objects or items to be retrieved in a single request.", + "default": 20, + "type": "integer", + "format": "int32" + }, + "edoc_format": { + "description": "TML EDOC content format.", + "default": "JSON", + "type": "string", + "enum": [ + "JSON", + "YAML" + ] + }, + "export_dependent": { + "description": "Indicates whether to export dependent metadata objects of specified metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "all_orgs_override": { + "description": "Indicates whether to export is happening from all orgs context.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "metadata_type" + ] + }, + "FetchAnswerSqlQueryRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "description": "ID or name of an Answer.", + "type": "string" + } + }, + "required": [ + "metadata_identifier" + ] + }, + "FetchAsyncImportTaskStatusRequest": { + "type": "object", + "properties": { + "task_ids": { + "description": "List of task IDs to fetch status for.", + "type": "array", + "items": { + "type": "string" + } + }, + "task_status": { + "description": "List of task statuses to filter on. Valid values: [IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED]", + "type": "array", + "items": { + "type": "string", + "enum": [ + "COMPLETED", + "IN_QUEUE", + "IN_PROGRESS", + "FAILED" + ] + } + }, + "author_identifier": { + "description": "Author GUID or name of async import tasks to filter on.", + "type": "string" + }, + "record_offset": { + "description": "The offset point, starting from where the task status should be included in the response.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of task statuses that should be included in the response starting from offset position.", + "default": 5, + "type": "integer", + "format": "int32" + }, + "include_import_response": { + "description": "Boolean flag to specify whether to include import response in the task status objects.", + "default": false, + "type": "boolean", + "nullable": true + } + } + }, + "FetchLiveboardSqlQueryRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "description": "ID or name of the Liveboard.", + "type": "string" + }, + "visualization_identifiers": { + "description": "Unique ID or name of visualizations.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "metadata_identifier" + ] + }, + "ImportMetadataTMLRequest": { + "type": "object", + "properties": { + "metadata_tmls": { + "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" + } + }, + "import_policy": { + "description": "Specifies the import policy for the TML import.", + "default": "PARTIAL", + "type": "string", + "enum": [ + "PARTIAL", + "ALL_OR_NONE", + "VALIDATE_ONLY", + "PARTIAL_OBJECT" + ] + }, + "create_new": { + "description": "If selected, creates TML objects with new GUIDs.", + "default": false, + "type": "boolean", + "nullable": true + }, + "all_orgs_override": { + "description": "If import is happening from all orgs context.", + "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": [ + "metadata_tmls" + ] + }, + "ImportMetadataTMLAsyncRequest": { + "type": "object", + "properties": { + "metadata_tmls": { + "description": "Details of TML objects.", + "type": "array", + "items": { + "type": "string" + } + }, + "create_new": { + "description": "If selected, creates TML objects with new GUIDs.", + "default": false, + "type": "boolean", + "nullable": true + }, + "all_orgs_override": { + "description": "If import is happening from all orgs context.", + "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" + ] + }, + "ParameterizeMetadataRequest": { + "type": "object", + "properties": { + "metadata_type": { + "description": "Type of metadata object to parameterize.", + "type": "string", + "enum": [ + "LOGICAL_TABLE", + "CONNECTION", + "CONNECTION_CONFIG" + ] + }, + "metadata_identifier": { + "description": "Unique ID or name of the metadata object to parameterize.", + "type": "string" + }, + "field_type": { + "description": "Type of field in the metadata to parameterize.", + "type": "string", + "enum": [ + "ATTRIBUTE", + "CONNECTION_PROPERTY" + ] + }, + "field_name": { + "description": "Name of the field which needs to be parameterized.", + "type": "string" + }, + "variable_identifier": { + "description": "Unique ID or name of the variable to use for parameterization", + "type": "string" + } + }, + "required": [ + "metadata_identifier", + "field_type", + "field_name", + "variable_identifier" + ] + }, + "ParameterizeMetadataFieldsRequest": { + "type": "object", + "properties": { + "metadata_type": { + "description": "Type of metadata object to parameterize.", + "type": "string", + "enum": [ + "LOGICAL_TABLE", + "CONNECTION", + "CONNECTION_CONFIG" + ] + }, + "metadata_identifier": { + "description": "Unique ID or name of the metadata object to parameterize.", + "type": "string" + }, + "field_type": { + "description": "Type of field in the metadata to parameterize.", + "type": "string", + "enum": [ + "ATTRIBUTE", + "CONNECTION_PROPERTY" + ] + }, + "field_names": { + "description": "JSON array of field names to parameterize. Example: [schemaName, databaseName, tableName]", + "type": "array", + "items": { + "type": "string" + } + }, + "variable_identifier": { + "description": "Unique ID or name of the variable to use for parameterization of these fields.", + "type": "string" + } + }, + "required": [ + "metadata_identifier", + "field_type", + "field_names", + "variable_identifier" + ] + }, + "SearchMetadataRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects such as Liveboards, Answers, and Worksheets.", + "type": "array", + "items": { + "$ref": "#/components/schemas/MetadataListItemInput" + } + }, + "permissions": { + "description": "Object permission details to search by.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionInput" + } + }, + "created_by_user_identifiers": { + "description": "GUID or name of user who created the metadata object.", + "type": "array", + "items": { + "type": "string" + } + }, + "dependent_object_version": { + "description": "Version of the dependent table of the metadata objects like Worksheets.", + "default": "V1", + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + "exclude_objects": { + "description": "List of metadata objects to exclude from search.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ExcludeMetadataListItemInput" + } + }, + "favorite_object_options": { + "description": "Options to sort the API response by objects set as favorites\nfor the logged-in user or the users specified in the API request.", + "allOf": [ + { + "$ref": "#/components/schemas/FavoriteObjectOptionsInput" + } + ] + }, + "include_auto_created_objects": { + "description": "Includes system-generated metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_dependent_objects": { + "description": "Includes dependents of the metadata object specified in the API request.\nFor example, a worksheet can consist of dependent objects such as Liveboards or Answers.", + "default": false, + "type": "boolean", + "nullable": true + }, + "dependent_objects_record_size": { + "description": "The maximum number of dependents to include per metadata object.", + "default": 50, + "type": "integer", + "format": "int32" + }, + "include_details": { + "description": "Includes complete details of the metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_headers": { + "description": "Includes headers of the metadata objects.", + "default": true, + "type": "boolean", + "nullable": true + }, + "include_hidden_objects": { + "description": "Includes details of the hidden objects, such as a column in a worksheet or a table.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_incomplete_objects": { + "description": "Includes objects with incomplete metadata.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_visualization_headers": { + "description": "Includes visualization headers of the specified Liveboard object.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_worksheet_search_assist_data": { + "description": "If search assistance lessons are configured on a worksheet,\nthe API returns the search assist data for Worksheet objects.", + "type": "boolean", + "nullable": true + }, + "modified_by_user_identifiers": { + "description": "Includes ID or names of the users who modified the metadata object.", + "type": "array", + "items": { + "type": "string" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included. It is recommended to use a smaller `record_size` when fetching dependent objects or any of the additional metadata detail options.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "sort_options": { + "description": "Sort options to filter metadata details.", + "allOf": [ + { + "$ref": "#/components/schemas/MetadataSearchSortOptions" + } + ] + }, + "tag_identifiers": { + "description": "Tags to filter metadata objects by", + "type": "array", + "items": { + "type": "string" + } + }, + "include_stats": { + "description": "Indicates whether to include stats of the metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_discoverable_objects": { + "description": "
Version: 10.7.0.cl or later
\n\nBoolean to indicate whether to include discoverable metadata objects.", + "default": true, + "type": "boolean", + "nullable": true + }, + "show_resolved_parameters": { + "description": "
Version: 10.9.0.cl or later
\n\nIndicates whether to show resolved parameterised values.", + "default": false, + "type": "boolean", + "nullable": true + }, + "liveboard_response_version": { + "description": "Indicates the model version of Liveboard to be attached in metadata detail.", + "default": "V1", + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + "include_only_published_objects": { + "description": "
Version: 10.11.0.cl or later
\n\nIf only published objects should be returned", + "default": false, + "type": "boolean", + "nullable": true + } + } + }, + "UnparameterizeMetadataRequest": { + "type": "object", + "properties": { + "metadata_type": { + "description": "Type of metadata object to unparameterize.", + "type": "string", + "enum": [ + "LOGICAL_TABLE", + "CONNECTION", + "CONNECTION_CONFIG" + ] + }, + "metadata_identifier": { + "description": "Unique ID or name of the metadata object to unparameterize.", + "type": "string" + }, + "field_type": { + "description": "Type of field in the metadata to unparameterize.", + "type": "string", + "enum": [ + "ATTRIBUTE", + "CONNECTION_PROPERTY" + ] + }, + "field_name": { + "description": "Name of the field which needs to be unparameterized.", + "type": "string" + }, + "value": { + "description": "The value to use in place of the variable for the field", + "type": "string" + } + }, + "required": [ + "metadata_identifier", + "field_type", + "field_name", + "value" + ] + }, + "UpdateMetadataHeaderRequest": { + "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": [ + "headers_update" + ] + }, + "UpdateMetadataObjIdRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "List of metadata objects to update their object IDs.", + "type": "array", + "items": { + "$ref": "#/components/schemas/UpdateObjIdInput" + } + } + }, + "required": [ + "metadata" + ] + }, + "CreateOrgRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the Org.", + "type": "string" + }, + "description": { + "description": "Description of the Org.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "SearchOrgsRequest": { + "type": "object", + "properties": { + "org_identifier": { + "description": "ID or name of the Org", + "type": "string" + }, + "description": { + "description": "Description of the Org", + "type": "string" + }, + "visibility": { + "description": "Visibility of the Org", + "type": "string", + "enum": [ + "SHOW", + "HIDDEN" + ] + }, + "status": { + "description": "Status of the Org", + "type": "string", + "enum": [ + "ACTIVE", + "IN_ACTIVE" + ] + }, + "user_identifiers": { + "description": "GUIDs or names of the users for which you want to retrieve the Orgs data", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UpdateOrgRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the Org", + "type": "string" + }, + "description": { + "description": "Description of the Org", + "type": "string" + }, + "user_identifiers": { + "description": "Add Users to an Org", + "type": "array", + "items": { + "type": "string" + } + }, + "group_identifiers": { + "description": "Add Default Groups to an Org", + "type": "array", + "items": { + "type": "string" + } + }, + "operation": { + "description": "Type of update operation. Default operation type is ADD", + "default": "ADD", + "type": "string", + "enum": [ + "ADD", + "REMOVE", + "REPLACE" + ] + } + } + }, + "ExportAnswerReportRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "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", + "type": "string", + "enum": [ + "CSV", + "PDF", + "XLSX", + "PNG" + ] + }, + "runtime_filter": { + "description": "JSON string representing runtime filter.\n{ col1:region, op1: EQ, val1: northeast }", + "type": "object" + }, + "runtime_sort": { + "description": "JSON string representing runtime sort.\n{ sortCol1: region, asc1 :true, sortCol2 : date }", + "type": "object" + }, + "runtime_param_override": { + "description": "JSON object for setting values of parameters in runtime.", + "type": "object" + }, + "regional_settings": { + "description": "Options for specific region specific overrides to support date/number/string/currency formatting.", + "allOf": [ + { + "$ref": "#/components/schemas/RegionalSettingsInput" + } + ] + } + } + }, + "ExportLiveboardReportRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "description": "GUID or name of the Liveboard object.", + "type": "string" + }, + "tab_identifiers": { + "description": "GUID or name of the tab of the Liveboard object.
Version: 10.9.0.cl or later", + "type": "array", + "items": { + "type": "string" + } + }, + "personalised_view_identifier": { + "description": "GUID or name of the personalised view of the Liveboard object.
Version: 10.9.0.cl or later", + "type": "string" + }, + "visualization_identifiers": { + "description": "GUID or name of visualizations on the Liveboard. If this parameter is\nnot defined, the API returns a report with all visualizations saved on a Liveboard.", + "type": "array", + "items": { + "type": "string" + } + }, + "transient_content": { + "description": "Transient content of the Liveboard.", + "type": "string" + }, + "file_format": { + "description": "Export file format.", + "default": "PDF", + "type": "string", + "enum": [ + "PDF", + "PNG", + "CSV", + "XLSX" + ] + }, + "runtime_filter": { + "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"region\", \"op1\": \"EQ\", \"val1\": \"northeast\" }. You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", + "type": "object" + }, + "override_filters": { + "description": "Applied to the liveboard and overrides any filters already applied on the same columns in liveboard.\nFollowing example illustrate different kinds of filters:\n{\n \"override_filters\": [\n {\n \"column_name\": \"Color\",\n \"generic_filter\": {\n \"op\": \"IN\",\n \"values\": [\n \"almond\",\n \"turquoise\"\n ]\n },\n \"negate\": false\n },\n {\n \"column_name\": \"Commit Date\",\n \"date_filter\": {\n \"datePeriod\": \"HOUR\",\n \"number\": 3,\n \"type\": \"LAST_N_PERIOD\",\n \"op\": \"EQ\"\n }\n },\n {\n \"column_name\": \"Sales\",\n \"generic_filter\": {\n \"op\": \"BW_INC\",\n \"values\": [\n \"100000\",\n \"70000\"\n ]\n },\n \"negate\": true\n }\n ]\n}", + "type": "object" + }, + "runtime_sort": { + "description": "JSON string representing runtime sort. For example, {\"sortCol1\": \"region\", \"asc1\" : true}. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", + "type": "object" + }, + "pdf_options": { + "description": "Options for PDF export.", + "allOf": [ + { + "$ref": "#/components/schemas/PdfOptionsInput" + } + ] + }, + "png_options": { + "description": "Options for PNG export.", + "allOf": [ + { + "$ref": "#/components/schemas/PngOptionsInput" + } + ] + }, + "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 specific overrides to support date/number/string/currency formatting.", + "allOf": [ + { + "$ref": "#/components/schemas/RegionalSettingsInput" + } + ] + } + }, + "required": [ + "metadata_identifier" + ] + }, + "CreateRoleRequest": { + "type": "object", + "properties": { + "name": { + "description": "Unique name of the Role.", + "type": "string" + }, + "description": { + "description": "Description of the Role.", + "type": "string" + }, + "privileges": { + "description": "Privileges granted to the Role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "USERDATAUPLOADING", + "DATADOWNLOADING", + "DATAMANAGEMENT", + "SHAREWITHALL", + "JOBSCHEDULING", + "A3ANALYSIS", + "BYPASSRLS", + "DISABLE_PINBOARD_CREATION", + "DEVELOPER", + "APPLICATION_ADMINISTRATION", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "SYSTEM_INFO_ADMINISTRATION", + "SYNCMANAGEMENT", + "ORG_ADMINISTRATION", + "ROLE_ADMINISTRATION", + "AUTHENTICATION_ADMINISTRATION", + "BILLING_INFO_ADMINISTRATION", + "CONTROL_TRUSTED_AUTH", + "TAGMANAGEMENT", + "LIVEBOARD_VERIFIER", + "CAN_MANAGE_CUSTOM_CALENDAR", + "CAN_CREATE_OR_EDIT_CONNECTIONS", + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "PREVIEW_DOCUMENT_SEARCH", + "CAN_MANAGE_VARIABLES", + "CAN_MODIFY_FOLDERS", + "CAN_VIEW_FOLDERS", + "CAN_SETUP_VERSION_CONTROL", + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_WEBHOOKS", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + }, + "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": [ + "name" + ] + }, + "SearchRolesRequest": { + "type": "object", + "properties": { + "role_identifiers": { + "description": "unique ID or name of the Roles", + "type": "array", + "items": { + "type": "string" + } + }, + "org_identifiers": { + "description": "Unique Id or name of the Organisation", + "type": "array", + "items": { + "type": "string" + } + }, + "group_identifiers": { + "description": "Unique Id or name of the User Group", + "type": "array", + "items": { + "type": "string" + } + }, + "privileges": { + "description": "Privileges assigned to the Role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "UNKNOWN", + "ADMINISTRATION", + "AUTHORING", + "USERDATAUPLOADING", + "DATADOWNLOADING", + "USERMANAGEMENT", + "SECURITYMANAGEMENT", + "LOGICALMODELING", + "DATAMANAGEMENT", + "TAGMANAGEMENT", + "SHAREWITHALL", + "SYSTEMMANAGEMENT", + "JOBSCHEDULING", + "A3ANALYSIS", + "EXPERIMENTALFEATUREPRIVILEGE", + "BYPASSRLS", + "RANALYSIS", + "DISABLE_PINBOARD_CREATION", + "DEVELOPER", + "APPLICATION_ADMINISTRATION", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "BACKUP_ADMINISTRATION", + "SYSTEM_INFO_ADMINISTRATION", + "ENABLESPOTAPPCREATION", + "SYNCMANAGEMENT", + "ORG_ADMINISTRATION", + "ROLE_ADMINISTRATION", + "AUTHENTICATION_ADMINISTRATION", + "BILLING_INFO_ADMINISTRATION", + "PREVIEW_THOUGHTSPOT_SAGE", + "LIVEBOARD_VERIFIER", + "CAN_MANAGE_CUSTOM_CALENDAR", + "CAN_CREATE_OR_EDIT_CONNECTIONS", + "CAN_CONFIGURE_CONNECTIONS", + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CONTROL_TRUSTED_AUTH", + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "CAN_VIEW_FOLDERS", + "CAN_MODIDY_FOLDERS", + "CAN_MANAGE_VARIABLES", + "PREVIEW_DOCUMENT_SEARCH", + "CAN_SETUP_VERSION_CONTROL", + "CAN_MANAGE_WEBHOOKS", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + }, + "deprecated": { + "description": "Indicates whether the Role is deprecated.", + "type": "boolean", + "deprecated": true, + "nullable": true + }, + "external": { + "description": "Indicates whether the Role is external", + "type": "boolean", + "deprecated": true, + "nullable": true + }, + "shared_via_connection": { + "description": "Indicates whether the Role is shared via connection", + "type": "boolean", + "deprecated": true, + "nullable": true + }, + "permissions": { + "description": "Permission details of the Role", + "type": "array", + "items": { + "type": "string", + "enum": [ + "READ_ONLY", + "MODIFY", + "NO_ACCESS" + ] + }, + "deprecated": true + } + } + }, + "UpdateRoleRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the Role.", + "type": "string" + }, + "description": { + "description": "Description of the Role.", + "type": "string" + }, + "privileges": { + "description": "Privileges granted to the role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "USERDATAUPLOADING", + "DATADOWNLOADING", + "DATAMANAGEMENT", + "SHAREWITHALL", + "JOBSCHEDULING", + "A3ANALYSIS", + "BYPASSRLS", + "DISABLE_PINBOARD_CREATION", + "DEVELOPER", + "APPLICATION_ADMINISTRATION", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "SYSTEM_INFO_ADMINISTRATION", + "SYNCMANAGEMENT", + "ORG_ADMINISTRATION", + "ROLE_ADMINISTRATION", + "AUTHENTICATION_ADMINISTRATION", + "BILLING_INFO_ADMINISTRATION", + "CONTROL_TRUSTED_AUTH", + "TAGMANAGEMENT", + "LIVEBOARD_VERIFIER", + "CAN_MANAGE_CUSTOM_CALENDAR", + "CAN_CREATE_OR_EDIT_CONNECTIONS", + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CAN_CREATE_CATALOG", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "CAN_MODIFY_FOLDERS", + "CAN_MANAGE_VARIABLES", + "CAN_VIEW_FOLDERS", + "PREVIEW_DOCUMENT_SEARCH", + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_WEBHOOKS", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + } + }, + "required": [ + "name" + ] + }, + "CreateScheduleRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the scheduled job.", + "type": "string" + }, + "description": { + "description": "Description of the job.", + "type": "string" + }, + "metadata_type": { + "description": "Type of the metadata object.", + "type": "string", + "enum": [ + "LIVEBOARD" + ] + }, + "metadata_identifier": { + "description": "Unique ID or name of the metadata object.", + "type": "string" + }, + "file_format": { + "description": "Export file format.", + "default": "PDF", + "type": "string", + "enum": [ + "CSV", + "PDF", + "XLSX" + ] + }, + "liveboard_options": { + "description": "Options to specify details of Liveboard.", + "allOf": [ + { + "$ref": "#/components/schemas/LiveboardOptionsInput" + } + ] + }, + "pdf_options": { + "description": "PDF layout and orientation settings. Applicable only if the `file_format` is specified as `PDF`.", + "allOf": [ + { + "$ref": "#/components/schemas/SchedulesPdfOptionsInput" + } + ] + }, + "time_zone": { + "description": "Time zone", + "default": "America/Los_Angeles", + "type": "string", + "enum": [ + "Africa/Abidjan", + "Africa/Accra", + "Africa/Addis_Ababa", + "Africa/Algiers", + "Africa/Asmara", + "Africa/Asmera", + "Africa/Bamako", + "Africa/Bangui", + "Africa/Banjul", + "Africa/Bissau", + "Africa/Blantyre", + "Africa/Brazzaville", + "Africa/Bujumbura", + "Africa/Cairo", + "Africa/Casablanca", + "Africa/Ceuta", + "Africa/Conakry", + "Africa/Dakar", + "Africa/Dar_es_Salaam", + "Africa/Djibouti", + "Africa/Douala", + "Africa/El_Aaiun", + "Africa/Freetown", + "Africa/Gaborone", + "Africa/Harare", + "Africa/Johannesburg", + "Africa/Juba", + "Africa/Kampala", + "Africa/Khartoum", + "Africa/Kigali", + "Africa/Kinshasa", + "Africa/Lagos", + "Africa/Libreville", + "Africa/Lome", + "Africa/Luanda", + "Africa/Lubumbashi", + "Africa/Lusaka", + "Africa/Malabo", + "Africa/Maputo", + "Africa/Maseru", + "Africa/Mbabane", + "Africa/Mogadishu", + "Africa/Monrovia", + "Africa/Nairobi", + "Africa/Ndjamena", + "Africa/Niamey", + "Africa/Nouakchott", + "Africa/Ouagadougou", + "Africa/Porto-Novo", + "Africa/Sao_Tome", + "Africa/Timbuktu", + "Africa/Tripoli", + "Africa/Tunis", + "Africa/Windhoek", + "America/Adak", + "America/Anchorage", + "America/Anguilla", + "America/Antigua", + "America/Araguaina", + "America/Argentina/Buenos_Aires", + "America/Argentina/Catamarca", + "America/Argentina/ComodRivadavia", + "America/Argentina/Cordoba", + "America/Argentina/Jujuy", + "America/Argentina/La_Rioja", + "America/Argentina/Mendoza", + "America/Argentina/Rio_Gallegos", + "America/Argentina/Salta", + "America/Argentina/San_Juan", + "America/Argentina/San_Luis", + "America/Argentina/Tucuman", + "America/Argentina/Ushuaia", + "America/Aruba", + "America/Asuncion", + "America/Atikokan", + "America/Atka", + "America/Bahia", + "America/Bahia_Banderas", + "America/Barbados", + "America/Belem", + "America/Belize", + "America/Blanc-Sablon", + "America/Boa_Vista", + "America/Bogota", + "America/Boise", + "America/Buenos_Aires", + "America/Cambridge_Bay", + "America/Campo_Grande", + "America/Cancun", + "America/Caracas", + "America/Catamarca", + "America/Cayenne", + "America/Cayman", + "America/Chicago", + "America/Chihuahua", + "America/Coral_Harbour", + "America/Cordoba", + "America/Costa_Rica", + "America/Creston", + "America/Cuiaba", + "America/Curacao", + "America/Danmarkshavn", + "America/Dawson", + "America/Dawson_Creek", + "America/Denver", + "America/Detroit", + "America/Dominica", + "America/Edmonton", + "America/Eirunepe", + "America/El_Salvador", + "America/Ensenada", + "America/Fort_Nelson", + "America/Fort_Wayne", + "America/Fortaleza", + "America/Glace_Bay", + "America/Godthab", + "America/Goose_Bay", + "America/Grand_Turk", + "America/Grenada", + "America/Guadeloupe", + "America/Guatemala", + "America/Guayaquil", + "America/Guyana", + "America/Halifax", + "America/Havana", + "America/Hermosillo", + "America/Indiana/Indianapolis", + "America/Indiana/Knox", + "America/Indiana/Marengo", + "America/Indiana/Petersburg", + "America/Indiana/Tell_City", + "America/Indiana/Vevay", + "America/Indiana/Vincennes", + "America/Indiana/Winamac", + "America/Indianapolis", + "America/Inuvik", + "America/Iqaluit", + "America/Jamaica", + "America/Jujuy", + "America/Juneau", + "America/Kentucky/Louisville", + "America/Kentucky/Monticello", + "America/Knox_IN", + "America/Kralendijk", + "America/La_Paz", + "America/Lima", + "America/Los_Angeles", + "America/Louisville", + "America/Lower_Princes", + "America/Maceio", + "America/Managua", + "America/Manaus", + "America/Marigot", + "America/Martinique", + "America/Matamoros", + "America/Mazatlan", + "America/Mendoza", + "America/Menominee", + "America/Merida", + "America/Metlakatla", + "America/Mexico_City", + "America/Miquelon", + "America/Moncton", + "America/Monterrey", + "America/Montevideo", + "America/Montreal", + "America/Montserrat", + "America/Nassau", + "America/New_York", + "America/Nipigon", + "America/Nome", + "America/Noronha", + "America/North_Dakota/Beulah", + "America/North_Dakota/Center", + "America/North_Dakota/New_Salem", + "America/Nuuk", + "America/Ojinaga", + "America/Panama", + "America/Pangnirtung", + "America/Paramaribo", + "America/Phoenix", + "America/Port-au-Prince", + "America/Port_of_Spain", + "America/Porto_Acre", + "America/Porto_Velho", + "America/Puerto_Rico", + "America/Punta_Arenas", + "America/Rainy_River", + "America/Rankin_Inlet", + "America/Recife", + "America/Regina", + "America/Resolute", + "America/Rio_Branco", + "America/Rosario", + "America/Santa_Isabel", + "America/Santarem", + "America/Santiago", + "America/Santo_Domingo", + "America/Sao_Paulo", + "America/Scoresbysund", + "America/Shiprock", + "America/Sitka", + "America/St_Barthelemy", + "America/St_Johns", + "America/St_Kitts", + "America/St_Lucia", + "America/St_Thomas", + "America/St_Vincent", + "America/Swift_Current", + "America/Tegucigalpa", + "America/Thule", + "America/Thunder_Bay", + "America/Tijuana", + "America/Toronto", + "America/Tortola", + "America/Vancouver", + "America/Virgin", + "America/Whitehorse", + "America/Winnipeg", + "America/Yakutat", + "America/Yellowknife", + "Antarctica/Casey", + "Antarctica/Davis", + "Antarctica/DumontDUrville", + "Antarctica/Macquarie", + "Antarctica/Mawson", + "Antarctica/McMurdo", + "Antarctica/Palmer", + "Antarctica/Rothera", + "Antarctica/South_Pole", + "Antarctica/Syowa", + "Antarctica/Troll", + "Antarctica/Vostok", + "Arctic/Longyearbyen", + "Asia/Aden", + "Asia/Almaty", + "Asia/Amman", + "Asia/Anadyr", + "Asia/Aqtau", + "Asia/Aqtobe", + "Asia/Ashgabat", + "Asia/Ashkhabad", + "Asia/Atyrau", + "Asia/Baghdad", + "Asia/Bahrain", + "Asia/Baku", + "Asia/Bangkok", + "Asia/Barnaul", + "Asia/Beirut", + "Asia/Bishkek", + "Asia/Brunei", + "Asia/Calcutta", + "Asia/Chita", + "Asia/Choibalsan", + "Asia/Chongqing", + "Asia/Chungking", + "Asia/Colombo", + "Asia/Dacca", + "Asia/Damascus", + "Asia/Dhaka", + "Asia/Dili", + "Asia/Dubai", + "Asia/Dushanbe", + "Asia/Famagusta", + "Asia/Gaza", + "Asia/Harbin", + "Asia/Hebron", + "Asia/Ho_Chi_Minh", + "Asia/Hong_Kong", + "Asia/Hovd", + "Asia/Irkutsk", + "Asia/Istanbul", + "Asia/Jakarta", + "Asia/Jayapura", + "Asia/Jerusalem", + "Asia/Kabul", + "Asia/Kamchatka", + "Asia/Karachi", + "Asia/Kashgar", + "Asia/Kathmandu", + "Asia/Katmandu", + "Asia/Khandyga", + "Asia/Kolkata", + "Asia/Krasnoyarsk", + "Asia/Kuala_Lumpur", + "Asia/Kuching", + "Asia/Kuwait", + "Asia/Macao", + "Asia/Macau", + "Asia/Magadan", + "Asia/Makassar", + "Asia/Manila", + "Asia/Muscat", + "Asia/Nicosia", + "Asia/Novokuznetsk", + "Asia/Novosibirsk", + "Asia/Omsk", + "Asia/Oral", + "Asia/Phnom_Penh", + "Asia/Pontianak", + "Asia/Pyongyang", + "Asia/Qatar", + "Asia/Qostanay", + "Asia/Qyzylorda", + "Asia/Rangoon", + "Asia/Riyadh", + "Asia/Saigon", + "Asia/Sakhalin", + "Asia/Samarkand", + "Asia/Seoul", + "Asia/Shanghai", + "Asia/Singapore", + "Asia/Srednekolymsk", + "Asia/Taipei", + "Asia/Tashkent", + "Asia/Tbilisi", + "Asia/Tehran", + "Asia/Tel_Aviv", + "Asia/Thimbu", + "Asia/Thimphu", + "Asia/Tokyo", + "Asia/Tomsk", + "Asia/Ujung_Pandang", + "Asia/Ulaanbaatar", + "Asia/Ulan_Bator", + "Asia/Urumqi", + "Asia/Ust-Nera", + "Asia/Vientiane", + "Asia/Vladivostok", + "Asia/Yakutsk", + "Asia/Yangon", + "Asia/Yekaterinburg", + "Asia/Yerevan", + "Atlantic/Azores", + "Atlantic/Bermuda", + "Atlantic/Canary", + "Atlantic/Cape_Verde", + "Atlantic/Faeroe", + "Atlantic/Faroe", + "Atlantic/Jan_Mayen", + "Atlantic/Madeira", + "Atlantic/Reykjavik", + "Atlantic/South_Georgia", + "Atlantic/St_Helena", + "Atlantic/Stanley", + "Australia/ACT", + "Australia/Adelaide", + "Australia/Brisbane", + "Australia/Broken_Hill", + "Australia/Canberra", + "Australia/Currie", + "Australia/Darwin", + "Australia/Eucla", + "Australia/Hobart", + "Australia/LHI", + "Australia/Lindeman", + "Australia/Lord_Howe", + "Australia/Melbourne", + "Australia/NSW", + "Australia/North", + "Australia/Perth", + "Australia/Queensland", + "Australia/South", + "Australia/Sydney", + "Australia/Tasmania", + "Australia/Victoria", + "Australia/West", + "Australia/Yancowinna", + "Brazil/Acre", + "Brazil/DeNoronha", + "Brazil/East", + "Brazil/West", + "CET", + "CST6CDT", + "Canada/Atlantic", + "Canada/Central", + "Canada/Eastern", + "Canada/Mountain", + "Canada/Newfoundland", + "Canada/Pacific", + "Canada/Saskatchewan", + "Canada/Yukon", + "Chile/Continental", + "Chile/EasterIsland", + "Cuba", + "EET", + "EST5EDT", + "Egypt", + "Eire", + "Etc/GMT", + "Etc/GMT+0", + "Etc/GMT+1", + "Etc/GMT+10", + "Etc/GMT+11", + "Etc/GMT+12", + "Etc/GMT+2", + "Etc/GMT+3", + "Etc/GMT+4", + "Etc/GMT+5", + "Etc/GMT+6", + "Etc/GMT+7", + "Etc/GMT+8", + "Etc/GMT+9", + "Etc/GMT-0", + "Etc/GMT-1", + "Etc/GMT-10", + "Etc/GMT-11", + "Etc/GMT-12", + "Etc/GMT-13", + "Etc/GMT-14", + "Etc/GMT-2", + "Etc/GMT-3", + "Etc/GMT-4", + "Etc/GMT-5", + "Etc/GMT-6", + "Etc/GMT-7", + "Etc/GMT-8", + "Etc/GMT-9", + "Etc/GMT0", + "Etc/Greenwich", + "Etc/UCT", + "Etc/UTC", + "Etc/Universal", + "Etc/Zulu", + "Europe/Amsterdam", + "Europe/Andorra", + "Europe/Astrakhan", + "Europe/Athens", + "Europe/Belfast", + "Europe/Belgrade", + "Europe/Berlin", + "Europe/Bratislava", + "Europe/Brussels", + "Europe/Bucharest", + "Europe/Budapest", + "Europe/Busingen", + "Europe/Chisinau", + "Europe/Copenhagen", + "Europe/Dublin", + "Europe/Gibraltar", + "Europe/Guernsey", + "Europe/Helsinki", + "Europe/Isle_of_Man", + "Europe/Istanbul", + "Europe/Jersey", + "Europe/Kaliningrad", + "Europe/Kiev", + "Europe/Kirov", + "Europe/Kyiv", + "Europe/Lisbon", + "Europe/Ljubljana", + "Europe/London", + "Europe/Luxembourg", + "Europe/Madrid", + "Europe/Malta", + "Europe/Mariehamn", + "Europe/Minsk", + "Europe/Monaco", + "Europe/Moscow", + "Europe/Nicosia", + "Europe/Oslo", + "Europe/Paris", + "Europe/Podgorica", + "Europe/Prague", + "Europe/Riga", + "Europe/Rome", + "Europe/Samara", + "Europe/San_Marino", + "Europe/Sarajevo", + "Europe/Saratov", + "Europe/Simferopol", + "Europe/Skopje", + "Europe/Sofia", + "Europe/Stockholm", + "Europe/Tallinn", + "Europe/Tirane", + "Europe/Tiraspol", + "Europe/Ulyanovsk", + "Europe/Uzhgorod", + "Europe/Vaduz", + "Europe/Vatican", + "Europe/Vienna", + "Europe/Vilnius", + "Europe/Volgograd", + "Europe/Warsaw", + "Europe/Zagreb", + "Europe/Zaporozhye", + "Europe/Zurich", + "GB", + "GB-Eire", + "GMT", + "GMT0", + "Greenwich", + "Hongkong", + "Iceland", + "Indian/Antananarivo", + "Indian/Chagos", + "Indian/Christmas", + "Indian/Cocos", + "Indian/Comoro", + "Indian/Kerguelen", + "Indian/Mahe", + "Indian/Maldives", + "Indian/Mauritius", + "Indian/Mayotte", + "Indian/Reunion", + "Iran", + "Israel", + "Jamaica", + "Japan", + "Kwajalein", + "Libya", + "MET", + "MST7MDT", + "Mexico/BajaNorte", + "Mexico/BajaSur", + "Mexico/General", + "NZ", + "NZ-CHAT", + "Navajo", + "PRC", + "PST8PDT", + "Pacific/Apia", + "Pacific/Auckland", + "Pacific/Bougainville", + "Pacific/Chatham", + "Pacific/Chuuk", + "Pacific/Easter", + "Pacific/Efate", + "Pacific/Enderbury", + "Pacific/Fakaofo", + "Pacific/Fiji", + "Pacific/Funafuti", + "Pacific/Galapagos", + "Pacific/Gambier", + "Pacific/Guadalcanal", + "Pacific/Guam", + "Pacific/Honolulu", + "Pacific/Johnston", + "Pacific/Kanton", + "Pacific/Kiritimati", + "Pacific/Kosrae", + "Pacific/Kwajalein", + "Pacific/Majuro", + "Pacific/Marquesas", + "Pacific/Midway", + "Pacific/Nauru", + "Pacific/Niue", + "Pacific/Norfolk", + "Pacific/Noumea", + "Pacific/Pago_Pago", + "Pacific/Palau", + "Pacific/Pitcairn", + "Pacific/Pohnpei", + "Pacific/Ponape", + "Pacific/Port_Moresby", + "Pacific/Rarotonga", + "Pacific/Saipan", + "Pacific/Samoa", + "Pacific/Tahiti", + "Pacific/Tarawa", + "Pacific/Tongatapu", + "Pacific/Truk", + "Pacific/Wake", + "Pacific/Wallis", + "Pacific/Yap", + "Poland", + "Portugal", + "ROK", + "Singapore", + "SystemV/AST4", + "SystemV/AST4ADT", + "SystemV/CST6", + "SystemV/CST6CDT", + "SystemV/EST5", + "SystemV/EST5EDT", + "SystemV/HST10", + "SystemV/MST7", + "SystemV/MST7MDT", + "SystemV/PST8", + "SystemV/PST8PDT", + "SystemV/YST9", + "SystemV/YST9YDT", + "Turkey", + "UCT", + "US/Alaska", + "US/Aleutian", + "US/Arizona", + "US/Central", + "US/East-Indiana", + "US/Eastern", + "US/Hawaii", + "US/Indiana-Starke", + "US/Michigan", + "US/Mountain", + "US/Pacific", + "US/Samoa", + "UTC", + "Universal", + "W-SU", + "WET", + "Zulu", + "EST", + "HST", + "MST", + "ACT", + "AET", + "AGT", + "ART", + "AST", + "BET", + "BST", + "CAT", + "CNT", + "CST", + "CTT", + "EAT", + "ECT", + "IET", + "IST", + "JST", + "MIT", + "NET", + "NST", + "PLT", + "PNT", + "PRT", + "PST", + "SST", + "VST" + ] + }, + "frequency": { + "description": "Frequency settings for the scheduled job.", + "allOf": [ + { + "$ref": "#/components/schemas/FrequencyInput" + } + ] + }, + "recipient_details": { + "description": "Recipients of the scheduled job notifications. Add the GUID or name of the ThoughtSpot users or groups as recipients in the `principals` array. If a recipient is not a ThoughtSpot user, specify email address.", + "allOf": [ + { + "$ref": "#/components/schemas/RecipientDetailsInput" + } + ] + }, + "personalised_view_id": { + "description": "Personalised view id of the liveboard to be scheduled.", + "type": "string" + } + }, + "required": [ + "name", + "description", + "metadata_type", + "metadata_identifier", + "time_zone", + "recipient_details" + ] + }, + "SearchSchedulesRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects associated with the scheduled jobs.", + "type": "array", + "items": { + "$ref": "#/components/schemas/MetadataInput" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included.", + "type": "integer", + "format": "int32" + }, + "sort_options": { + "description": "Sort options.", + "allOf": [ + { + "$ref": "#/components/schemas/SortingOptions" + } + ] + }, + "history_runs_options": { + "description": "Options while fetching history runs for the schedule.", + "allOf": [ + { + "$ref": "#/components/schemas/ScheduleHistoryRunsOptionsInput" + } + ] + }, + "schedule_identifiers": { + "description": "unique ID or name of the Schedule", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UpdateScheduleRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the scheduled job.", + "type": "string" + }, + "description": { + "description": "Description of the scheduled job.", + "type": "string" + }, + "metadata_type": { + "description": "Type of metadata object.", + "type": "string", + "enum": [ + "LIVEBOARD" + ] + }, + "metadata_identifier": { + "description": "Unique ID or name of the metadata object.", + "type": "string" + }, + "file_format": { + "description": "Export file format.", + "type": "string", + "enum": [ + "CSV", + "PDF", + "XLSX" + ] + }, + "liveboard_options": { + "description": "Options to specify the details of a Liveboard.", + "allOf": [ + { + "$ref": "#/components/schemas/LiveboardOptionsInput" + } + ] + }, + "pdf_options": { + "description": "Options for PDF export.", + "allOf": [ + { + "$ref": "#/components/schemas/SchedulesPdfOptionsInput" + } + ] + }, + "time_zone": { + "description": "Time zone", + "type": "string", + "enum": [ + "Africa/Abidjan", + "Africa/Accra", + "Africa/Addis_Ababa", + "Africa/Algiers", + "Africa/Asmara", + "Africa/Asmera", + "Africa/Bamako", + "Africa/Bangui", + "Africa/Banjul", + "Africa/Bissau", + "Africa/Blantyre", + "Africa/Brazzaville", + "Africa/Bujumbura", + "Africa/Cairo", + "Africa/Casablanca", + "Africa/Ceuta", + "Africa/Conakry", + "Africa/Dakar", + "Africa/Dar_es_Salaam", + "Africa/Djibouti", + "Africa/Douala", + "Africa/El_Aaiun", + "Africa/Freetown", + "Africa/Gaborone", + "Africa/Harare", + "Africa/Johannesburg", + "Africa/Juba", + "Africa/Kampala", + "Africa/Khartoum", + "Africa/Kigali", + "Africa/Kinshasa", + "Africa/Lagos", + "Africa/Libreville", + "Africa/Lome", + "Africa/Luanda", + "Africa/Lubumbashi", + "Africa/Lusaka", + "Africa/Malabo", + "Africa/Maputo", + "Africa/Maseru", + "Africa/Mbabane", + "Africa/Mogadishu", + "Africa/Monrovia", + "Africa/Nairobi", + "Africa/Ndjamena", + "Africa/Niamey", + "Africa/Nouakchott", + "Africa/Ouagadougou", + "Africa/Porto-Novo", + "Africa/Sao_Tome", + "Africa/Timbuktu", + "Africa/Tripoli", + "Africa/Tunis", + "Africa/Windhoek", + "America/Adak", + "America/Anchorage", + "America/Anguilla", + "America/Antigua", + "America/Araguaina", + "America/Argentina/Buenos_Aires", + "America/Argentina/Catamarca", + "America/Argentina/ComodRivadavia", + "America/Argentina/Cordoba", + "America/Argentina/Jujuy", + "America/Argentina/La_Rioja", + "America/Argentina/Mendoza", + "America/Argentina/Rio_Gallegos", + "America/Argentina/Salta", + "America/Argentina/San_Juan", + "America/Argentina/San_Luis", + "America/Argentina/Tucuman", + "America/Argentina/Ushuaia", + "America/Aruba", + "America/Asuncion", + "America/Atikokan", + "America/Atka", + "America/Bahia", + "America/Bahia_Banderas", + "America/Barbados", + "America/Belem", + "America/Belize", + "America/Blanc-Sablon", + "America/Boa_Vista", + "America/Bogota", + "America/Boise", + "America/Buenos_Aires", + "America/Cambridge_Bay", + "America/Campo_Grande", + "America/Cancun", + "America/Caracas", + "America/Catamarca", + "America/Cayenne", + "America/Cayman", + "America/Chicago", + "America/Chihuahua", + "America/Coral_Harbour", + "America/Cordoba", + "America/Costa_Rica", + "America/Creston", + "America/Cuiaba", + "America/Curacao", + "America/Danmarkshavn", + "America/Dawson", + "America/Dawson_Creek", + "America/Denver", + "America/Detroit", + "America/Dominica", + "America/Edmonton", + "America/Eirunepe", + "America/El_Salvador", + "America/Ensenada", + "America/Fort_Nelson", + "America/Fort_Wayne", + "America/Fortaleza", + "America/Glace_Bay", + "America/Godthab", + "America/Goose_Bay", + "America/Grand_Turk", + "America/Grenada", + "America/Guadeloupe", + "America/Guatemala", + "America/Guayaquil", + "America/Guyana", + "America/Halifax", + "America/Havana", + "America/Hermosillo", + "America/Indiana/Indianapolis", + "America/Indiana/Knox", + "America/Indiana/Marengo", + "America/Indiana/Petersburg", + "America/Indiana/Tell_City", + "America/Indiana/Vevay", + "America/Indiana/Vincennes", + "America/Indiana/Winamac", + "America/Indianapolis", + "America/Inuvik", + "America/Iqaluit", + "America/Jamaica", + "America/Jujuy", + "America/Juneau", + "America/Kentucky/Louisville", + "America/Kentucky/Monticello", + "America/Knox_IN", + "America/Kralendijk", + "America/La_Paz", + "America/Lima", + "America/Los_Angeles", + "America/Louisville", + "America/Lower_Princes", + "America/Maceio", + "America/Managua", + "America/Manaus", + "America/Marigot", + "America/Martinique", + "America/Matamoros", + "America/Mazatlan", + "America/Mendoza", + "America/Menominee", + "America/Merida", + "America/Metlakatla", + "America/Mexico_City", + "America/Miquelon", + "America/Moncton", + "America/Monterrey", + "America/Montevideo", + "America/Montreal", + "America/Montserrat", + "America/Nassau", + "America/New_York", + "America/Nipigon", + "America/Nome", + "America/Noronha", + "America/North_Dakota/Beulah", + "America/North_Dakota/Center", + "America/North_Dakota/New_Salem", + "America/Nuuk", + "America/Ojinaga", + "America/Panama", + "America/Pangnirtung", + "America/Paramaribo", + "America/Phoenix", + "America/Port-au-Prince", + "America/Port_of_Spain", + "America/Porto_Acre", + "America/Porto_Velho", + "America/Puerto_Rico", + "America/Punta_Arenas", + "America/Rainy_River", + "America/Rankin_Inlet", + "America/Recife", + "America/Regina", + "America/Resolute", + "America/Rio_Branco", + "America/Rosario", + "America/Santa_Isabel", + "America/Santarem", + "America/Santiago", + "America/Santo_Domingo", + "America/Sao_Paulo", + "America/Scoresbysund", + "America/Shiprock", + "America/Sitka", + "America/St_Barthelemy", + "America/St_Johns", + "America/St_Kitts", + "America/St_Lucia", + "America/St_Thomas", + "America/St_Vincent", + "America/Swift_Current", + "America/Tegucigalpa", + "America/Thule", + "America/Thunder_Bay", + "America/Tijuana", + "America/Toronto", + "America/Tortola", + "America/Vancouver", + "America/Virgin", + "America/Whitehorse", + "America/Winnipeg", + "America/Yakutat", + "America/Yellowknife", + "Antarctica/Casey", + "Antarctica/Davis", + "Antarctica/DumontDUrville", + "Antarctica/Macquarie", + "Antarctica/Mawson", + "Antarctica/McMurdo", + "Antarctica/Palmer", + "Antarctica/Rothera", + "Antarctica/South_Pole", + "Antarctica/Syowa", + "Antarctica/Troll", + "Antarctica/Vostok", + "Arctic/Longyearbyen", + "Asia/Aden", + "Asia/Almaty", + "Asia/Amman", + "Asia/Anadyr", + "Asia/Aqtau", + "Asia/Aqtobe", + "Asia/Ashgabat", + "Asia/Ashkhabad", + "Asia/Atyrau", + "Asia/Baghdad", + "Asia/Bahrain", + "Asia/Baku", + "Asia/Bangkok", + "Asia/Barnaul", + "Asia/Beirut", + "Asia/Bishkek", + "Asia/Brunei", + "Asia/Calcutta", + "Asia/Chita", + "Asia/Choibalsan", + "Asia/Chongqing", + "Asia/Chungking", + "Asia/Colombo", + "Asia/Dacca", + "Asia/Damascus", + "Asia/Dhaka", + "Asia/Dili", + "Asia/Dubai", + "Asia/Dushanbe", + "Asia/Famagusta", + "Asia/Gaza", + "Asia/Harbin", + "Asia/Hebron", + "Asia/Ho_Chi_Minh", + "Asia/Hong_Kong", + "Asia/Hovd", + "Asia/Irkutsk", + "Asia/Istanbul", + "Asia/Jakarta", + "Asia/Jayapura", + "Asia/Jerusalem", + "Asia/Kabul", + "Asia/Kamchatka", + "Asia/Karachi", + "Asia/Kashgar", + "Asia/Kathmandu", + "Asia/Katmandu", + "Asia/Khandyga", + "Asia/Kolkata", + "Asia/Krasnoyarsk", + "Asia/Kuala_Lumpur", + "Asia/Kuching", + "Asia/Kuwait", + "Asia/Macao", + "Asia/Macau", + "Asia/Magadan", + "Asia/Makassar", + "Asia/Manila", + "Asia/Muscat", + "Asia/Nicosia", + "Asia/Novokuznetsk", + "Asia/Novosibirsk", + "Asia/Omsk", + "Asia/Oral", + "Asia/Phnom_Penh", + "Asia/Pontianak", + "Asia/Pyongyang", + "Asia/Qatar", + "Asia/Qostanay", + "Asia/Qyzylorda", + "Asia/Rangoon", + "Asia/Riyadh", + "Asia/Saigon", + "Asia/Sakhalin", + "Asia/Samarkand", + "Asia/Seoul", + "Asia/Shanghai", + "Asia/Singapore", + "Asia/Srednekolymsk", + "Asia/Taipei", + "Asia/Tashkent", + "Asia/Tbilisi", + "Asia/Tehran", + "Asia/Tel_Aviv", + "Asia/Thimbu", + "Asia/Thimphu", + "Asia/Tokyo", + "Asia/Tomsk", + "Asia/Ujung_Pandang", + "Asia/Ulaanbaatar", + "Asia/Ulan_Bator", + "Asia/Urumqi", + "Asia/Ust-Nera", + "Asia/Vientiane", + "Asia/Vladivostok", + "Asia/Yakutsk", + "Asia/Yangon", + "Asia/Yekaterinburg", + "Asia/Yerevan", + "Atlantic/Azores", + "Atlantic/Bermuda", + "Atlantic/Canary", + "Atlantic/Cape_Verde", + "Atlantic/Faeroe", + "Atlantic/Faroe", + "Atlantic/Jan_Mayen", + "Atlantic/Madeira", + "Atlantic/Reykjavik", + "Atlantic/South_Georgia", + "Atlantic/St_Helena", + "Atlantic/Stanley", + "Australia/ACT", + "Australia/Adelaide", + "Australia/Brisbane", + "Australia/Broken_Hill", + "Australia/Canberra", + "Australia/Currie", + "Australia/Darwin", + "Australia/Eucla", + "Australia/Hobart", + "Australia/LHI", + "Australia/Lindeman", + "Australia/Lord_Howe", + "Australia/Melbourne", + "Australia/NSW", + "Australia/North", + "Australia/Perth", + "Australia/Queensland", + "Australia/South", + "Australia/Sydney", + "Australia/Tasmania", + "Australia/Victoria", + "Australia/West", + "Australia/Yancowinna", + "Brazil/Acre", + "Brazil/DeNoronha", + "Brazil/East", + "Brazil/West", + "CET", + "CST6CDT", + "Canada/Atlantic", + "Canada/Central", + "Canada/Eastern", + "Canada/Mountain", + "Canada/Newfoundland", + "Canada/Pacific", + "Canada/Saskatchewan", + "Canada/Yukon", + "Chile/Continental", + "Chile/EasterIsland", + "Cuba", + "EET", + "EST5EDT", + "Egypt", + "Eire", + "Etc/GMT", + "Etc/GMT+0", + "Etc/GMT+1", + "Etc/GMT+10", + "Etc/GMT+11", + "Etc/GMT+12", + "Etc/GMT+2", + "Etc/GMT+3", + "Etc/GMT+4", + "Etc/GMT+5", + "Etc/GMT+6", + "Etc/GMT+7", + "Etc/GMT+8", + "Etc/GMT+9", + "Etc/GMT-0", + "Etc/GMT-1", + "Etc/GMT-10", + "Etc/GMT-11", + "Etc/GMT-12", + "Etc/GMT-13", + "Etc/GMT-14", + "Etc/GMT-2", + "Etc/GMT-3", + "Etc/GMT-4", + "Etc/GMT-5", + "Etc/GMT-6", + "Etc/GMT-7", + "Etc/GMT-8", + "Etc/GMT-9", + "Etc/GMT0", + "Etc/Greenwich", + "Etc/UCT", + "Etc/UTC", + "Etc/Universal", + "Etc/Zulu", + "Europe/Amsterdam", + "Europe/Andorra", + "Europe/Astrakhan", + "Europe/Athens", + "Europe/Belfast", + "Europe/Belgrade", + "Europe/Berlin", + "Europe/Bratislava", + "Europe/Brussels", + "Europe/Bucharest", + "Europe/Budapest", + "Europe/Busingen", + "Europe/Chisinau", + "Europe/Copenhagen", + "Europe/Dublin", + "Europe/Gibraltar", + "Europe/Guernsey", + "Europe/Helsinki", + "Europe/Isle_of_Man", + "Europe/Istanbul", + "Europe/Jersey", + "Europe/Kaliningrad", + "Europe/Kiev", + "Europe/Kirov", + "Europe/Kyiv", + "Europe/Lisbon", + "Europe/Ljubljana", + "Europe/London", + "Europe/Luxembourg", + "Europe/Madrid", + "Europe/Malta", + "Europe/Mariehamn", + "Europe/Minsk", + "Europe/Monaco", + "Europe/Moscow", + "Europe/Nicosia", + "Europe/Oslo", + "Europe/Paris", + "Europe/Podgorica", + "Europe/Prague", + "Europe/Riga", + "Europe/Rome", + "Europe/Samara", + "Europe/San_Marino", + "Europe/Sarajevo", + "Europe/Saratov", + "Europe/Simferopol", + "Europe/Skopje", + "Europe/Sofia", + "Europe/Stockholm", + "Europe/Tallinn", + "Europe/Tirane", + "Europe/Tiraspol", + "Europe/Ulyanovsk", + "Europe/Uzhgorod", + "Europe/Vaduz", + "Europe/Vatican", + "Europe/Vienna", + "Europe/Vilnius", + "Europe/Volgograd", + "Europe/Warsaw", + "Europe/Zagreb", + "Europe/Zaporozhye", + "Europe/Zurich", + "GB", + "GB-Eire", + "GMT", + "GMT0", + "Greenwich", + "Hongkong", + "Iceland", + "Indian/Antananarivo", + "Indian/Chagos", + "Indian/Christmas", + "Indian/Cocos", + "Indian/Comoro", + "Indian/Kerguelen", + "Indian/Mahe", + "Indian/Maldives", + "Indian/Mauritius", + "Indian/Mayotte", + "Indian/Reunion", + "Iran", + "Israel", + "Jamaica", + "Japan", + "Kwajalein", + "Libya", + "MET", + "MST7MDT", + "Mexico/BajaNorte", + "Mexico/BajaSur", + "Mexico/General", + "NZ", + "NZ-CHAT", + "Navajo", + "PRC", + "PST8PDT", + "Pacific/Apia", + "Pacific/Auckland", + "Pacific/Bougainville", + "Pacific/Chatham", + "Pacific/Chuuk", + "Pacific/Easter", + "Pacific/Efate", + "Pacific/Enderbury", + "Pacific/Fakaofo", + "Pacific/Fiji", + "Pacific/Funafuti", + "Pacific/Galapagos", + "Pacific/Gambier", + "Pacific/Guadalcanal", + "Pacific/Guam", + "Pacific/Honolulu", + "Pacific/Johnston", + "Pacific/Kanton", + "Pacific/Kiritimati", + "Pacific/Kosrae", + "Pacific/Kwajalein", + "Pacific/Majuro", + "Pacific/Marquesas", + "Pacific/Midway", + "Pacific/Nauru", + "Pacific/Niue", + "Pacific/Norfolk", + "Pacific/Noumea", + "Pacific/Pago_Pago", + "Pacific/Palau", + "Pacific/Pitcairn", + "Pacific/Pohnpei", + "Pacific/Ponape", + "Pacific/Port_Moresby", + "Pacific/Rarotonga", + "Pacific/Saipan", + "Pacific/Samoa", + "Pacific/Tahiti", + "Pacific/Tarawa", + "Pacific/Tongatapu", + "Pacific/Truk", + "Pacific/Wake", + "Pacific/Wallis", + "Pacific/Yap", + "Poland", + "Portugal", + "ROK", + "Singapore", + "SystemV/AST4", + "SystemV/AST4ADT", + "SystemV/CST6", + "SystemV/CST6CDT", + "SystemV/EST5", + "SystemV/EST5EDT", + "SystemV/HST10", + "SystemV/MST7", + "SystemV/MST7MDT", + "SystemV/PST8", + "SystemV/PST8PDT", + "SystemV/YST9", + "SystemV/YST9YDT", + "Turkey", + "UCT", + "US/Alaska", + "US/Aleutian", + "US/Arizona", + "US/Central", + "US/East-Indiana", + "US/Eastern", + "US/Hawaii", + "US/Indiana-Starke", + "US/Michigan", + "US/Mountain", + "US/Pacific", + "US/Samoa", + "UTC", + "Universal", + "W-SU", + "WET", + "Zulu", + "EST", + "HST", + "MST", + "ACT", + "AET", + "AGT", + "ART", + "AST", + "BET", + "BST", + "CAT", + "CNT", + "CST", + "CTT", + "EAT", + "ECT", + "IET", + "IST", + "JST", + "MIT", + "NET", + "NST", + "PLT", + "PNT", + "PRT", + "PST", + "SST", + "VST" + ] + }, + "frequency": { + "description": "Frequency of the scheduled job run.", + "allOf": [ + { + "$ref": "#/components/schemas/FrequencyInput" + } + ] + }, + "recipient_details": { + "description": "Recipients of the scheduled job notifications. You can add the ID or name of the ThoughtSpot users or groups as recipients in the `principals` array. If a recipient is not a ThoughtSpot user, specify email address.", + "allOf": [ + { + "$ref": "#/components/schemas/RecipientDetailsInput" + } + ] + }, + "status": { + "description": "Status of the schedule", + "type": "string", + "enum": [ + "ACTIVE", + "PAUSE" + ] + }, + "personalised_view_id": { + "description": "Personalised view id of the liveboard to be scheduled.", + "type": "string" + } + } + }, + "AssignChangeAuthorRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "GUID or name of the metadata object.", + "type": "array", + "items": { + "$ref": "#/components/schemas/AuthorMetadataTypeInput" + } + }, + "user_identifier": { + "description": "GUID or name of the user who you want to assign as the author.", + "type": "string" + }, + "current_owner_identifier": { + "description": "GUID or name of the current author. When defined, the metadata objects\nauthored by the specified owner are filtered for the API operation.", + "type": "string" + } + }, + "required": [ + "metadata", + "user_identifier" + ] + }, + "FetchColumnSecurityRulesRequest": { + "type": "object", + "properties": { + "tables": { + "description": "Array of table identifier objects for which to fetch column security rules", + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnSecurityRuleTableInput" + } + } + }, + "required": [ + "tables" + ] + }, + "FetchObjectPrivilegesRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects for which you want to fetch object privileges. For now only LOGICAL_TABLE is supported. It may be extended to other metadata types in the future.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectPrivilegesMetadataInput" + } + }, + "principals": { + "description": "User or group objects for which you want to fetch object privileges.\nIf not specified, the API returns all users and groups that\nhave object privileges on the specified metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PrincipalsInput" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included for each metadata type.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included for each metadata type.", + "default": 20, + "type": "integer", + "format": "int32" + } + }, + "required": [ + "metadata" + ] + }, + "FetchPermissionsOfPrincipalsRequest": { + "type": "object", + "properties": { + "principals": { + "description": "GUID or name of the user or group.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PrincipalsInput" + } + }, + "metadata": { + "description": "Metadata objects for which you want to fetch permission details.\nIf not specified, the API returns permission details for all\nmetadata objects that the specified users and groups can access.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionsMetadataTypeInput" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included for each metadata type.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included for each metadata type.", + "default": -1, + "type": "integer", + "format": "int32" + }, + "default_metadata_type": { + "description": "When no metadata objects input is passed, metadata objects of this type are fetched.", + "type": "string", + "enum": [ + "ALL", + "LIVEBOARD", + "ANSWER", + "LOGICAL_TABLE", + "LOGICAL_COLUMN", + "CONNECTION" + ] + } + }, + "required": [ + "principals" + ] + }, + "FetchPermissionsOnMetadataRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "GUID or name of the metadata object.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionsMetadataTypeInput" + } + }, + "principals": { + "description": "User or group objects for which you want to fetch permissions.\nIf not specified, the API returns all users and groups that\ncan access the specified metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PrincipalsInput" + } + }, + "include_dependent_objects": { + "description": "Indicates whether to fetch permissions of dependent metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "record_offset": { + "description": "The starting record number from where the records should be included for each metadata type.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included for each metadata type.", + "default": -1, + "type": "integer", + "format": "int32" + }, + "permission_type": { + "description": "
Version: 10.3.0.cl or later
\n\nSpecifies the type of permission. Valid values are:\n EFFECTIVE - If the user permission to the metadata objects is granted by the privileges assigned to the groups to which they belong.\n DEFINED - If a user or user group received access to metadata objects via object sharing by another user.", + "type": "string" + } + }, + "required": [ + "metadata" + ] + }, + "ManageObjectPrivilegeRequest": { + "type": "object", + "properties": { + "operation": { + "description": "Operation to perform to manage object privileges. Available operations are: `ADD`, `REMOVE`.", + "type": "string", + "enum": [ + "ADD", + "REMOVE" + ] + }, + "metadata_type": { + "description": "Type of metadata objects on which you want to perform the operation. For now only LOGICAL_TABLE is supported. It may be extended to other metadata types in the future.", + "type": "string", + "enum": [ + "LOGICAL_TABLE" + ] + }, + "object_privilege_types": { + "description": "List of object privilege types on which you want to perform the operation.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "SPOTTER_COACHING_PRIVILEGE" + ] + } + }, + "metadata_identifiers": { + "description": "List of metadata identifiers (GUID or name) on which you want to perform the operation.", + "type": "array", + "items": { + "type": "string" + } + }, + "principals": { + "description": "User or group objects (GUID or name) to which you want to apply the given operation and given object privileges.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PrincipalsInput" + } + } + }, + "required": [ + "operation", + "metadata_type", + "object_privilege_types", + "metadata_identifiers", + "principals" + ] + }, + "PublishMetadataRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects to be published.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PublishMetadataListItem" + } + }, + "org_identifiers": { + "description": "Unique ID or name of orgs to which metadata objects should be published.", + "type": "array", + "items": { + "type": "string" + } + }, + "skip_validation": { + "description": "Skip validations of objects to be published.", + "type": "boolean", + "nullable": true + } + }, + "required": [ + "metadata", + "org_identifiers" + ] + }, + "ShareMetadataRequest": { + "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.\n4. LOGICAL_COLUMN\n5. Connection", + "type": "string", + "enum": [ + "LIVEBOARD", + "ANSWER", + "LOGICAL_TABLE", + "LOGICAL_COLUMN", + "CONNECTION" + ] + }, + "metadata_identifiers": { + "description": "Unique ID or name of metadata objects. Note: All the names should belong to same metadata_type", + "type": "array", + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Metadata details for sharing objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShareMetadataTypeInput" + } + }, + "permissions": { + "description": "Permission details for sharing the objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SharePermissionsInput" + } + }, + "visualization_identifiers": { + "description": "Options to specify details of Liveboard. First Liveboard encountered in payload is considered to be the corresponding Liveboard.", + "type": "array", + "items": { + "type": "string" + } + }, + "emails": { + "description": "Email IDs to which notifications will be sent.", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "description": "Message to be included in notification.", + "type": "string" + }, + "enable_custom_url": { + "description": "Sends object URLs in the customized format in email notifications.", + "default": false, + "type": "boolean", + "nullable": true + }, + "notify_on_share": { + "description": "Flag to notify user when any object is shared.", + "default": true, + "type": "boolean", + "nullable": true + }, + "has_lenient_discoverability": { + "description": "Flag to make the object discoverable.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "permissions", + "message" + ] + }, + "UnpublishMetadataRequest": { + "type": "object", + "properties": { + "force": { + "description": "Force unpublishes the object. This will break all the dependent objects in the unpublished orgs.", + "type": "boolean", + "nullable": true + }, + "include_dependencies": { + "description": "Should we unpublish all the dependencies for the objects specified.\nThe dependencies will be unpublished if no other published object is using it.", + "type": "boolean" + }, + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PublishMetadataListItem" + } + }, + "org_identifiers": { + "description": "Unique ID or name of orgs.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "include_dependencies", + "metadata", + "org_identifiers" + ] + }, + "UpdateColumnSecurityRulesRequest": { + "type": "object", + "properties": { + "identifier": { + "description": "GUID or name of the table for which we want to create column security rules", + "type": "string" + }, + "obj_identifier": { + "description": "The object ID of the table", + "type": "string" + }, + "clear_csr": { + "description": "If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed", + "type": "boolean", + "nullable": true + }, + "column_security_rules": { + "description": "Array where each object defines the security rule for a specific column", + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnSecurityRuleUpdate" + } + } + }, + "required": [ + "column_security_rules" + ] + }, + "ConfigureCommunicationChannelPreferencesRequest": { + "type": "object", + "properties": { + "cluster_preferences": { + "description": "Cluster-level default configurations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/EventChannelConfigInput" + } + }, + "org_preferences": { + "description": "Org-specific configurations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrgChannelConfigInput" + } + } + } + }, + "ConfigureSecuritySettingsRequest": { + "type": "object", + "properties": { + "cluster_preferences": { + "description": "Cluster-level security preferences.", + "allOf": [ + { + "$ref": "#/components/schemas/SecuritySettingsClusterPreferencesInput" + } + ] + }, + "org_preferences": { + "description": "Org-level security preferences for the current org.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SecuritySettingsOrgPreferencesInput" + } + } + } + }, + "SearchCommunicationChannelPreferencesRequest": { + "type": "object", + "properties": { + "cluster_preferences": { + "description": "Event types to search for in cluster-level preferences.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ] + } + }, + "org_preferences": { + "description": "Org-specific search criteria.", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrgPreferenceSearchCriteriaInput" + } + } + } + }, + "SearchSecuritySettingsRequest": { + "type": "object", + "properties": { + "scope": { + "description": "Scope of security settings to retrieve. CLUSTER returns cluster-level settings,\nORG returns org-level settings for the current org.\nIf not specified, returns both cluster and org settings based on user privileges.", + "type": "string", + "enum": [ + "CLUSTER", + "ORG" + ] + } + } + }, + "UpdateSystemConfigRequest": { + "type": "object", + "properties": { + "configuration": { + "description": "Configuration JSON with the key-value pair of configuration attributes to be updated.", + "type": "object" + } + }, + "required": [ + "configuration" + ] + }, + "ValidateCommunicationChannelRequest": { + "type": "object", + "properties": { + "channel_type": { + "description": "Type of communication channel to validate (e.g., WEBHOOK).", + "type": "string", + "enum": [ + "WEBHOOK" + ] + }, + "channel_identifier": { + "description": "Unique identifier or name for the communication channel.", + "type": "string" + }, + "event_type": { + "description": "Event type to validate for this channel.", + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ] + } + }, + "required": [ + "channel_type", + "channel_identifier", + "event_type" + ] + }, + "AssignTagRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagMetadataTypeInput" + } + }, + "tag_identifiers": { + "description": "GUID or name of the tag.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "metadata", + "tag_identifiers" + ] + }, + "CreateTagRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the tag.", + "type": "string" + }, + "color": { + "description": "Hex color code to be assigned to the tag. For example, #ff78a9.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "SearchTagsRequest": { + "type": "object", + "properties": { + "tag_identifier": { + "description": "Name or Id of the tag.", + "type": "string" + }, + "name_pattern": { + "description": "A pattern to match case-insensitive name of the Tag object.", + "type": "string" + }, + "color": { + "description": "Color of the tag.", + "type": "string" + } + } + }, + "UnassignTagRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagMetadataTypeInput" + } + }, + "tag_identifiers": { + "description": "GUID or name of the tag.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "metadata", + "tag_identifiers" + ] + }, + "UpdateTagRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the tag.", + "type": "string" + }, + "color": { + "description": "Hex color code to be assigned to the tag. For example, #ff78a9.", + "type": "string" + } + } + }, + "ActivateUserRequest": { + "type": "object", + "properties": { + "user_identifier": { + "description": "Unique ID or name of the user.", + "type": "string" + }, + "auth_token": { + "description": "Auth token for the user.", + "type": "string" + }, + "password": { + "description": "New password for the user to access the account.", + "type": "string" + }, + "properties": { + "description": "Properties of the user.", + "type": "string" + } + }, + "required": [ + "user_identifier", + "auth_token", + "password" + ] + }, + "ChangeUserPasswordRequest": { + "type": "object", + "properties": { + "current_password": { + "description": "Current password of the user.", + "type": "string" + }, + "new_password": { + "description": "New password for the user.", + "type": "string" + }, + "user_identifier": { + "description": "GUID or name of the user.", + "type": "string" + } + }, + "required": [ + "current_password", + "new_password", + "user_identifier" + ] + }, + "CreateUserRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the user. The username string must be unique.", + "type": "string" + }, + "display_name": { + "description": "A unique display name string for the user account, usually their first and last name", + "type": "string" + }, + "password": { + "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": { + "description": "Email of the user account", + "type": "string" + }, + "account_type": { + "description": "Type of the account.", + "default": "LOCAL_USER", + "type": "string", + "enum": [ + "LOCAL_USER", + "LDAP_USER", + "SAML_USER", + "OIDC_USER", + "REMOTE_USER" + ] + }, + "account_status": { + "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": [ + "ACTIVE", + "INACTIVE", + "EXPIRED", + "LOCKED", + "PENDING", + "SUSPENDED" + ] + }, + "org_identifiers": { + "description": "List of Org IDs to which the user belongs.", + "type": "array", + "items": { + "type": "string" + } + }, + "group_identifiers": { + "description": "GUIDs or names of the groups to which the newly created user belongs.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "description": "Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object.", + "default": "SHARABLE", + "type": "string", + "enum": [ + "SHARABLE", + "NON_SHARABLE" + ] + }, + "notify_on_share": { + "description": "User preference for receiving email notifications when another ThoughtSpot\nuser shares a metadata object such as Answer, Liveboard, or Worksheet.", + "default": true, + "type": "boolean", + "nullable": true + }, + "show_onboarding_experience": { + "description": "The user preference for revisiting the onboarding experience.", + "default": true, + "type": "boolean", + "nullable": true + }, + "onboarding_experience_completed": { + "description": "flag to get the on-boarding experience is completed or not.", + "default": false, + "type": "boolean", + "nullable": true + }, + "home_liveboard_identifier": { + "description": "GUID of the Liveboard to set a default Liveboard for the user.\nThoughtSpot displays this Liveboard on the Home page when the user logs in.", + "type": "string" + }, + "favorite_metadata": { + "description": "Metadata objects to add to the user's favorites list.", + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteMetadataInput" + } + }, + "preferred_locale": { + "description": "Locale for the user. When setting this value, do not set use_browser_language\nto true, otherwise the browser's language setting will take precedence and the\npreferred_locale value will be ignored.", + "type": "string", + "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", + "de-CH", + "en-NZ", + "es-MX", + "en-AU", + "zh-Hant", + "ko-KR", + "en-DE" + ] + }, + "use_browser_language": { + "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", + "type": "boolean", + "nullable": true + }, + "extended_properties": { + "description": "Properties for the user", + "type": "object" + }, + "extended_preferences": { + "description": "Preferences for the user", + "type": "object" + }, + "trigger_welcome_email": { + "description": "Flag to indicate whether welcome email should be sent to user. This parameter is applied only on clusters on which IAM is disabled.", + "type": "boolean", + "nullable": true + }, + "trigger_activation_email": { + "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 + } + }, + "required": [ + "name", + "display_name", + "email" + ] + }, + "DeactivateUserRequest": { + "type": "object", + "properties": { + "user_identifier": { + "description": "Unique ID or name of the user.", + "type": "string" + }, + "base_url": { + "description": "Base url of the cluster.", + "type": "string" + } + }, + "required": [ + "user_identifier", + "base_url" + ] + }, + "ForceLogoutUsersRequest": { + "type": "object", + "properties": { + "user_identifiers": { + "description": "GUID or name of the users for force logging out their sessions.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ImportUsersRequest": { + "type": "object", + "properties": { + "users": { + "description": "List of users needs to be imported.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportUser" + } + }, + "default_password": { + "description": "The default password to assign to users if they do not have a password assigned in ThoughtSpot.", + "type": "string" + }, + "dry_run": { + "description": "If true, the API performs a test operation and returns user IDs whose data will be edited after the import.", + "default": true, + "type": "boolean", + "nullable": true + }, + "delete_unspecified_users": { + "description": "If set to true, removes the users that are not specified in the API request.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "users" + ] + }, + "ResetUserPasswordRequest": { + "type": "object", + "properties": { + "new_password": { + "description": "New password for the user.", + "type": "string" + }, + "user_identifier": { + "description": "GUID or name of the user.", + "type": "string" + } + }, + "required": [ + "new_password", + "user_identifier" + ] + }, + "SearchUsersRequest": { + "type": "object", + "properties": { + "user_identifier": { + "description": "GUID / name of the user to search", + "type": "string" + }, + "display_name": { + "description": "A unique display name string for the user account, usually their first and last name", + "type": "string" + }, + "name_pattern": { + "description": "A pattern to match case-insensitive name of the User object.", + "type": "string" + }, + "visibility": { + "description": "Visibility of the user", + "type": "string", + "enum": [ + "SHARABLE", + "NON_SHARABLE" + ] + }, + "email": { + "description": "Email of the user account", + "type": "string" + }, + "group_identifiers": { + "description": "GUID or name of the group to which the user belongs", + "type": "array", + "items": { + "type": "string" + } + }, + "privileges": { + "description": "Privileges assigned to the user", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ADMINISTRATION", + "AUTHORING", + "USERDATAUPLOADING", + "DATADOWNLOADING", + "USERMANAGEMENT", + "DATAMANAGEMENT", + "SHAREWITHALL", + "JOBSCHEDULING", + "A3ANALYSIS", + "EXPERIMENTALFEATUREPRIVILEGE", + "BYPASSRLS", + "RANALYSIS", + "DEVELOPER", + "USER_ADMINISTRATION", + "GROUP_ADMINISTRATION", + "SYNCMANAGEMENT", + "CAN_CREATE_CATALOG", + "DISABLE_PINBOARD_CREATION", + "LIVEBOARD_VERIFIER", + "PREVIEW_THOUGHTSPOT_SAGE", + "APPLICATION_ADMINISTRATION", + "SYSTEM_INFO_ADMINISTRATION", + "ORG_ADMINISTRATION", + "ROLE_ADMINISTRATION", + "AUTHENTICATION_ADMINISTRATION", + "BILLING_INFO_ADMINISTRATION", + "CAN_MANAGE_CUSTOM_CALENDAR", + "CAN_CREATE_OR_EDIT_CONNECTIONS", + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO", + "PREVIEW_DOCUMENT_SEARCH", + "CAN_MODIFY_FOLDERS", + "CAN_MANAGE_VARIABLES", + "CAN_VIEW_FOLDERS", + "CAN_SETUP_VERSION_CONTROL", + "CAN_MANAGE_WEBHOOKS", + "CAN_DOWNLOAD_VISUALS", + "CAN_DOWNLOAD_DETAILED_DATA", + "CAN_USE_SPOTTER" + ] + } + }, + "account_type": { + "description": "Type of the account", + "type": "string", + "enum": [ + "LOCAL_USER", + "LDAP_USER", + "SAML_USER", + "OIDC_USER", + "REMOTE_USER" + ] + }, + "account_status": { + "description": "Current status of the user account.", + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE", + "EXPIRED", + "LOCKED", + "PENDING", + "SUSPENDED" + ] + }, + "notify_on_share": { + "description": "User preference for receiving email notifications when another ThoughtSpot user\nshares a metadata object such as Answer, Liveboard, or Worksheet.", + "type": "boolean", + "nullable": true + }, + "show_onboarding_experience": { + "description": "The user preference for revisiting the onboarding experience", + "type": "boolean", + "nullable": true + }, + "onboarding_experience_completed": { + "description": "Indicates if the user has completed the onboarding walkthrough", + "type": "boolean", + "nullable": true + }, + "org_identifiers": { + "description": "IDs or names of the Orgs to which the user belongs", + "type": "array", + "items": { + "type": "string" + } + }, + "home_liveboard_identifier": { + "description": "Unique ID or name of the user's home Liveboard.", + "type": "string" + }, + "favorite_metadata": { + "description": "Metadata objects which are assigned as favorites of the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteMetadataInput" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included.", + "default": 10, + "type": "integer", + "format": "int32" + }, + "sort_options": { + "description": "Sort options.", + "allOf": [ + { + "$ref": "#/components/schemas/SortOptions" + } + ] + }, + "role_identifiers": { + "description": "Filters by the role assigned to the user.", + "type": "array", + "items": { + "type": "string" + } + }, + "include_favorite_metadata": { + "description": "Indicates if the user's favorite objects should be displayed.", + "default": false, + "type": "boolean", + "nullable": true + }, + "include_variable_values": { + "description": "Indicates if the user's formula variable values should be included in the response.", + "default": false, + "type": "boolean", + "nullable": true + } + } + }, + "UpdateUserRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the user. The username string must be unique.", + "type": "string" + }, + "display_name": { + "description": "A unique display name string for the user account, usually their first and last name", + "type": "string" + }, + "visibility": { + "description": "Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object.", + "type": "string", + "enum": [ + "SHARABLE", + "NON_SHARABLE" + ] + }, + "email": { + "description": "Email of the user account", + "type": "string" + }, + "account_status": { + "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", + "SUSPENDED" + ] + }, + "notify_on_share": { + "description": "User preference for receiving email notifications when another ThoughtSpot user\nshares a metadata object such as Answer, Liveboard, or Worksheet.", + "type": "boolean", + "nullable": true + }, + "show_onboarding_experience": { + "description": "The user preference for revisiting the onboarding experience.", + "type": "boolean", + "nullable": true + }, + "onboarding_experience_completed": { + "description": "Indicates if the user has completed the onboarding and allows turning off the onboarding walkthrough.", + "type": "boolean", + "nullable": true + }, + "account_type": { + "description": "Type of the account.", + "type": "string", + "enum": [ + "LOCAL_USER", + "LDAP_USER", + "SAML_USER", + "OIDC_USER", + "REMOTE_USER" + ] + }, + "group_identifiers": { + "description": "GUIDs or names of the groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "home_liveboard_identifier": { + "description": "GUID of the Liveboard to set a default Liveboard for the user. ThoughtSpot displays\nthis Liveboard on the Home page when the user logs in.", + "type": "string" + }, + "favorite_metadata": { + "description": "Metadata objects to add to the user's favorites list.", + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteMetadataInput" + } + }, + "org_identifiers": { + "description": "IDs of the Orgs.", + "type": "array", + "items": { + "type": "string" + } + }, + "operation": { + "description": "Type of update operation. Default operation type is REPLACE", + "default": "REPLACE", + "type": "string", + "enum": [ + "ADD", + "REMOVE", + "REPLACE" + ] + }, + "preferred_locale": { + "description": "Locale for the user. When setting this value, do not set use_browser_language\nto true, otherwise the browser's language setting will take precedence and the\npreferred_locale value will be ignored.", + "type": "string", + "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", + "de-CH", + "en-NZ", + "es-MX", + "en-AU", + "zh-Hant", + "ko-KR", + "en-DE" + ] + }, + "use_browser_language": { + "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", + "type": "boolean", + "nullable": true + }, + "extended_properties": { + "description": "Properties for the user", + "type": "object" + }, + "extended_preferences": { + "description": "Preferences for the user", + "type": "object" + } + } + }, + "CreateVariableRequest": { + "type": "object", + "properties": { + "type": { + "description": "Type of variable", + "type": "string", + "enum": [ + "CONNECTION_PROPERTY", + "TABLE_MAPPING", + "CONNECTION_PROPERTY_PER_PRINCIPAL", + "FORMULA_VARIABLE" + ] + }, + "name": { + "description": "Name of the variable. This is unique across the cluster.", + "type": "string" + }, + "is_sensitive": { + "description": "If the variable contains sensitive values like passwords", + "default": false, + "type": "boolean", + "nullable": true + }, + "data_type": { + "description": "Variable Data Type, only for formula_variable type, leave empty for others
Version: 10.15.0.cl or later", + "type": "string", + "enum": [ + "VARCHAR", + "INT32", + "INT64", + "DOUBLE", + "DATE", + "DATE_TIME" + ] + } + }, + "required": [ + "type", + "name" + ] + }, + "DeleteVariablesRequest": { + "type": "object", + "properties": { + "identifiers": { + "description": "Unique id(s) or name(s) of the variable(s) to delete", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "identifiers" + ] + }, + "PutVariableValuesRequest": { + "type": "object", + "properties": { + "operation": { + "description": "Operation to perform", + "type": "string", + "enum": [ + "ADD", + "REMOVE", + "REPLACE", + "RESET" + ] + }, + "variable_assignment": { + "description": "Variable assignments", + "type": "array", + "items": { + "$ref": "#/components/schemas/VariablePutAssignmentInput" + } + } + }, + "required": [ + "variable_assignment" + ] + }, + "SearchVariablesRequest": { + "type": "object", + "properties": { + "variable_details": { + "description": "Variable details", + "type": "array", + "items": { + "$ref": "#/components/schemas/VariableDetailInput" + } + }, + "value_scope": { + "description": "Array of scope filters", + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueScopeInput" + } + }, + "record_offset": { + "description": "The starting record number from where the records should be included", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of records that should be included", + "default": 10, + "type": "integer", + "format": "int32" + }, + "response_content": { + "description": "Format in which we want the output", + "default": "METADATA", + "type": "string", + "enum": [ + "METADATA", + "METADATA_AND_VALUES" + ] + } + } + }, + "UpdateVariableRequest": { + "type": "object", + "properties": { + "name": { + "description": "New name of the variable.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "UpdateVariableValuesRequest": { + "type": "object", + "properties": { + "variable_assignment": { + "description": "Array of variable assignment objects specifying the variable identifier, values to assign, and the operation type (ADD, REMOVE, REPLACE, or RESET) to perform on each variable.", + "type": "array", + "items": { + "$ref": "#/components/schemas/VariableUpdateAssignmentInput" + } + }, + "variable_value_scope": { + "description": "Array of scope objects defining where the variable values apply, including organization context, optional principal constraints (user or group), model reference for formula variables, and priority for conflict resolution.", + "type": "array", + "items": { + "$ref": "#/components/schemas/VariableUpdateScopeInput" + } + } + }, + "required": [ + "variable_assignment", + "variable_value_scope" + ] + }, + "CommitBranchRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/MetadataObject" + } + }, + "delete_aware": { + "description": "Delete the tml files from version control repo if it does not exist in the ThoughSpot instance", + "default": true, + "type": "boolean", + "nullable": true + }, + "branch_name": { + "description": " Name of the remote branch where object should be pushed\n \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered.", + "type": "string" + }, + "comment": { + "description": "Comment to be added to the commit", + "type": "string" + } + }, + "required": [ + "metadata", + "comment" + ] + }, + "CreateConfigRequest": { + "type": "object", + "properties": { + "repository_url": { + "description": "URL for connecting to remote repository", + "type": "string" + }, + "username": { + "description": "Username to authenticate connection to remote repository", + "type": "string" + }, + "access_token": { + "description": "Access token corresponding to the user to authenticate connection to remote repository", + "type": "string" + }, + "org_identifier": { + "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", + "type": "string" + }, + "branch_names": { + "description": "List the remote branches to configure. Example:[development, production]", + "type": "array", + "items": { + "type": "string" + } + }, + "commit_branch_name": { + "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.
Version: 9.7.0.cl or later", + "type": "string" + }, + "enable_guid_mapping": { + "description": "Maintain mapping of guid for the deployment to an instance
Version: 9.4.0.cl or later", + "default": true, + "type": "boolean", + "nullable": true + }, + "configuration_branch_name": { + "description": " Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.\n \n\nNote: If no branch name is specified, then by default, ts_config_files branch is considered. Ensure this branch exists before configuration.
Version: 9.7.0.cl or later", + "type": "string" + } + }, + "required": [ + "repository_url", + "username", + "access_token" + ] + }, + "DeleteConfigRequest": { + "type": "object", + "properties": { + "cluster_level": { + "description": " Applicable when Orgs is enabled in the cluster\n \n\nIndicator to consider cluster level or org level config. Set it to false to delete configuration from current org. If set to true, then the configuration at cluster level and orgs that inherited the configuration from cluster level will be deleted.
Version: 9.5.0.cl or later", + "type": "boolean", + "nullable": true + } + } + }, + "DeployCommitRequest": { + "type": "object", + "properties": { + "commit_id": { + "description": " Commit_id against which the files should be picked to deploy.\n \n\nNote: If no commit_id is specified, then the head of the branch is considered.", + "type": "string" + }, + "branch_name": { + "description": "Name of the remote branch where changes should be picked", + "type": "string" + }, + "deploy_type": { + "description": "Indicates if all files or only modified file at specified commit point should be considered", + "default": "DELTA", + "type": "string", + "enum": [ + "FULL", + "DELTA" + ] + }, + "deploy_policy": { + "description": "Define the policy to follow while importing TML in the ThoughtSpot environment. Use “ALL_OR_NONE” to cancel the deployment of all ThoughtSpot objects if at least one of them fails to import. Use “Partial” to import ThoughtSpot objects that validate successfully even if other objects in the same deploy operations fail to import.", + "default": "ALL_OR_NONE", + "type": "string", + "enum": [ + "ALL_OR_NONE", + "PARTIAL", + "VALIDATE_ONLY" + ] + } + }, + "required": [ + "branch_name" + ] + }, + "RevertCommitRequest": { + "type": "object", + "properties": { + "metadata": { + "description": "Metadata objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/MetadataObject" + } + }, + "branch_name": { + "description": " Name of the branch where the reverted version should be committed\n \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered.", + "type": "string" + }, + "revert_policy": { + "description": "Policy to apply when reverting a commit. Valid values: [ALL_OR_NONE, PARTIAL]", + "default": "ALL_OR_NONE", + "type": "string", + "enum": [ + "ALL_OR_NONE", + "PARTIAL" + ] + } + } + }, + "SearchCommitsRequest": { + "type": "object", + "properties": { + "metadata_identifier": { + "description": "Unique ID or name of the metadata.", + "type": "string" + }, + "metadata_type": { + "description": "Type of metadata.", + "type": "string", + "enum": [ + "LIVEBOARD", + "ANSWER", + "LOGICAL_TABLE", + "CUSTOM_ACTION" + ] + }, + "branch_name": { + "description": " Name of the branch from which commit history needs to be displayed.\n \n\nNote: If no branch_name is specified, then commits will be returned for the default branch for this configuration.", + "type": "string" + }, + "record_offset": { + "description": " Record offset point in the commit history to display the response.\n \n\nNote: If no record offset is specified, the beginning of the record will be considered.", + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": " Number of history records from record offset point to be displayed in the response.\n \n\nNote: If no record size is specified, then all the records will be considered.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "metadata_identifier" + ] + }, + "SearchConfigRequest": { + "type": "object", + "properties": { + "org_identifiers": { + "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UpdateConfigRequest": { + "type": "object", + "properties": { + "username": { + "description": "Username to authenticate connection to version control system", + "type": "string" + }, + "access_token": { + "description": "Access token corresponding to the user to authenticate connection to version control system", + "type": "string" + }, + "org_identifier": { + "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", + "type": "string" + }, + "branch_names": { + "description": "List the remote branches to configure. Example:[development, production]", + "type": "array", + "items": { + "type": "string" + } + }, + "commit_branch_name": { + "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.
Version: 9.7.0.cl or later", + "type": "string" + }, + "enable_guid_mapping": { + "description": "Maintain mapping of guid for the deployment to an instance
Version: 9.4.0.cl or later", + "type": "boolean", + "nullable": true + }, + "configuration_branch_name": { + "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.
Version: 9.7.0.cl or later", + "type": "string" + } + } + }, + "ValidateMergeRequest": { + "type": "object", + "properties": { + "source_branch_name": { + "description": "Name of the branch from which changes need to be picked for validation", + "type": "string" + }, + "target_branch_name": { + "description": "Name of the branch where files will be merged", + "type": "string" + } + }, + "required": [ + "source_branch_name", + "target_branch_name" + ] + }, + "CreateWebhookConfigurationRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the webhook configuration.", + "type": "string" + }, + "description": { + "description": "Description of the webhook configuration.", + "type": "string" + }, + "url": { + "description": "The webhook endpoint URL.", + "type": "string" + }, + "url_params": { + "description": "Additional URL parameters as key-value pairs.", + "type": "object" + }, + "events": { + "description": "List of events to subscribe to.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ] + } + }, + "authentication": { + "description": "Authorization configuration for the webhook.", + "allOf": [ + { + "$ref": "#/components/schemas/WebhookAuthenticationInput" + } + ] + }, + "signature_verification": { + "description": "Configuration for webhook signature verification.", + "allOf": [ + { + "$ref": "#/components/schemas/WebhookSignatureVerificationInput" + } + ] + }, + "storage_destination": { + "description": "Configuration for storage destination.\nExample: {\"storage_type\": \"AWS_S3\", \"storage_config\": {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"thoughtspot-webhooks/\"}}}
Version: 26.3.0.cl or later", + "allOf": [ + { + "$ref": "#/components/schemas/StorageDestinationInput" + } + ] + }, + "additional_headers": { + "description": "Additional headers as an array of key-value pairs.\nExample: [{\"key\": \"X-Custom-Header\", \"value\": \"custom_value\"}]
Version: 26.4.0.cl or later", + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookKeyValuePairInput" + } + } + }, + "required": [ + "name", + "url", + "events" + ] + }, + "DeleteWebhookConfigurationsRequest": { + "type": "object", + "properties": { + "webhook_identifiers": { + "description": "List of webhook identifiers to delete.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "webhook_identifiers" + ] + }, + "SearchWebhookConfigurationsRequest": { + "type": "object", + "properties": { + "org_identifier": { + "description": "Unique ID or name of the org.", + "type": "string" + }, + "webhook_identifier": { + "description": "Unique ID or name of the webhook.", + "type": "string" + }, + "event_type": { + "description": "Type of webhook event to filter by.", + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ] + }, + "record_offset": { + "description": "The offset point, starting from where the webhooks should be included in the response.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "record_size": { + "description": "The number of webhooks that should be included in the response starting from offset position.", + "default": 50, + "type": "integer", + "format": "int32" + }, + "sort_options": { + "description": "Sort option includes sort field and sort order.", + "allOf": [ + { + "$ref": "#/components/schemas/WebhookSortOptionsInput" + } + ] + } + } + }, + "UpdateWebhookConfigurationRequest": { + "type": "object", + "properties": { + "name": { + "description": "Name of the webhook configuration.", + "type": "string" + }, + "description": { + "description": "Description of the webhook configuration.", + "type": "string" + }, + "url": { + "description": "The webhook endpoint URL.", + "type": "string" + }, + "url_params": { + "description": "Additional URL parameters as key-value pairs.", + "type": "object" + }, + "events": { + "description": "List of events to subscribe to.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "LIVEBOARD_SCHEDULE" + ] + } + }, + "authentication": { + "description": "Authorization configuration for the webhook.", + "allOf": [ + { + "$ref": "#/components/schemas/WebhookAuthenticationInput" + } + ] + }, + "signature_verification": { + "description": "Configuration for webhook signature verification.", + "allOf": [ + { + "$ref": "#/components/schemas/WebhookSignatureVerificationInput" + } + ] + }, + "storage_destination": { + "description": "Configuration for storage destination.\nExample: {\"storage_type\": \"AWS_S3\", \"storage_config\": {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"thoughtspot-webhooks/\"}}}
Version: 26.3.0.cl or later", + "allOf": [ + { + "$ref": "#/components/schemas/StorageDestinationInput" + } + ] + }, + "additional_headers": { + "description": "Additional headers as an array of key-value pairs.\nExample: [{\"key\": \"X-Custom-Header\", \"value\": \"custom_value\"}]
Version: 26.4.0.cl or later", + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookKeyValuePairInput" + } + } + } } }, "securitySchemes": { From a6d45b3c0ba7fbbca883a6f9622d6ba692b17a5b Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Wed, 4 Mar 2026 20:59:33 +0530 Subject: [PATCH 2/8] initial commit --- api-spec/openapiSpecv3-2_0.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index 66a5d0c46..d287fe87c 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -2665,7 +2665,7 @@ "/api/rest/2.0/connections/{connection_identifier}/resync-metadata": { "post": { "operationId": "syncMetadata", - "description": "\n Version: 26.5.0.cl or later\n\nSynchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot.\n\nRequires the `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is also required.\n\n#### Usage guidelines\n\nTo synchronize attributes from a CDW, specify the connection GUID or name in the `connection_identifier` path parameter and `sync_attributes` in the request body. Default attribute is `[\"DESCRIPTION\"]`.\n\n##### Hierarchical schema\n\n* Connection: The connection object for the sync operation.\n* Tables: Tables for the sync operation. When no table is specified, all tables are synchronized.\n* Columns: If the table is specified, you can add the columns for the sync operation. If no columns are specified, all columns in the specified table are considered for the sync operation.\n\nTo set the scope for the sync operation:\n\n* Connection-level: To sync all tables and columns, pass an empty request body, or only the attributes in the request body.\n* Table-level: To synchronize specific tables and their columns, specify the table identifiers in the `tables` array.\n* Column-level: To synchronize specific columns, specify the table identifier as the key and column identifiers as the value in the `tables` array.\n\n```\n{\n \"tables\": [\n {\"table-guid-1\": [\"column-guid-1\", \"column-guid-2\"]},\n \"table-guid-2\"\n ],\n \"sync_attributes\": [\"DESCRIPTION\"]\n}\n```\n\n##### API response\n\nIf the sync operation is successful, the API returns the following information:\n\n* Status of the sync operation. For example, `SUCCESS`, `PARTIAL_SUCCESS`, or `NO_UPDATE`.\n* Number of tables and columns that were updated.\n* Number of tables and columns with the sync failed status when the overall sync status is `PARTIAL_SUCCESS`.\n* Message text indicating the sync results.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.5.0.cl or later\n\nSynchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot.\n\nRequires the `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\n\n#### Usage guidelines\n\nTo synchronize attributes from a CDW, specify the connection GUID in the `connection_identifier` path parameter and `sync_attributes` in the request body. Default attribute is `[\"DESCRIPTION\"]`.\n\n##### Hierarchical schema\n\n* Connection: The connection object for the sync operation.\n* Tables: Tables for the sync operation. When no table is specified, all tables are synchronized.\n* Columns: If the table is specified, you can add the columns for the sync operation. If no columns are specified, all columns in the specified table are considered for the sync operation.\n\nTo set the scope for the sync operation:\n\n* Connection-level: To sync all tables and columns, pass an empty request body, or only the attributes in the request body.\n* Table-level: To synchronize specific tables and their columns, specify the table identifiers in the `tables` array.\n* Column-level: To synchronize specific columns, specify the table identifier as the key and column identifiers as the value in the `tables` array.\n\n```\n{\n \"tables\": [\n {\"table-guid-1\": [\"column-guid-1\", \"column-guid-2\"]},\n \"table-guid-2\"\n ],\n \"sync_attributes\": [\"DESCRIPTION\"]\n}\n```\n\n##### API response\n\nIf the sync operation is successful, the API returns the following information:\n\n* Status of the sync operation. For example, `SUCCESS`, `PARTIAL_SUCCESS`, or `NO_UPDATE`.\n* Number of tables and columns that were updated.\n* Number of tables and columns with the sync failed status when the overall sync status is `PARTIAL_SUCCESS`.\n* Message text indicating the sync results.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.5.0.cl" @@ -2688,7 +2688,7 @@ "schema": { "type": "string" }, - "description": "Unique ID or name of the connection." + "description": "GUID of the connection." } ], "responses": { @@ -22125,7 +22125,7 @@ "type": "object", "properties": { "tables": { - "description": "Array of tables to sync. Each element can be:\n- String: Table identifier (GUID or name) to sync\n all columns for that table.\n- Object: {tableId: [columnIds]} to sync specific\n columns.\nIf not provided, syncs all tables in the connection.", + "description": "Array of tables to sync. Each element can be:\n- String: Table identifier (GUID of the table) to sync\n all columns for that table.\n- Object: {tableId: [columnIds]} to sync specific\n columns.\nIf not provided, syncs all tables in the connection.", "type": "object" }, "sync_attributes": { From 1ab0bebf0bd0ebca8a6c95e8c3b7d43379f78bfc Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Thu, 5 Mar 2026 12:52:19 +0530 Subject: [PATCH 3/8] revert docs --- api-spec/openapiSpecv3-2_0.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index d287fe87c..555d3a826 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -2665,7 +2665,7 @@ "/api/rest/2.0/connections/{connection_identifier}/resync-metadata": { "post": { "operationId": "syncMetadata", - "description": "\n Version: 26.5.0.cl or later\n\nSynchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot.\n\nRequires the `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\n\n#### Usage guidelines\n\nTo synchronize attributes from a CDW, specify the connection GUID in the `connection_identifier` path parameter and `sync_attributes` in the request body. Default attribute is `[\"DESCRIPTION\"]`.\n\n##### Hierarchical schema\n\n* Connection: The connection object for the sync operation.\n* Tables: Tables for the sync operation. When no table is specified, all tables are synchronized.\n* Columns: If the table is specified, you can add the columns for the sync operation. If no columns are specified, all columns in the specified table are considered for the sync operation.\n\nTo set the scope for the sync operation:\n\n* Connection-level: To sync all tables and columns, pass an empty request body, or only the attributes in the request body.\n* Table-level: To synchronize specific tables and their columns, specify the table identifiers in the `tables` array.\n* Column-level: To synchronize specific columns, specify the table identifier as the key and column identifiers as the value in the `tables` array.\n\n```\n{\n \"tables\": [\n {\"table-guid-1\": [\"column-guid-1\", \"column-guid-2\"]},\n \"table-guid-2\"\n ],\n \"sync_attributes\": [\"DESCRIPTION\"]\n}\n```\n\n##### API response\n\nIf the sync operation is successful, the API returns the following information:\n\n* Status of the sync operation. For example, `SUCCESS`, `PARTIAL_SUCCESS`, or `NO_UPDATE`.\n* Number of tables and columns that were updated.\n* Number of tables and columns with the sync failed status when the overall sync status is `PARTIAL_SUCCESS`.\n* Message text indicating the sync results.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.5.0.cl or later\n\nSynchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot.\n\nRequires the `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\n\n#### Usage guidelines\n\nTo synchronize attributes from a CDW, specify the connection GUID or name in the `connection_identifier` path parameter and `sync_attributes` in the request body. Default attribute is `[\"DESCRIPTION\"]`.\n\n##### Hierarchical schema\n\n* Connection: The connection object for the sync operation.\n* Tables: Tables for the sync operation. When no table is specified, all tables are synchronized.\n* Columns: If the table is specified, you can add the columns for the sync operation. If no columns are specified, all columns in the specified table are considered for the sync operation.\n\nTo set the scope for the sync operation:\n\n* Connection-level: To sync all tables and columns, pass an empty request body, or only the attributes in the request body.\n* Table-level: To synchronize specific tables and their columns, specify the table identifiers in the `tables` array.\n* Column-level: To synchronize specific columns, specify the table identifier as the key and column identifiers as the value in the `tables` array.\n\n```\n{\n \"tables\": [\n {\"table-guid-1\": [\"column-guid-1\", \"column-guid-2\"]},\n \"table-guid-2\"\n ],\n \"sync_attributes\": [\"DESCRIPTION\"]\n}\n```\n\n##### API response\n\nIf the sync operation is successful, the API returns the following information:\n\n* Status of the sync operation. For example, `SUCCESS`, `PARTIAL_SUCCESS`, or `NO_UPDATE`.\n* Number of tables and columns that were updated.\n* Number of tables and columns with the sync failed status when the overall sync status is `PARTIAL_SUCCESS`.\n* Message text indicating the sync results.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.5.0.cl" @@ -2688,7 +2688,7 @@ "schema": { "type": "string" }, - "description": "GUID of the connection." + "description": "Unique ID or name of the connection." } ], "responses": { @@ -22125,7 +22125,7 @@ "type": "object", "properties": { "tables": { - "description": "Array of tables to sync. Each element can be:\n- String: Table identifier (GUID of the table) to sync\n all columns for that table.\n- Object: {tableId: [columnIds]} to sync specific\n columns.\nIf not provided, syncs all tables in the connection.", + "description": "Array of tables to sync. Each element can be:\n- String: Table identifier (GUID or name) to sync\n all columns for that table.\n- Object: {tableId: [columnIds]} to sync specific\n columns.\nIf not provided, syncs all tables in the connection.", "type": "object" }, "sync_attributes": { From 60dc4394643f4c03fc5fa0d65fdf609d3a6163b9 Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Thu, 12 Mar 2026 16:38:29 +0530 Subject: [PATCH 4/8] deactivate yaml initial commit --- api-spec/openapiSpecv3-2_0.json | 363 +++++++++++--------------------- 1 file changed, 127 insertions(+), 236 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index 555d3a826..c2410e94c 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -109,6 +109,14 @@ ], "description": "Roles for version 26.5.0.cl" }, + { + "name": "26.6.0.cl", + "id": "26.6.0.cl", + "tags": [ + "26.6.0.cl" + ], + "description": "Roles for version 26.6.0.cl" + }, { "name": "9.6.0.cl", "id": "9.6.0.cl", @@ -2822,6 +2830,92 @@ } } }, + "/api/rest/2.0/connections/{connection_identifier}/status": { + "put": { + "operationId": "updateConnectionStatus", + "description": "\n Version: 26.6.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Connections", + "26.6.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateConnectionStatusRequest" + } + } + }, + "required": true + }, + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection." + } + ], + "responses": { + "204": { + "description": "Connection status updated successfully." + }, + "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" + } + } + } + }, + "404": { + "description": "Object not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, "/api/rest/2.0/connections/{connection_identifier}/update": { "post": { "operationId": "updateConnectionV2", @@ -11739,149 +11833,6 @@ } } }, - "/api/rest/2.0/webhooks/{webhook_identifier}/storage-config": { - "get": { - "operationId": "getWebhookStorageConfig", - "description": "\nBeta Version: 26.4.0.cl or later\n\nGet storage config information for a webhook configuration. This endpoint provides ThoughtSpot's identity information and IAM policy configuration required for customers to set up cross-account access to their S3 buckets.\n\nThe setup info returned depends on the ThoughtSpot cluster type:\n- For AWS clusters: Returns `aws_config` with STS AssumeRole configuration\n- For GCP clusters: Returns `gcp_config` with STS AssumeRoleWithWebIdentity configuration\n\n**Note:** This endpoint only returns data if the webhook has a storage destination configured.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", - "tags": [ - "Webhooks", - "26.4.0.cl" - ], - "parameters": [ - { - "in": "path", - "name": "webhook_identifier", - "required": true, - "schema": { - "type": "string" - }, - "description": "Unique ID or name of the webhook configuration." - } - ], - "responses": { - "200": { - "description": "Storage setup information retrieved successfully", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StorageSetupInfo" - }, - "examples": { - "example_1": { - "description": "Storage setup info for AWS cluster deployment", - "value": { - "cluster_type": "AWS", - "storage_type": "AWS_S3", - "aws_config": { - "thoughtspot_aws_account_id": "123456789012", - "trust_policy_template": { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::123456789012:root" - }, - "Action": "sts:AssumeRole", - "Condition": { - "StringEquals": { - "sts:ExternalId": "ts-webhook-a1b2c3d4-7890" - } - } - } - ] - }, - "setup_instructions": [ - "1. Create an IAM role in your AWS account", - "2. Copy the trust policy template and attach it to your role", - "3. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", - "4. Use the role ARN in your webhook storage configuration" - ] - } - } - }, - "example_2": { - "description": "Storage setup info for GCP cluster deployment", - "value": { - "cluster_type": "GCP", - "storage_type": "AWS_S3", - "gcp_config": { - "thoughtspot_gcp_service_account_id": "115663769112811637952", - "oidc_provider": "accounts.google.com", - "trust_policy_template": { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - "accounts.google.com:sub": "115663769112811637952" - } - } - } - ] - }, - "setup_instructions": [ - "1. Add accounts.google.com as an Identity Provider in AWS IAM", - "2. Create an IAM role with Web Identity Federation trust", - "3. Configure the trust policy with ThoughtSpot's GCP service account ID", - "4. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", - "5. Use the role ARN in your webhook storage configuration" - ] - } - } - } - } - } - } - }, - "400": { - "description": "Invalid request. Webhook not found or does not have storage destination configured.", - "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/webhooks/search": { "post": { "operationId": "searchWebhookConfigurations", @@ -13800,6 +13751,21 @@ "PdfOptionsInput": { "type": "object", "properties": { + "page_size": { + "type": "string", + "enum": [ + "A4", + "CONTINUOUS" + ], + "description": "Size of PDF page. `A4` generates a paginated A4 PDF. `CONTINUOUS` generates a continuous PDF that matches the Liveboard layout. Each Liveboard tab has its own page of variable length. Defaults to `A4` if not specified.
Beta Version: 26.5.0.cl or later", + "nullable": true + }, + "zoom_level": { + "type": "integer", + "format": "int32", + "description": "Zoom level percentage for the PDF. Only applicable when `page_size` is `CONTINUOUS`. Acceptable values are integers in the range [45, 175]. Defaults to 100 if not specified.
Beta Version: 26.5.0.cl or later", + "nullable": true + }, "include_cover_page": { "type": "boolean", "default": true, @@ -13815,7 +13781,7 @@ "include_filter_page": { "type": "boolean", "default": true, - "description": "Indicates whether to include a page with all applied filters.", + "description": "Indicates whether to include a page with all applied filters. For `CONTINUOUS` page_size, this parameter indicates whether to include the filter header.", "nullable": true }, "include_page_number": { @@ -16480,98 +16446,6 @@ } } }, - "StorageSetupInfo": { - "type": "object", - "required": [ - "cluster_type", - "storage_type" - ], - "properties": { - "cluster_type": { - "type": "string", - "enum": [ - "AWS", - "GCP" - ], - "description": "The type of ThoughtSpot cluster deployment.\nDetermines which authentication method is used for S3 access.\nExample: \"AWS\" or \"GCP\"" - }, - "storage_type": { - "type": "string", - "enum": [ - "AWS_S3" - ], - "description": "Type of storage destination (e.g., AWS_S3)." - }, - "aws_config": { - "$ref": "#/components/schemas/AWSAssumeRoleSetup", - "description": "Setup info for AWS clusters using STS AssumeRole.\nOnly populated when cluster_type is AWS.", - "nullable": true - }, - "gcp_config": { - "$ref": "#/components/schemas/GCPWebIdentitySetup", - "description": "Setup info for GCP clusters using STS AssumeRoleWithWebIdentity.\nOnly populated when cluster_type is GCP.", - "nullable": true - } - }, - "description": "Setup information for customer-managed storage configuration.\nProvides ThoughtSpot's identity information and IAM policy configuration\nrequired for customers to set up cross-account access to their S3 buckets.\nThe response contains cluster-specific configuration based on the cluster_type:\n- For AWS clusters: aws_config will be populated\n- For GCP clusters: gcp_config will be populated\nExample query:\n```graphql\nquery {\n getWebhookStorageConfig(webhook_identifier: \"my-webhook\") {\n cluster_type\n storage_type\n aws_config {\n thoughtspot_aws_account_id\n trust_policy_template\n setup_instructions\n }\n gcp_config {\n thoughtspot_gcp_service_account_id\n oidc_provider\n trust_policy_template\n setup_instructions\n }\n }\n}\n```\nExample AWS response:\n{\n \"cluster_type\": \"AWS\",\n \"storage_type\": \"AWS_S3\",\n \"aws_config\": {\n \"thoughtspot_aws_account_id\": \"123456789012\",\n \"trust_policy_template\": { \"Version\": \"2012-10-17\", \"Statement\": [...] },\n \"setup_instructions\": [\"1. Create an IAM role...\", \"2. Add trust policy...\"]\n },\n \"gcp_config\": null\n}\nExample GCP response:\n{\n \"cluster_type\": \"GCP\",\n \"storage_type\": \"AWS_S3\",\n \"aws_config\": null,\n \"gcp_config\": {\n \"thoughtspot_gcp_service_account_id\": \"115663769112811637952\",\n \"oidc_provider\": \"accounts.google.com\",\n \"trust_policy_template\": { \"Version\": \"2012-10-17\", \"Statement\": [...] },\n \"setup_instructions\": [\"1. Add accounts.google.com as Identity Provider...\"]\n }\n}" - }, - "AWSAssumeRoleSetup": { - "type": "object", - "required": [ - "thoughtspot_aws_account_id", - "trust_policy_template" - ], - "properties": { - "thoughtspot_aws_account_id": { - "type": "string", - "description": "ThoughtSpot's AWS Account ID. You must include this in your IAM role's\ntrust policy to allow ThoughtSpot to assume your role.\nExample: \"123456789012\"" - }, - "trust_policy_template": { - "type": "object", - "description": "Sample IAM trust policy JSON object that you should attach to your IAM role.\nThe policy includes ThoughtSpot's AWS Account ID and your External ID.\nExample: { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::123456789012:root\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"your-external-id\" } } }] }" - }, - "setup_instructions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Step-by-step instructions to configure your AWS IAM role.\nExample: [\"1. Create an IAM role in your AWS account\", \"2. Add the trust policy with ThoughtSpot's AWS Account ID\"]", - "nullable": true - } - }, - "description": "Setup information for AWS clusters using STS AssumeRole.\nThoughtSpot will use its AWS IAM role to assume your role in your AWS account.\nExample:\n{\n \"thoughtspot_aws_account_id\": \"123456789012\",\n \"trust_policy_template\": {\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Effect\": \"Allow\",\n \"Principal\": { \"AWS\": \"arn:aws:iam::123456789012:root\" },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"your-external-id\" } }\n }]\n },\n \"setup_instructions\": [\n \"1. Create an IAM role in your AWS account\",\n \"2. Copy the trust policy template and attach it to your role\",\n \"3. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role\",\n \"4. Use the role ARN in your webhook storage configuration\"\n ]\n}" - }, - "GCPWebIdentitySetup": { - "type": "object", - "required": [ - "thoughtspot_gcp_service_account_id", - "trust_policy_template" - ], - "properties": { - "thoughtspot_gcp_service_account_id": { - "type": "string", - "description": "ThoughtSpot's GCP service account unique ID (numeric).\nThis is the 'sub' claim in OIDC tokens and must be included in your\nIAM role's trust policy condition.\nExample: \"115663769112811637952\"" - }, - "oidc_provider": { - "type": "string", - "description": "The OIDC identity provider URL. For GCP, this is always 'accounts.google.com'.\nYou must configure this as an Identity Provider in AWS IAM.\nExample: \"accounts.google.com\"", - "nullable": true - }, - "trust_policy_template": { - "type": "object", - "description": "Sample IAM trust policy JSON object for Web Identity Federation.\nThis policy allows ThoughtSpot's GCP service account to assume your AWS role.\nExample: { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Allow\", \"Principal\": { \"Federated\": \"arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com\" }, \"Action\": \"sts:AssumeRoleWithWebIdentity\", \"Condition\": { \"StringEquals\": { \"accounts.google.com:sub\": \"115663769112811637952\" } } }] }" - }, - "setup_instructions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Step-by-step instructions to configure AWS for GCP Web Identity Federation.\nExample: [\"1. Add accounts.google.com as an Identity Provider in AWS IAM\", \"2. Create an IAM role with Web Identity Federation trust\"]", - "nullable": true - } - }, - "description": "Setup information for GCP clusters using STS AssumeRoleWithWebIdentity.\nThoughtSpot will use its GCP service account to obtain OIDC tokens for AWS access.\nExample:\n{\n \"thoughtspot_gcp_service_account_id\": \"115663769112811637952\",\n \"oidc_provider\": \"accounts.google.com\",\n \"trust_policy_template\": {\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Effect\": \"Allow\",\n \"Principal\": { \"Federated\": \"arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com\" },\n \"Action\": \"sts:AssumeRoleWithWebIdentity\",\n \"Condition\": { \"StringEquals\": { \"accounts.google.com:sub\": \"115663769112811637952\" } }\n }]\n },\n \"setup_instructions\": [\n \"1. Add accounts.google.com as an Identity Provider in AWS IAM\",\n \"2. Create an IAM role with Web Identity Federation trust\",\n \"3. Configure the trust policy with ThoughtSpot's GCP service account ID\",\n \"4. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role\",\n \"5. Use the role ARN in your webhook storage configuration\"\n ]\n}" - }, "CollectionSearchResponse": { "type": "object", "required": [ @@ -22173,6 +22047,23 @@ "connection_identifier" ] }, + "UpdateConnectionStatusRequest": { + "type": "object", + "properties": { + "status": { + "description": "Status to set for the connection. Use ACTIVATED to enable the connection or DEACTIVATED to disable it.", + "default": "ACTIVATED", + "type": "string", + "enum": [ + "ACTIVATED", + "DEACTIVATED" + ] + } + }, + "required": [ + "status" + ] + }, "UpdateConnectionV2Request": { "type": "object", "properties": { From b9f0020f55f8ce94ed6bf7dfe3ae9afcfe3132c4 Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Thu, 12 Mar 2026 18:19:56 +0530 Subject: [PATCH 5/8] md file --- api-spec/openapiSpecv3-2_0.json | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index c2410e94c..230cd0954 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -2833,7 +2833,7 @@ "/api/rest/2.0/connections/{connection_identifier}/status": { "put": { "operationId": "updateConnectionStatus", - "description": "\n Version: 26.6.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\n**NOTE**: Deactivating a connection does not delete the connection or its associated metadata. The connection and its objects remain intact and can be reactivated at any time.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.6.0.cl" @@ -22059,10 +22059,7 @@ "DEACTIVATED" ] } - }, - "required": [ - "status" - ] + } }, "UpdateConnectionV2Request": { "type": "object", From 89af728880832a7c853ef52073acd56d96e68baf Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Mon, 16 Mar 2026 13:07:05 +0530 Subject: [PATCH 6/8] md fixes --- api-spec/openapiSpecv3-2_0.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index 230cd0954..b4a120b0d 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -2833,7 +2833,7 @@ "/api/rest/2.0/connections/{connection_identifier}/status": { "put": { "operationId": "updateConnectionStatus", - "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\n**NOTE**: Deactivating a connection does not delete the connection or its associated metadata. The connection and its objects remain intact and can be reactivated at any time.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. It does not remove the connection metadata, but only makes the connection unavailable for queries and operations. You can reactivate a deactivated connection by setting \"status\": \"ACTIVATED\".\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.6.0.cl" @@ -23744,6 +23744,12 @@ "type": "boolean", "nullable": true }, + "include_personalised_views": { + "description": "When set to true and include_details is also true, includes personalised views\nin the metadata_detail for LIVEBOARD objects.", + "default": false, + "type": "boolean", + "nullable": true + }, "include_headers": { "description": "Includes headers of the metadata objects.", "default": true, From 698e4465781c0028bedfca54076311cdc301dadf Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Tue, 17 Mar 2026 21:59:28 +0530 Subject: [PATCH 7/8] comments --- api-spec/openapiSpecv3-2_0.json | 752 +++++++++++++++++++++++++++----- 1 file changed, 647 insertions(+), 105 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index b4a120b0d..402535cde 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -6,12 +6,12 @@ }, "x-roles": [ { - "name": "10.13.0.cl", - "id": "10.13.0.cl", + "name": "26.2.0.cl", + "id": "26.2.0.cl", "tags": [ - "10.13.0.cl" + "26.2.0.cl" ], - "description": "Roles for version 10.13.0.cl" + "description": "Roles for version 26.2.0.cl" }, { "name": "10.4.0.cl", @@ -29,6 +29,14 @@ ], "description": "Roles for version 10.15.0.cl" }, + { + "name": "10.13.0.cl", + "id": "10.13.0.cl", + "tags": [ + "10.13.0.cl" + ], + "description": "Roles for version 10.13.0.cl" + }, { "name": "10.7.0.cl", "id": "10.7.0.cl", @@ -37,6 +45,14 @@ ], "description": "Roles for version 10.7.0.cl" }, + { + "name": "26.5.0.cl", + "id": "26.5.0.cl", + "tags": [ + "26.5.0.cl" + ], + "description": "Roles for version 26.5.0.cl" + }, { "name": "9.0.0.cl", "id": "9.0.0.cl", @@ -93,22 +109,6 @@ ], "description": "Roles for version 9.9.0.cl" }, - { - "name": "26.2.0.cl", - "id": "26.2.0.cl", - "tags": [ - "26.2.0.cl" - ], - "description": "Roles for version 26.2.0.cl" - }, - { - "name": "26.5.0.cl", - "id": "26.5.0.cl", - "tags": [ - "26.5.0.cl" - ], - "description": "Roles for version 26.5.0.cl" - }, { "name": "26.6.0.cl", "id": "26.6.0.cl", @@ -211,10 +211,10 @@ "/api/rest/2.0/ai/agent/conversation/create": { "post": { "operationId": "createAgentConversation", - "description": "\nBeta Version: 10.13.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.2.0.cl or later\n\nVersion: 26.2.0.cl or later\n\nCreates a new Spotter agent conversation based on the provided context and settings. The endpoint was in Beta from 26.2.0.cl through 26.4.0.cl.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe request must include the `metadata_context` parameter to define the conversation context. The context type can be one of:\n\n- `DATA_SOURCE` *(available from 26.5.0.cl)*: targets a specific data source. Provide `data_source_identifier` in `data_source_context` for a single data source, or `data_source_identifiers` for multi-data-source context. The deprecated `guid` field is accepted for backwards compatibility.\n- `AUTO_MODE` *(available from 26.5.0.cl)*: automatically discovers and selects the most relevant datasets for the user's queries.\n\n> **Note for callers on versions 26.2.0.cl – 26.4.0.cl (Beta):** use the lowercase `data_source` enum value with the `guid` field instead of the above. Example: `{ \"type\": \"data_source\", \"data_source_context\": { \"guid\": \"\" } }`.\n\nThe `conversation_settings` parameter controls which Spotter capabilities are enabled for the conversation:\n\n- `enable_contextual_change_analysis` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl\n- `enable_natural_language_answer_generation` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl\n- `enable_reasoning` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl\n- `enable_save_chat` (default: `false`, *available from 26.5.0.cl*) — enables saving the conversation for later retrieval via conversation history\n\nIf the request is successful, the response includes a unique `conversation_identifier` that must be passed to `sendAgentConversationMessage` or `sendAgentConversationMessageStreaming` to send messages within this conversation. The response also includes `conversation_id` with the same value for backwards compatibility; use `conversation_identifier` for new integrations.\n\n#### Example request\n\n```json\n{\n \"metadata_context\": {\n \"type\": \"DATA_SOURCE\",\n \"data_source_context\": {\n \"data_source_identifier\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n }\n },\n \"conversation_settings\": {}\n}\n```\n\n#### Error responses\n\n| Code | Description |\n| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\n\n> ###### Note:\n>\n> - This endpoint was in Beta from 26.2.0.cl through 26.4.0.cl and is Generally Available from version 26.5.0.cl.\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.13.0.cl" + "26.2.0.cl" ], "requestBody": { "content": { @@ -234,6 +234,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/AgentConversation" + }, + "examples": { + "example_1": { + "summary": "Create a conversation with a specific data source", + "value": { + "conversation_id": "wwHQ5j8O8dQC", + "conversation_identifier": "wwHQ5j8O8dQC" + } + }, + "example_2": { + "summary": "Create a conversation using auto mode where the agent automatically discovers and selects the most relevant datasets for the user's queries", + "value": { + "conversation_id": "aaHQ5j8O8dQC", + "conversation_identifier": "aaHQ5j8O8dQC" + } + } } } } @@ -258,6 +274,26 @@ } } }, + "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": "Operation failed", "content": { @@ -274,7 +310,7 @@ "/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", + "description": "\nBeta Version: 10.4.0.cl or later\n\nVersion: 10.4.0.cl or later\n\nCreates a new conversation session tied to a specific data model for AI-driven natural language querying.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe request must include:\n- `metadata_identifier`: the unique ID of the data source that provides context for the conversation\n\nOptionally, you can provide:\n- `tokens`: a token string to set initial context for the conversation (e.g., `\"[sales],[item type],[state]\"`)\n\nIf the request is successful, ThoughtSpot returns a unique `conversation_identifier` that must be passed to `sendMessage` to continue the conversation.\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\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" @@ -321,6 +357,26 @@ } } }, + "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": "Operation failed", "content": { @@ -337,7 +393,7 @@ "/api/rest/2.0/ai/data-source-suggestions": { "post": { "operationId": "getDataSourceSuggestions", - "description": "\nBeta Version: 10.15.0.cl or later\n\nProvides relevant data source recommendations for a user-submitted natural language query.\n\nTo use this API, the user must have at least view-level access to the underlying metadata entities referenced in the response.\n\n#### Usage guidelines\n\nThe request must include a `query` string via the request body.\n\nThe returned results include metadata such as:\n- `confidence`: a float indicating the model's confidence in the relevance of each recommendation\n- `details`: includes `data_source_identifier`, `data_source_name`, and `description` of each recommended data source\n- `reasoning`: rationale provided by the LLM to explain why each data source was recommended\n\nIf the API request is successful, ThoughtSpot returns a ranked list of data sources, each annotated with relevant reasoning.\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before it 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", + "description": "\nBeta Version: 10.15.0.cl or later\n\nSuggests the most relevant data sources for a given natural language query, ranked by confidence with LLM-generated reasoning.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view-level access to the underlying metadata entities referenced in the response.\n\n#### Usage guidelines\n\nThe request must include:\n- `query`: the natural language question to find relevant data sources for\n\nIf the request is successful, the API returns a ranked list of suggested data sources, each containing:\n- `confidence`: a float score indicating the model's confidence in the relevance of the suggestion\n- `details`: metadata about the data source\n - `data_source_identifier`: the unique ID of the data source\n - `data_source_name`: the display name of the data source\n - `description`: a description of the data source\n- `reasoning`: LLM-generated rationale explaining why the data source was recommended\n\n#### Error responses\n\n| Code | Description |\n|------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the underlying metadata entities. |\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before it 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.15.0.cl" @@ -384,6 +440,26 @@ } } }, + "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": "Operation failed", "content": { @@ -400,7 +476,7 @@ "/api/rest/2.0/ai/instructions/get": { "post": { "operationId": "getNLInstructions", - "description": "\nBeta Version: 10.15.0.cl or later\n\nThis API allows users to retrieve existing natural language (NL) instructions for a specific data-model. These instructions guide the AI system in understanding data context and generating more accurate responses when processing natural language queries.\n\n#### Usage guidelines\n\nTo retrieve NL instructions for a data-model, the request must include:\n- `data_source_identifier`: The unique ID of the data-model to retrieve NL instructions\n\nThe API returns a response object with:\n- `nl_instructions_info`: An array of instruction objects, each containing:\n - `instructions`: Array of text instructions for natural language processing\n - `scope`: The scope of the instruction (`GLOBAL`). It can be extended to data-model-user scope in future.\n\n#### Instructions Scope\n\n- **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported)\n\n> ###### Note:\n> * To use this API, the user needs atleast view access on the data-model and they must use corresponding org related bearerToken where the data-model exists.\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * Available from version 10.15.0.cl and later.\n> * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> * Use this API to view currently configured instructions before modifying them with `setNLInstructions`.\n\n\n\n#### Endpoint URL\n", + "description": "\nBeta Version: 10.15.0.cl or later\n\nRetrieves existing natural language (NL) instructions configured for a specific data model. These instructions guide the AI system in understanding data context and generating more accurate responses.\n\nRequires `CAN_USE_SPOTTER` privilege, at least view access on the data model, and a bearer token corresponding to the org where the data model exists.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `data_source_identifier`: the unique ID of the data model to retrieve instructions for\n\nIf the request is successful, the API returns:\n\n- `nl_instructions_info`: an array of instruction objects, each containing:\n - `instructions`: the configured text instructions for AI processing\n - `scope`: the scope of the instruction — currently only `GLOBAL` is supported\n\n#### Instructions scope\n\n- **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported)\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks view access on the data model, or the bearer token does not correspond to the org where the data model exists. |\n\n> ###### Note:\n>\n> - To use this API, the user needs at least view access on the data model, and must use the bearer token corresponding to the org where the data model exists.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - Available from version 10.15.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> - Use this API to review currently configured instructions before modifying them with `setNLInstructions`.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.15.0.cl" @@ -447,6 +523,26 @@ } } }, + "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": "Operation failed", "content": { @@ -463,7 +559,7 @@ "/api/rest/2.0/ai/relevant-questions/": { "post": { "operationId": "getRelevantQuestions", - "description": "\nBeta Version: 10.13.0.cl or later\n\nBreaks down a user-submitted query into a series of analytical sub-questions using relevant contextual metadata.\n\nTo use this API, the user must have at least view-level access to the referenced metadata objects.\n\n#### Usage guidelines\n\nTo accurately generate relevant questions, the request must include at least one of the following metadata identifiers within `metadata_context` : `conversation_identifier`, `answer_identifiers`, `liveboard_identifiers`, or `data_source_identifiers`.\n\nYou can further enhance the quality and precision of breakdown by providing additional `ai_context` such as:\n\n- `content`: User provided content like text data, csv data as a string message to provide context & potentially improve the quality of the response.\n- `instructions`: User specific text instructions sent to AI system for processing the query.\n\nAdditional optional parameters include:\n\n- `limit_relevant_questions`: Controls the maximum number of relevant questions returned. Defaults to 5 if not specified.\n- `bypass_cache`: If set to true, forces fresh computation instead of returning cached results.\n\nIf the API request is successful, ThoughtSpot returns a list of relevant analytical queries, each aligned with the user's original question. Each returned question includes the query string, along with the identifier and name of the corresponding data source.\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#### Endpoint URL\n", + "description": "\nBeta Version: 10.13.0.cl or later\n\nBreaks down a natural language query into a series of smaller analytical sub-questions, each mapped to a relevant data source.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects.\n\n#### Usage guidelines\n\nThe request must include:\n- `query`: the natural language question to decompose into analytical sub-questions\n- `metadata_context`: at least one of the following context identifiers to guide question generation:\n - `conversation_identifier` — an existing conversation session ID\n - `answer_identifiers` — a list of Answer GUIDs\n - `liveboard_identifiers` — a list of Liveboard GUIDs\n - `data_source_identifiers` — a list of data source GUIDs\n\nOptional parameters for refining the output:\n- `ai_context`: additional context to improve response quality\n - `content` — supplementary text or CSV data as string input\n - `instructions` — custom text instructions for the AI system\n- `limit_relevant_questions`: maximum number of questions to return (default: `5`)\n- `bypass_cache`: if `true`, forces fresh computation instead of returning cached results\n\nIf the request is successful, the API returns a list of relevant analytical questions, each containing:\n- `query`: the generated sub-question\n- `data_source_identifier`: the unique ID of the data source the question targets\n- `data_source_name`: the display name of the corresponding data source\n\n#### Error responses\n\n| Code | Description |\n|------|---------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. |\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.13.0.cl" @@ -490,18 +586,278 @@ } } }, - "201": { - "description": "Common error response", + "201": { + "description": "Common error response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/eureka_GetRelevantQuestionsResponse" + } + } + } + }, + "400": { + "description": "Operation failed", + "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": "Operation failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/rest/2.0/ai/analytical-questions": { + "post": { + "operationId": "queryGetDecomposedQuery", + "description": "\nBeta Version: 10.7.0.cl or later\n\nVersion: 10.7.0.cl or later\n\n**Deprecated** — Use `getRelevantQuestions` instead (available from 10.13.0.cl).\n\nBreaks down a topical or goal-oriented natural language question into smaller, actionable analytical sub-questions, each mapped to a relevant data source for independent execution.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects.\n\n#### Usage guidelines\n\nThe request accepts the following parameters:\n\n- `nlsRequest`: contains the user `query` to decompose, along with optional `instructions` and `bypassCache` flag\n- `worksheetIds`: list of data source identifiers to scope the decomposition\n- `answerIds`: list of Answer GUIDs whose data guides the response\n- `liveboardIds`: list of Liveboard GUIDs whose data guides the response\n- `conversationId`: an existing conversation session ID for context continuity\n- `content`: supplementary text or CSV data to improve response quality\n- `maxDecomposedQueries`: maximum number of sub-questions to return (default: `5`)\n\nIf the request is successful, the API returns a `decomposedQueryResponse` containing a list of `decomposedQueries`, each with:\n- `query`: the generated analytical sub-question\n- `worksheetId`: the unique ID of the data source the question targets\n- `worksheetName`: the display name of the corresponding data source\n\n#### Error responses\n\n| Code | Description |\n|------|---------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. |\n\n> ###### Note:\n> * This endpoint is deprecated since 10.13.0.cl. Use `getRelevantQuestions` for new integrations.\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", + "deprecated": true, + "tags": [ + "AI", + "10.7.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryGetDecomposedQueryRequest" + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Common successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/eureka_DecomposeQueryResponse" + } + } + } + }, + "201": { + "description": "Common error response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/eureka_DecomposeQueryResponse" + } + } + } + }, + "400": { + "description": "Operation failed", + "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": "Operation failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send": { + "post": { + "operationId": "sendAgentConversationMessage", + "description": "\n Version: 26.5.0.cl or later\n\nVersion: 26.5.0.cl or later\n\nSends natural language messages to an existing Spotter agent conversation and returns the complete response synchronously.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nThe API returns an array of response objects, each containing:\n\n- `type`: the kind of response — `text`, `answer`, or `error`\n- `message`: the main content of the response\n- `metadata`: additional information depending on the message type (e.g., answer metadata includes analytics and visualization details)\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is Generally Available from version 26.5.0.cl.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n> - For real-time streamed responses, use `sendAgentConversationMessageStreaming` instead.\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "AI", + "26.5.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendAgentConversationMessageRequest" + } + } + }, + "required": true + }, + "parameters": [ + { + "in": "path", + "name": "conversation_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique identifier for the conversation (used to track context)" + } + ], + "responses": { + "200": { + "description": "Common successful response", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "example_1": { + "summary": "Send a message to an existing agent conversation", + "value": { + "messages": [ + { + "metadata": {}, + "internal": {}, + "type": "text", + "text": "\n\nI'll compare sales between 2025 and 2024. First, let me get the dataset context to identify the relevant sales and date columns.", + "agent_context": "" + }, + { + "metadata": {}, + "internal": {}, + "type": "text", + "text": "```json\n{\"search_mode\": \"semantic\", \"dataset_name\": \"(Sample) Retail - Apparel\", \"columns\": [{\"name\": \"sales\", \"type\": \"MEASURE\", \"data_type\": \"double\"}, {\"name\": \"date\", \"type\": \"ATTRIBUTE\", \"data_type\": \"date\", \"sample_values\": [\"2025\", \"2024\"]}]}\n```", + "agent_context": "" + }, + { + "metadata": {}, + "internal": {}, + "type": "text", + "text": "\n\nPerfect! I found the sales and date columns. I can see the dataset contains sales data for both 2025 and 2024. Now I'll create a comparison query to show sales for 2025 versus 2024.", + "agent_context": "" + }, + { + "metadata": { + "output": "", + "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "assumptions": "", + "chart_type": "KPI", + "interrupted": false, + "data_awareness_enabled": true + }, + "internal": {}, + "type": "answer", + "title": "Compare total sales for 2025 vs 2024", + "description": "", + "session_id": "842bb67a-e08e-4861-97e8-8db9538db51d", + "gen_no": 2, + "sage_query": "[sales] [date] = '2025' vs [date] = '2024'", + "tml_tokens": [ + "[sales]", + "[date] = '2025' vs [date] = '2024'" + ], + "formulas": [], + "parameters": [], + "subqueries": [], + "viz_suggestion": "CAEQIBomEiQ2NjE5NzI0Yy1kMjVlLTU4MDItOWNjOC1jNDA3MWY3OWY5MzAoATIA", + "ac_state": null + }, + { + "metadata": {}, + "internal": {}, + "type": "text", + "text": "\n\nThe visualization shows the side-by-side comparison of total sales (in USD) between the two years, allowing you to see the year-over-year performance. You can see the sales figures for both 2024 and 2025, making it easy to identify growth or decline trends in your retail apparel business.", + "agent_context": "" + } + ] + } + } + } + } + } + }, + "201": { + "description": "Common error response", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Operation failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized access.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/eureka_GetRelevantQuestionsResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Operation failed", + "403": { + "description": "Forbidden access.", "content": { "application/json": { "schema": { @@ -523,33 +879,88 @@ } } }, - "/api/rest/2.0/ai/analytical-questions": { + "/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream": { "post": { - "operationId": "queryGetDecomposedQuery", - "description": "\nBeta Version: 10.7.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n", - "deprecated": true, + "operationId": "sendAgentConversationMessageStreaming", + "description": "\n Version: 26.5.0.cl or later\n\nVersion: 26.5.0.cl or later\n\nSends one or more natural language messages to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events stream.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nIf the request is valid, the API returns a Server-Sent Events (SSE) stream. Each line has the form `data: [{\"type\": \"...\", ...}]` — a JSON array of event objects. Event types include:\n\n- `ack`: confirms receipt of the request (`node_id`)\n- `conv_title`: conversation title (`title`, `conv_id`)\n- `notification`: status updates on operations (`group_id`, `metadata`, `code` — e.g. `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`)\n- `text-chunk`: incremental content chunks (`id`, `group_id`, `metadata` with `format` and `type` such as `thinking` or `text`, `content`)\n- `text`: full text block with same structure as `text-chunk`\n- `answer`: structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title`, etc., `title`)\n- `error`: if a failure occurs\n\n#### Error responses\n\n| Code | Description |\n| ---- | -------------------------------------------------------------------------------------------------------------------------------- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is Generally Available from version 26.5.0.cl.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n> - The streaming protocol uses Server-Sent Events (SSE).\n> - For the complete response in a single payload, use `sendAgentConversationMessage` instead.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", - "10.7.0.cl" + "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QueryGetDecomposedQueryRequest" + "$ref": "#/components/schemas/SendAgentConversationMessageStreamingRequest" } } }, "required": true }, - "parameters": [], + "parameters": [ + { + "in": "path", + "name": "conversation_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique identifier for the conversation (used to track context)" + } + ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/eureka_DecomposeQueryResponse" + "$ref": "#/components/schemas/SendAgentMessageResponse" + }, + "examples": { + "example_1": { + "summary": "SSE stream — each line is data: [{\"type\": \"...\", ...}]. Events arrive over time; this example shows a minimal sequence.", + "value": [ + { + "type": "ack", + "node_id": "aGxzcFVrtom8" + }, + { + "type": "conv_title", + "title": "Sales 2025 vs 2024", + "conv_id": "-XIi04l5rrof" + }, + { + "type": "notification", + "group_id": "cDEsAQbSnd3J", + "metadata": { + "type": "thinking", + "tool_title": "Analyzing Sales Performance: 2025 vs 2024" + }, + "code": "TOOL_CALL_NOTIFICATION" + }, + { + "id": "mNAdvy-NK2l6", + "type": "text-chunk", + "group_id": "cDEsAQbSnd3J", + "metadata": { + "format": "markdown", + "type": "thinking" + }, + "content": "\n\nI need to compare sales performance between 2025 and 2024." + }, + { + "id": "hxWMDP-pgR3B", + "type": "answer", + "group_id": "m1MTvttEUa7o", + "metadata": { + "sage_query": "[sales] [date] = '2025' vs [date] = '2024'", + "session_id": "431adcf9-1328-4d8c-81a1-0faa7fa37ba6", + "title": "Compare sales for 2025 vs 2024" + }, + "title": "Compare sales for 2025 vs 2024" + } + ] + } } } } @@ -559,7 +970,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/eureka_DecomposeQueryResponse" + "$ref": "#/components/schemas/SendAgentMessageResponse" } } } @@ -574,6 +985,26 @@ } } }, + "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": "Operation failed", "content": { @@ -590,10 +1021,11 @@ "/api/rest/2.0/ai/agent/{conversation_identifier}/converse": { "post": { "operationId": "sendAgentMessage", - "description": "\nBeta Version: 10.15.0.cl or later\n\nThis API allows users to initiate or continue an agent (Spotter) conversation by submitting one or more natural language messages. \nTo use this API, the user must have access to the relevant conversational session (via conversation_identifier) and submit at least one message.\n\n\n#### Usage guidelines\n\nTo initiate or continue a conversation, the request must include:\n- `conversation_identifier`: a unique session ID for continuity and message tracking\n- `messages`: an array of one or more text messages, each with a value and type\n\nThe API returns a array of object with a type, message, and metadata.\n- `type`: Type of the message — text, answer, or error.\n- `message`: Main content of the response.\n- `metadata`: Additional info depending on the message 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#### Endpoint URL\n", + "description": "\nBeta Version: 26.2.0.cl or later\n\n**Deprecated** — Use `sendAgentConversationMessage` instead.\n\nSend natural language messages to an existing Spotter agent conversation and returns the complete response synchronously.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`.\nA conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nThe API returns an array of response objects, each containing:\n\n- `type`: the kind of response — `text`, `answer`, or `error`\n- `message`: the main content of the response\n- `metadata`: additional information depending on the message type (e.g., answer metadata includes analytics and visualization details)\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is deprecated. Use `sendAgentConversationMessage` for new integrations.\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", + "deprecated": true, "tags": [ "AI", - "10.15.0.cl" + "26.2.0.cl" ], "requestBody": { "content": { @@ -647,6 +1079,26 @@ } } }, + "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": "Operation failed", "content": { @@ -663,10 +1115,11 @@ "/api/rest/2.0/ai/agent/converse/sse": { "post": { "operationId": "sendAgentMessageStreaming", - "description": "\nBeta Version: 10.13.0.cl or later\n\nThis API allows users to initiate or continue an agent (Spotter) conversation by submitting one or more natural language messages. \nTo use this API, the user must have access to the relevant conversational session (via conversation_identifier) and submit at least one message.\n\n\n#### Usage guidelines\n\nTo initiate or continue a conversation, the request must include:\n- `conversation_identifier`: a unique session ID for continuity and message tracking\n- `messages`: an array of one or more text messages, each with a value and type\n\nAdditionally, user can specify what tool can be included `conversation_settings` parameter, which supports:\n- `enable_contextual_change_analysis` (default: false)\n- `enable_natural_language_answer_generation` (default: true)\n- `enable_reasoning` (default: false)\n\nIf the request is valid, the API returns a stream of messages in real time, including:\n- `ack`: confirms receipt of the request\n- `text / text-chunk`: content chunks, optionally formatted (e.g., markdown)\n- `answer`: the final structured response with metadata and analytics\n- `error`: if a failure occurs\n- `notification`: notification messages for operation being performed\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> * The streaming protocol uses Server-Sent Events (SSE)\n\n\n\n#### Endpoint URL\n", + "description": "\nBeta Version: 26.2.0.cl or later\n\n**Deprecated** — Use `sendAgentConversationMessageStreaming` instead.\n\nSends one or more natural language messages to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events stream.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nIf the request is valid, the API returns a Server-Sent Events (SSE) stream. Each line has the form `data: [{\"type\": \"...\", ...}]` — a JSON array of event objects. Event types include:\n\n- `ack`: confirms receipt of the request (`node_id`)\n- `conv_title`: conversation title (`title`, `conv_id`)\n- `notification`: status updates on operations (`group_id`, `metadata`, `code` — e.g. `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`)\n- `text-chunk`: incremental content chunks (`id`, `group_id`, `metadata` with `format` and `type` such as `thinking` or `text`, `content`)\n- `text`: full text block with same structure as `text-chunk`\n- `answer`: structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title`, etc., `title`)\n- `error`: if a failure occurs\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is deprecated. Use `sendAgentConversationMessageStreaming` for new integrations.\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> - The streaming protocol uses Server-Sent Events (SSE).\n\n\n\n\n#### Endpoint URL\n", + "deprecated": true, "tags": [ "AI", - "10.13.0.cl" + "26.2.0.cl" ], "requestBody": { "content": { @@ -710,6 +1163,26 @@ } } }, + "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": "Operation failed", "content": { @@ -726,7 +1199,7 @@ "/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", + "description": "\nBeta Version: 10.4.0.cl or later\n\nSends a follow-up message to an existing conversation within the context of a data model.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. A conversation must first be created using the `createConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n- `conversation_identifier`: the unique session ID returned by `createConversation`\n- `metadata_identifier`: the unique ID of the data source used for the conversation\n- `message`: a natural language string with the follow-up question\n\nIf the request is successful, the API returns an array of response messages, each containing:\n- `session_identifier`: the unique ID of the generated response\n- `generation_number`: the generation number of the response\n- `message_type`: the type of the response (e.g., `TSAnswer`)\n- `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`)\n- `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response\n\n#### Error responses\n\n| Code | Description |\n|------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\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" @@ -789,6 +1262,26 @@ } } }, + "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": "Operation failed", "content": { @@ -805,7 +1298,7 @@ "/api/rest/2.0/ai/instructions/set": { "post": { "operationId": "setNLInstructions", - "description": "\nBeta Version: 10.15.0.cl or later\n\nThis API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses.\n\n#### Usage guidelines\n\nTo set NL instructions for a data-model, the request must include:\n- `data_source_identifier`: The unique ID of the data-model for which to set NL instructions\n- `nl_instructions_info`: An array of instruction objects, each containing:\n - `instructions`: Array of text instructions for the LLM\n - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future.\n\nThe API returns a response object with:\n- `success`: Boolean indicating whether the operation was successful\n\n#### Instructions Scope\n\n- **GLOBAL**: Instructions that apply globally for that data-model across the system\n\n> ###### Note:\n> * To use this API, the user needs either edit access or SPOTTER_COACHING_PRIVILEGE on the data-model and they must use corresponding org related bearerToken where the data-model exists.\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * Available from version 10.15.0.cl and later.\n> * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> * Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model.\n\n\n\n\n#### Endpoint URL\n", + "description": "\nBeta Version: 10.15.0.cl or later\n\nThis API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses.\n\nRequires `CAN_USE_SPOTTER` privilege, either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and a bearer token corresponding to the org where the data model exists.\n\n#### Usage guidelines\n\nTo set NL instructions for a data-model, the request must include:\n\n- `data_source_identifier`: The unique ID of the data-model for which to set NL instructions\n- `nl_instructions_info`: An array of instruction objects, each containing:\n - `instructions`: Array of text instructions for the LLM\n - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future.\n\n#### Instructions scope\n\n- **GLOBAL**: instructions that apply to all users querying this data model\n\nIf the request is successful, the API returns:\n\n- `success`: a boolean indicating whether the operation completed successfully\n\n#### Error responses\n\n| Code | Description |\n|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, or the bearer token does not correspond to the org where the data model exists. |\n\n> ###### Note:\n>\n> - To use this API, the user needs either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and must use the bearer token corresponding to the org where the data model exists.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - Available from version 10.15.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> - Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.15.0.cl" @@ -852,6 +1345,26 @@ } } }, + "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": "Operation failed", "content": { @@ -868,7 +1381,7 @@ "/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", + "description": "\nBeta Version: 10.4.0.cl or later\n\nProcesses a natural language query against a specified data model and returns a single AI-generated answer without requiring a conversation session.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe request must include:\n- `query`: a natural language question (e.g., \"What were total sales last quarter?\")\n- `metadata_identifier`: the unique ID of the data source to query against\n\nIf the request is successful, the API returns a response message containing:\n- `session_identifier`: the unique ID of the generated response\n- `generation_number`: the generation number of the response\n- `message_type`: the type of the response (e.g., `TSAnswer`)\n- `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`)\n- `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response\n\n#### Error responses\n\n| Code | Description |\n|------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\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" @@ -915,6 +1428,26 @@ } } }, + "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": "Operation failed", "content": { @@ -2831,9 +3364,9 @@ } }, "/api/rest/2.0/connections/{connection_identifier}/status": { - "put": { + "post": { "operationId": "updateConnectionStatus", - "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. It does not remove the connection metadata, but only makes the connection unavailable for queries and operations. You can reactivate a deactivated connection by setting \"status\": \"ACTIVATED\".\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. It does not remove the connection metadata, but only makes the connection unavailable for queries and operations. You can reactivate a deactivated connection by setting \"status\": \"ACTIVATED\".\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.6.0.cl" @@ -20072,23 +20605,13 @@ "type": { "type": "string", "enum": [ - "answer", - "liveboard", - "data_source" + "data_source", + "DATA_SOURCE", + "AUTO_MODE" ], "description": "Type of the context.", "nullable": true }, - "answer_context": { - "$ref": "#/components/schemas/AnswerContextInput", - "description": "Answer context.", - "nullable": true - }, - "liveboard_context": { - "$ref": "#/components/schemas/LBContextInput", - "description": "Liveboard context.", - "nullable": true - }, "data_source_context": { "$ref": "#/components/schemas/DataSourceContextInput", "description": "Data source context.", @@ -20096,50 +20619,26 @@ } } }, - "AnswerContextInput": { + "DataSourceContextInput": { "type": "object", - "required": [ - "session_identifier", - "generation_number" - ], "properties": { - "session_identifier": { + "data_source_identifier": { "type": "string", - "description": "Unique identifier of the answer session." + "description": "Unique identifier of the data source.\nRequired when context type is DATA_SOURCE and `data_source_identifiers` is not provided.\nAt least one of `data_source_identifier` or `data_source_identifiers` must be supplied for DATA_SOURCE context;\nomit only when context type is AUTO_MODE.
Version: 26.5.0.cl or later", + "nullable": true }, - "generation_number": { - "type": "integer", - "format": "int32", - "description": "Generation number of the answer." - } - } - }, - "LBContextInput": { - "type": "object", - "required": [ - "liveboard_identifier", - "visualization_identifier" - ], - "properties": { - "liveboard_identifier": { - "type": "string", - "description": "Unique identifier of the liveboard." + "data_source_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Unique identifiers of data sources for multi-data-source context.\nRequired when context type is DATA_SOURCE and `data_source_identifier` is not provided.
Version: 26.5.0.cl or later", + "nullable": true }, - "visualization_identifier": { - "type": "string", - "description": "Unique identifier of the visualization." - } - } - }, - "DataSourceContextInput": { - "type": "object", - "required": [ - "guid" - ], - "properties": { "guid": { "type": "string", - "description": "Unique identifier of the data source." + "description": "Deprecated. Use `data_source_identifier` instead.\nPreviously required when neither `data_source_identifier` nor `data_source_identifiers` was provided for DATA_SOURCE context.
Version: 26.2.0.cl or later", + "nullable": true } } }, @@ -20148,20 +20647,26 @@ "properties": { "enable_contextual_change_analysis": { "type": "boolean", - "default": false, - "description": "Enable contextual change analysis.", + "default": true, + "description": "Enable contextual change analysis.\nDefault changed from `false` to `true` in 26.2.0.cl.\nIgnored on versions >= 26.2.0.cl where it is always enabled.
Version: 10.4.0.cl or later", "nullable": true }, "enable_natural_language_answer_generation": { "type": "boolean", "default": true, - "description": "Enable natural language to answer generation.", + "description": "Enable natural language to answer generation.\nDefault changed from `false` to `true` in 26.2.0.cl.\nIgnored on versions >= 26.2.0.cl where it is always enabled.
Version: 10.4.0.cl or later", "nullable": true }, "enable_reasoning": { + "type": "boolean", + "default": true, + "description": "Enable reasoning.\nDefault changed from `false` to `true` in 26.2.0.cl.\nIgnored on versions >= 26.2.0.cl where it is always enabled.
Version: 10.4.0.cl or later", + "nullable": true + }, + "enable_save_chat": { "type": "boolean", "default": false, - "description": "Enable reasoning.", + "description": "Enable save conversation. When `true`, the conversation is persisted\nand can be retrieved later via conversation history.
Version: 26.5.0.cl or later", "nullable": true } } @@ -20169,12 +20674,17 @@ "AgentConversation": { "type": "object", "required": [ - "conversation_id" + "conversation_id", + "conversation_identifier" ], "properties": { "conversation_id": { "type": "string", "description": "Unique identifier of the conversation." + }, + "conversation_identifier": { + "type": "string", + "description": "Unique identifier of the conversation.
Version: 26.5.0.cl or later" } } }, @@ -20185,10 +20695,12 @@ ], "properties": { "success": { - "type": "boolean" + "type": "boolean", + "description": "Indicates whether the agent response was received and processed successfully." }, "message": { "type": "string", + "description": "Optional message providing additional context about the operation outcome.", "nullable": true } } @@ -21075,6 +21587,36 @@ } } }, + "SendAgentConversationMessageRequest": { + "type": "object", + "properties": { + "messages": { + "description": "messages to be sent to the agent", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "messages" + ] + }, + "SendAgentConversationMessageStreamingRequest": { + "type": "object", + "properties": { + "messages": { + "description": "messages to be sent to the agent", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "messages" + ] + }, "SendAgentMessageRequest": { "type": "object", "properties": { From 0b92a6a3a211bd61de9c744778f87698c2108319 Mon Sep 17 00:00:00 2001 From: manesh-brahmam Date: Tue, 31 Mar 2026 12:15:34 +0530 Subject: [PATCH 8/8] deactivate fix --- api-spec/openapiSpecv3-2_0.json | 40 ++++++++++++++++----------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index 402535cde..02b4ebe32 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -3366,7 +3366,7 @@ "/api/rest/2.0/connections/{connection_identifier}/status": { "post": { "operationId": "updateConnectionStatus", - "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. It does not remove the connection metadata, but only makes the connection unavailable for queries and operations. You can reactivate a deactivated connection by setting \"status\": \"ACTIVATED\".\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [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. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. It does not remove the connection metadata, but only makes the connection unavailable for queries and operations. You can reactivate a deactivated connection by setting \"status\": \"ACTIVATED\".\n\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.6.0.cl" @@ -6713,7 +6713,7 @@ "/api/rest/2.0/metadata/parameterize": { "post": { "operationId": "parameterizeMetadata", - "description": "\nParameterize fields in metadata objects.
Beta Version: 10.9.0.cl or later\n\nAllows parameterizing fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n\n\n\n#### Endpoint URL\n", + "description": "\nParameterize fields in metadata objects.
Beta Version: 10.9.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/metadata/parameterize-fields](/api/rest/2.0/metadata/parameterize-fields) instead.\n\nAllows parameterizing fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Metadata", @@ -6780,10 +6780,10 @@ "/api/rest/2.0/metadata/parameterize-fields": { "post": { "operationId": "parameterizeMetadataFields", - "description": "\nParameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE.
Version: 26.4.0.cl or later\n\nAllows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table, the field type must be `ATTRIBUTE` and field names can include:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_names specifies the exact properties of the Connection or Connection Config that need to be parameterized.\n\nFor Connection Config, supported field names include:\n* impersonate_user\n\nYou can parameterize multiple fields at once by providing an array of field names.\n\n\n\n\n#### Endpoint URL\n", + "description": "\nParameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE.
Version: 26.5.0.cl or later\n\nAllows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table, the field type must be `ATTRIBUTE` and field names can include:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_names specifies the exact properties of the Connection or Connection Config that need to be parameterized.\n\nFor Connection Config, supported field names include:\n* impersonate_user\n\nYou can parameterize multiple fields at once by providing an array of field names.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", - "26.4.0.cl" + "26.5.0.cl" ], "requestBody": { "content": { @@ -6922,10 +6922,10 @@ "/api/rest/2.0/metadata/unparameterize": { "post": { "operationId": "unparameterizeMetadata", - "description": "\nRemove parameterization from fields in metadata objects.
Beta Version: 10.9.0.cl or later\n\nAllows removing parameterization from fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows unparameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be unparameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n\n\n\n#### Endpoint URL\n", + "description": "\nRemove parameterization from fields in metadata objects.
Version: 26.5.0.cl or later\n\nAllows removing parameterization from fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows unparameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be unparameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", - "10.9.0.cl" + "26.5.0.cl" ], "requestBody": { "content": { @@ -8688,10 +8688,10 @@ "/api/rest/2.0/security/metadata/publish": { "post": { "operationId": "publishMetadata", - "description": "\nBeta Version: 10.9.0.cl or later\n\nAllows publishing metadata objects across organizations in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows publishing the following types of metadata objects:\n* Liveboards\n* Answers\n* Logical Tables\n\nThis API will essentially share the objects along with it's dependencies to\nthe org admins of the orgs to which it is being published.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.5.0.cl or later\n\nAllows publishing metadata objects across organizations in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows publishing the following types of metadata objects:\n* Liveboards\n* Answers\n* Logical Tables\n\nThis API will essentially share the objects along with it's dependencies to\nthe org admins of the orgs to which it is being published.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", - "10.9.0.cl" + "26.5.0.cl" ], "requestBody": { "content": { @@ -8820,10 +8820,10 @@ "/api/rest/2.0/security/metadata/unpublish": { "post": { "operationId": "unpublishMetadata", - "description": "\nBeta Version: 10.9.0.cl or later\n\nAllows unpublishing metadata objects from organizations in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows unpublishing the following types of metadata objects:\n* Liveboards\n* Answers\n* Logical Tables\n\nWhen unpublishing objects, you can:\n* Include dependencies by setting `include_dependencies` to true - this will unpublish all dependent objects if no other published object is using them\n* Force unpublish by setting `force` to true - this will break all dependent objects in the unpublished organizations\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 26.5.0.cl or later\n\nAllows unpublishing metadata objects from organizations in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows unpublishing the following types of metadata objects:\n* Liveboards\n* Answers\n* Logical Tables\n\nWhen unpublishing objects, you can:\n* Include dependencies by setting `include_dependencies` to true - this will unpublish all dependent objects if no other published object is using them\n* Force unpublish by setting `force` to true - this will break all dependent objects in the unpublished organizations\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", - "10.9.0.cl" + "26.5.0.cl" ], "requestBody": { "content": { @@ -10873,10 +10873,10 @@ "/api/rest/2.0/template/variables/create": { "post": { "operationId": "createVariable", - "description": "\nCreate a variable which can be used for parameterizing metadata objects
Beta Version: 10.14.0.cl or later\n\nAllows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports the following types of variables:\n* CONNECTION_PROPERTY - For connection properties\n* TABLE_MAPPING - For table mappings\n* CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this.\n* FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl\n\nWhen creating a variable, you need to specify:\n* The variable type\n* A unique name for the variable\n* Whether the variable contains sensitive values (defaults to false)\n* The data type of the variable, only specify for formula variables (defaults to null)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable name already exists\n* The variable type is invalid\n\n\n\n#### Endpoint URL\n", + "description": "\nCreate a variable which can be used for parameterizing metadata objects
Version: 26.4.0.cl or later\n\nAllows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports the following types of variables:\n* CONNECTION_PROPERTY - For connection properties\n* TABLE_MAPPING - For table mappings\n* CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this.\n* FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl\n\nWhen creating a variable, you need to specify:\n* The variable type\n* A unique name for the variable\n* Whether the variable contains sensitive values (defaults to false)\n* The data type of the variable, only specify for formula variables (defaults to null)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable name already exists\n* The variable type is invalid\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", - "10.14.0.cl" + "26.4.0.cl" ], "requestBody": { "content": { @@ -10946,7 +10946,7 @@ "/api/rest/2.0/template/variables/{identifier}/delete": { "post": { "operationId": "deleteVariable", - "description": "\nDelete a variable
Beta Version: 10.14.0.cl or later\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifier (ID or name)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable doesn't exist\n* The variable is being used by other objects \n\n\n\n#### Endpoint URL\n", + "description": "\nDelete a variable
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/delete](/api/rest/2.0/template/variables/delete) instead.\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifier (ID or name)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable doesn't exist\n* The variable is being used by other objects \n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Variable", @@ -11013,7 +11013,7 @@ "/api/rest/2.0/template/variables/delete": { "post": { "operationId": "deleteVariables", - "description": "\nDelete variable(s)
Beta Version: 26.4.0.cl or later\n\nAllows deleting multiple variables from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifiers (IDs or names)\n\nThe operation will fail if:\n* The user lacks required permissions\n* Any of the variables don't exist\n* Any of the variables are being used by other objects\n\n\n\n\n#### Endpoint URL\n", + "description": "\nDelete variable(s)
Version: 26.4.0.cl or later\n\nAllows deleting multiple variables from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifiers (IDs or names)\n\nThe operation will fail if:\n* The user lacks required permissions\n* Any of the variables don't exist\n* Any of the variables are being used by other objects\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" @@ -11079,7 +11079,7 @@ "/api/rest/2.0/template/variables/{identifier}/update-values": { "post": { "operationId": "putVariableValues", - "description": "\nUpdate values for a variable
Beta Version: 26.4.0.cl or later\n\nAllows updating values for a specific variable in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to the variable\n* Replacing existing values\n* Deleting values from the variable\n* Resetting all values\n\nWhen updating variable values, you need to specify:\n* The variable identifier (ID or name)\n* The values to add/replace/remove\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constraints for the given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", + "description": "\nUpdate values for a variable
Version: 26.4.0.cl or later\n\nAllows updating values for a specific variable in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to the variable\n* Replacing existing values\n* Deleting values from the variable\n* Resetting all values\n\nWhen updating variable values, you need to specify:\n* The variable identifier (ID or name)\n* The values to add/replace/remove\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constraints for the given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" @@ -11155,10 +11155,10 @@ "/api/rest/2.0/template/variables/search": { "post": { "operationId": "searchVariables", - "description": "\nSearch variables
Beta Version: 10.14.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports searching variables by:\n* Variable identifier (ID or name)\n* Variable type\n* Name pattern (case-insensitive, supports % for wildcard)\n\nThe search results can be formatted in three ways:\n* METADATA - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n\nThe values can be filtered by scope:\n* org_identifier\n* principal_identifier\n* model_identifier\n\n\n\n\n#### Endpoint URL\n", + "description": "\nSearch variables
Version: 26.4.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports searching variables by:\n* Variable identifier (ID or name)\n* Variable type\n* Name pattern (case-insensitive, supports % for wildcard)\n\nThe search results can be formatted in three ways:\n* METADATA - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n\nThe values can be filtered by scope:\n* org_identifier\n* principal_identifier\n* model_identifier\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", - "10.14.0.cl" + "26.4.0.cl" ], "requestBody": { "content": { @@ -11231,10 +11231,10 @@ "/api/rest/2.0/template/variables/{identifier}/update": { "post": { "operationId": "updateVariable", - "description": "\nUpdate a variable's name
Beta Version: 10.14.0.cl or later\n\nAllows updating a variable's name in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows updating:\n* The variable name\n\n\n\n#### Endpoint URL\n", + "description": "\nUpdate a variable's name
Version: 26.4.0.cl or later\n\nAllows updating a variable's name in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows updating:\n* The variable name\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", - "10.14.0.cl" + "26.4.0.cl" ], "requestBody": { "content": { @@ -11307,7 +11307,7 @@ "/api/rest/2.0/template/variables/update-values": { "post": { "operationId": "updateVariableValues", - "description": "\nUpdate values for multiple variables
Beta Version: 10.14.0.cl or later\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to variables\n* Replacing existing values\n* Deleting values from variables\n\nWhen updating variable values, you need to specify:\n* The variable identifiers\n* The values to add/replace/remove for each variable\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constrains for a given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", + "description": "\nUpdate values for multiple variables
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/{identifier}/update-values](/api/rest/2.0/template/variables/%7Bidentifier%7D/update-values) instead.\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to variables\n* Replacing existing values\n* Deleting values from variables\n\nWhen updating variable values, you need to specify:\n* The variable identifiers\n* The values to add/replace/remove for each variable\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constrains for a given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Variable",