** in the Liveboard schedule email notifications.\n* For Liveboards with both charts and tables, schedule creation is only supported in PDF and XLS formats. Schedules created in CSV formats for such Liveboards will fail to run. If `PDF` is set as the `file_format`, enable `pdf_options` to get the correct attachment. Not doing so may cause the attachment to be rendered empty.\n* To include only specific visualizations, specify the visualization GUIDs in the `visualization_identifiers` array.\n* You can schedule a Liveboard job to run periodically by setting frequency parameters. You can set the schedule to run daily, weekly, monthly or every n minutes or hours. The scheduled job can also be configured to run at a specific time of the day or on specific days of the week or month. Please ensure that when setting the schedule frequency for _minute of the object_, only values that are multiples of 5 are included.\n* If the `frequency` parameters are defined, you can set the time zone to a value that matches your server's time zone. For example, `US/Central`, `Etc/UTC`, `CET`. The default time zone is `America/Los_Angeles`.\n\nFor more information about Liveboard jobs, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/liveboard-schedule).\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Schedules", "9.4.0.cl"],
"requestBody": {
"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/CreateScheduleRequest"
}
}
},
"required": true
},
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Schedule successfully created.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResponseSchedule"
+ }
+ }
+ }
+ },
+ "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/schedules/{schedule_identifier}/delete": {
+ "post": {
+ "operationId": "deleteSchedule",
+ "description": "\nDeletes a scheduled job.
Version: 9.4.0.cl or later\n\nDeletes a scheduled Liveboard job.\n\nRequires at least edit access to Liveboard or `ADMINISTRATION` (**Can administer Org**) privilege. \nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Schedules", "9.4.0.cl"],
"parameters": [
{
"in": "path",
- "name": "tag_identifier",
+ "name": "schedule_identifier",
"required": true,
"schema": {
"type": "string"
},
- "description": "Name or Id of the tag."
+ "description": "Unique ID or name of the scheduled job."
}
],
"responses": {
"204": {
- "description": "Tag successfully updated."
+ "description": "Schedule successfully deleted."
},
"400": {
"description": "Invalid request.",
@@ -10818,42 +6419,16 @@
}
}
},
- "/api/rest/2.0/users/activate": {
+ "/api/rest/2.0/schedules/search": {
"post": {
- "operationId": "activateUser",
- "description": "\n Version: 9.7.0.cl or later\n\nActivates a deactivated user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo activate an inactive user account, the API request body must include the following information:\n\n- Username or the GUID of the user account.\n- Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated.\n- Password for the user account.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.7.0.cl"
- ],
+ "operationId": "searchSchedules",
+ "description": "\nSearch Schedules
Version: 9.4.0.cl or later\n\nGets a list of scheduled jobs configured for a Liveboard.\n\nTo get details of a specific scheduled job, specify the name or GUID of the scheduled job.\n\nRequires at least view access to Liveboards.\n\n**NOTE**: When filtering schedules by parameters other than `metadata`, set `record_size` to `-1` and `record_offset` to `0` for accurate results.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Schedules", "9.4.0.cl"],
"requestBody": {
"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/SearchSchedulesRequest"
}
}
},
@@ -10862,11 +6437,14 @@
"parameters": [],
"responses": {
"200": {
- "description": "User activated successfully.",
+ "description": "Schedule search result.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/User"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseSchedule"
+ }
}
}
}
@@ -10914,47 +6492,35 @@
}
}
},
- "/api/rest/2.0/users/change-password": {
+ "/api/rest/2.0/schedules/{schedule_identifier}/update": {
"post": {
- "operationId": "changeUserPassword",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates the current password of the user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "operationId": "updateSchedule",
+ "description": "\nUpdate schedule.
Version: 9.4.0.cl or later\n\nUpdates a scheduled Liveboard job.\n\nRequires at least edit access to Liveboards. To update a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\nThe API endpoint allows you to pause a scheduled job, change the status of a paused job. You can also edit the recipients list, frequency of the job, format of the file to send to the recipients in email notifications, PDF options, and time zone setting.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Schedules", "9.4.0.cl"],
"requestBody": {
"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/UpdateScheduleRequest"
}
}
},
"required": true
},
- "parameters": [],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "schedule_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of the schedule."
+ }
+ ],
"responses": {
"204": {
- "description": "User password change operation successful."
+ "description": "Schedule successfully updated."
},
"400": {
"description": "Invalid request.",
@@ -10999,170 +6565,16 @@
}
}
},
- "/api/rest/2.0/users/create": {
+ "/api/rest/2.0/security/metadata/assign": {
"post": {
- "operationId": "createUser",
- "description": "\n Version: 9.0.0.cl or later\n\nCreates a user in ThoughtSpot.\n\nThe API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "operationId": "assignChangeAuthor",
+ "description": "\n Version: 9.0.0.cl or later\n\nTransfers the ownership of one or several objects from one user to another.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege and edit access to the objects are required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "9.0.0.cl"],
"requestBody": {
"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.",
- "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"
- ]
- },
- "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/AssignChangeAuthorRequest"
}
}
},
@@ -11170,15 +6582,8 @@
},
"parameters": [],
"responses": {
- "200": {
- "description": "User successfully created.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
+ "204": {
+ "description": "Author assignment for given metadata objects is successful."
},
"400": {
"description": "Invalid request.",
@@ -11223,33 +6628,16 @@
}
}
},
- "/api/rest/2.0/users/deactivate": {
+ "/api/rest/2.0/security/column/rules/fetch": {
"post": {
- "operationId": "deactivateUser",
- "description": "\n Version: 9.7.0.cl or later\n\nDeactivates a user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo deactivate a user account, the API request body must include the following information:\n\n- Username or the GUID of the user account\n- Base URL of the ThoughtSpot instance\n\nIf the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.7.0.cl"
- ],
+ "operationId": "fetchColumnSecurityRules",
+ "description": "\nBeta Version: 10.12.0.cl or later\n\nFetches column security rules for specified tables.\n\nThis API endpoint retrieves column-level security rules configured for tables. It returns information about which columns are secured and which groups have access to those columns.\n\n#### Usage guidelines\n\n- Provide an array of table identifiers using either `identifier` (GUID or name) or `obj_identifier` (object ID)\n- At least one of `identifier` or `obj_identifier` must be provided for each table\n- The API returns column security rules for all specified tables\n- Users must have appropriate permissions to access security rules for the specified tables\n\n#### Required permissions\n\n- `ADMINISTRATION` - Can administer ThoughtSpot\n- `DATAMANAGEMENT` - Can manage data\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables\n\n#### Example request\n\n```json\n{\n \"tables\": [\n {\n \"identifier\": \"table-guid\",\n \"obj_identifier\": \"table-object-id\"\n }\n ]\n}\n```\n\n#### Response format\n\nThe API returns an array of `ColumnSecurityRuleResponse` objects wrapped in a `data` field. Each `ColumnSecurityRuleResponse` object contains:\n- Table information (GUID and object ID) \n- Array of column security rules with column details, group access, and source table information\n\n#### Example response\n\n```json\n{\n \"data\": [\n {\n \"guid\": \"table-guid\",\n \"objId\": \"table-object-id\",\n \"columnSecurityRules\": [\n {\n \"column\": {\n \"id\": \"col_123\",\n \"name\": \"Salary\"\n },\n \"groups\": [\n {\n \"id\": \"group_1\",\n \"name\": \"HR Department\"\n }\n ],\n \"sourceTableDetails\": {\n \"id\": \"source-table-guid\",\n \"name\": \"Employee_Data\"\n }\n }\n ]\n }\n ]\n}\n```\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "10.12.0.cl"],
"requestBody": {
"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/FetchColumnSecurityRulesRequest"
}
}
},
@@ -11258,17 +6646,20 @@
"parameters": [],
"responses": {
"200": {
- "description": "User deactivated successfully.",
+ "description": "Successfully fetched column security rules",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ResponseActivationURL"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ColumnSecurityRuleResponse"
+ }
}
}
}
},
"400": {
- "description": "Invalid request.",
+ "description": "Bad request - Table not found or invalid parameters",
"content": {
"application/json": {
"schema": {
@@ -11288,7 +6679,7 @@
}
},
"403": {
- "description": "Forbidden access.",
+ "description": "Forbidden - User doesn't have permission to access security rules for this table",
"content": {
"application/json": {
"schema": {
@@ -11298,7 +6689,7 @@
}
},
"500": {
- "description": "Unexpected error",
+ "description": "Internal server error",
"content": {
"application/json": {
"schema": {
@@ -11310,28 +6701,32 @@
}
}
},
- "/api/rest/2.0/users/{user_identifier}/delete": {
+ "/api/rest/2.0/security/metadata/fetch-object-privileges": {
"post": {
- "operationId": "deleteUser",
- "description": "\n Version: 9.0.0.cl or later\n\nDeletes a user from the ThoughtSpot system.\n\nIf you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "user_identifier",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "GUID / name of the user"
- }
- ],
+ "operationId": "fetchObjectPrivileges",
+ "description": "\n Version: 26.3.0.cl or later\n\nThis API fetches the object privileges present for the given list of principals (user or group), on the given set of objects. It supports pagination, which can be enabled and configured using the request parameters. It provides users access to certain features based on privilege based access control.\n\n#### Usage guidelines\n\n- Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals for which you want to retrieve object privilege information in the `principals` array.\n- Specify the `type` (`LOGICAL_TABLE`) and `identifier` (either GUID or name) of the metadata objects for which you want to retrieve object privilege information in the `metadata` array. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future.\n- To control the offset from where principals have to be fetched, use `record_offset`. When `record_offset` is 0, information is fetched from the beginning.\n- To control the number of principals to be fetched, use `record_size`. Default `record_size` is 20.\n- Ensure `record_offset` for a subsequent request is one more than the value of `record_size` of the previous request.\n- Ensure using correct Authorization Bearer Token corresponding to specific user & org. \n\n#### Example request\n\n```json\n{\n \"principals\": [\n {\n \"type\": \"type-1\",\n \"identifier\": \"principal-guid-or-name-1\"\n },\n {\n \"type\": \"type-2\",\n \"identifier\": \"principal-guid-or-name-2\"\n }\n ],\n \"metadata\": [\n {\n \"type\": \"metadata-type-1\",\n \"identifier\": \"metadata-guid-or-name-1\"\n },\n {\n \"type\": \"metadata-type-2\",\n \"identifier\": \"metadata-guid-or-name-2\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 20\n}\n```\n\n\n#### Response format\n\nThe API returns an array of `metadata_object_privileges` objects wrapped in JSON. Each `metadata_object_privileges` object contains:\n- Metadata information (GUID, name and type)\n- Array of `principal_object_privilege_info`.\n- Each `principal_object_privilege_info` contains:\n - Principal type. All principals of this type are listed as described below.\n - Array of `principal_object_privileges`.\n - Each `principal_object_privileges` contains:\n - Principal information (GUID, name, subtype)\n - List of applied object level privileges.\n\n#### Example response\n\n```json\n{\n \"metadata_object_privileges\": [\n {\n \"metadata_id\": \"metadata-guid-1\",\n \"metadata_name\": \"metadata-name-1\",\n \"metadata_type\": \"metadata-type-1\",\n \"principal_object_privilege_info\": [\n {\n \"principal_type\": \"principal-type-1\",\n \"principal_object_privileges\": [\n {\n \"principal_id\": \"principal-guid-1\",\n \"principal_name\": \"principal-name-1\",\n \"principal_sub_type\": \"principal-sub-type-1\",\n \"object_privileges\": \"[object-privilege-1, object-privilege-2]\"\n },\n {\n \"principal_id\": \"principal-guid-2\",\n \"principal_name\": \"principal-name-2\",\n \"principal_sub_type\": \"principal-sub-type-2\",\n \"object_privileges\": \"[object-privilege-1, object-privilege-2]\"\n }\n ]\n },\n {\n \"principal_type\": \"principal-type-2\",\n \"principal_object_privileges\": [\n {\n \"principal_id\": \"principal-guid-3\",\n \"principal_name\": \"principal-guid-4\",\n \"principal_sub_type\": \"principal-sub-type-4\",\n \"object_privileges\": \"[object-privilege-1]\"\n }\n ]\n }\n ]\n },\n {\n \"metadata_id\": \"metadata-guid-2\",\n \"metadata_name\": \"metadata-name-2\",\n \"metadata_type\": \"metadata-type-2\",\n \"principal_object_privilege_info\": [\n {\n \"principal_type\": \"principal-type-1\",\n \"principal_object_privileges\": [\n {\n \"principal_id\": \"principal-guid-1\",\n \"principal_name\": \"principal-name-1\",\n \"principal_sub_type\": \"principal-sub-type-1\",\n \"object_privileges\": \"[object-privilege-3, object-privilege-4]\"\n },\n {\n \"principal_id\": \"principal-guid-2\",\n \"principal_name\": \"principal-name-2\",\n \"principal_sub_type\": \"principal-sub-type-2\",\n \"object_privileges\": \"[object-privilege-4]\"\n }\n ]\n }\n ]\n }\n ]\n}\n```\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "26.3.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FetchObjectPrivilegesRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
"responses": {
- "204": {
- "description": "User successfully deleted."
+ "200": {
+ "description": "Fetching defined object privileges of metadata objects is successful.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ObjectPrivilegesOfMetadataResponse"
+ }
+ }
+ }
},
"400": {
"description": "Invalid request.",
@@ -11376,28 +6771,16 @@
}
}
},
- "/api/rest/2.0/users/force-logout": {
+ "/api/rest/2.0/security/principals/fetch-permissions": {
"post": {
- "operationId": "forceLogoutUsers",
- "description": "\n Version: 9.0.0.cl or later\n\nEnforces logout on current user sessions. \n\nUse this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "operationId": "fetchPermissionsOfPrincipals",
+ "description": "\n Version: 9.0.0.cl or later\n\nFetches object permission details for a given principal object such as a user and group.\n\nRequires view access to the metadata object. \n\n#### Usage guidelines\n\n* To get a list of all metadata objects that a user or group can access, specify the `type` and GUID or name of the principal.\n* To get permission details for a specific object, add the `type` and GUID or name of the metadata object to your API request.\n\nUpon successful execution, the API returns a list of metadata objects and permission details for each object. \n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "9.0.0.cl"],
"requestBody": {
"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/FetchPermissionsOfPrincipalsRequest"
}
}
},
@@ -11405,8 +6788,51 @@
},
"parameters": [],
"responses": {
- "204": {
- "description": "Force logging out of users operation successful."
+ "200": {
+ "description": "Fetching permissions of principals is successful.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PermissionOfPrincipalsResponse"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "principal_permission_details": [
+ {
+ "principal_id": "7f5e7f87-09a1-487c-a1da-c4bb35e45270",
+ "principal_name": "test_user",
+ "principal_type": "USER",
+ "principal_sub_type": "LOCAL_USER",
+ "metadata_permission_info": [
+ {
+ "metadata_type": "LIVEBOARD",
+ "metadata_permissions": [
+ {
+ "metadata_id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "metadata_name": "Learn how to use ThoughtSpot",
+ "metadata_owner": {
+ "id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "name": "Learn how to use ThoughtSpot"
+ },
+ "metadata_author": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "tsadmin"
+ },
+ "permission": "READ_ONLY",
+ "shared_permission": "NO_ACCESS",
+ "group_permission": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
},
"400": {
"description": "Invalid request.",
@@ -11451,47 +6877,16 @@
}
}
},
- "/api/rest/2.0/users/import": {
+ "/api/rest/2.0/security/metadata/fetch-permissions": {
"post": {
- "operationId": "importUsers",
- "description": "\n Version: 9.0.0.cl or later\n\nImports user data from external databases into ThoughtSpot. During the user import operation:\n\n* If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional.\n* If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted.\n* If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "operationId": "fetchPermissionsOnMetadata",
+ "description": "\n Version: 9.0.0.cl or later\n\nFetches permission details for a given metadata object.\n\nRequires view access to the metadata object.\n\n#### Usage guidelines\n\n* To fetch a list of users and groups for a metadata object, specify `type` and GUID or name of the metadata object.\n* To get permission details for a specific user or group, add `type` and GUID or name of the principal object to your API request.\n\nUpon successful execution, the API returns permission details and principal information for the object specified in the API request.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "9.0.0.cl"],
"requestBody": {
"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/FetchPermissionsOnMetadataRequest"
}
}
},
@@ -11500,11 +6895,67 @@
"parameters": [],
"responses": {
"200": {
- "description": "Import users operation successful.",
+ "description": "Fetching permissions of metadata objects is successful.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportUsersResponse"
+ "$ref": "#/components/schemas/PermissionOfMetadataResponse"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "metadata_permission_details": [
+ {
+ "metadata_id": "a62a5bf3-9f16-45b2-a174-7d30b3b577a9",
+ "metadata_name": "testing",
+ "metadata_type": "LIVEBOARD",
+ "metadata_owner": {
+ "id": "a62a5bf3-9f16-45b2-a174-7d30b3b577a9",
+ "name": "testing"
+ },
+ "metadata_author": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "tsadmin"
+ },
+ "principal_permission_info": [
+ {
+ "principal_type": "USER_GROUP",
+ "principal_sub_type": "LOCAL_GROUP",
+ "principal_permissions": [
+ {
+ "principal_id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b",
+ "principal_name": "Administrator",
+ "permission": "MODIFY",
+ "shared_permission": "NO_ACCESS",
+ "group_permission": []
+ }
+ ]
+ },
+ {
+ "principal_type": "USER",
+ "principal_sub_type": "LOCAL_USER",
+ "principal_permissions": [
+ {
+ "principal_id": "0f0dd0f7-7411-4195-a4aa-0dc6b58413c9",
+ "principal_name": "su",
+ "permission": "MODIFY",
+ "shared_permission": "NO_ACCESS",
+ "group_permission": []
+ },
+ {
+ "principal_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "principal_name": "tsadmin",
+ "permission": "MODIFY",
+ "shared_permission": "NO_ACCESS",
+ "group_permission": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
}
}
}
@@ -11552,33 +7003,16 @@
}
}
},
- "/api/rest/2.0/users/reset-password": {
+ "/api/rest/2.0/security/metadata/manage-object-privilege": {
"post": {
- "operationId": "resetUserPassword",
- "description": "\n Version: 9.0.0.cl or later\n\nResets the password of a user account. Administrators can reset password on behalf of a user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "operationId": "manageObjectPrivilege",
+ "description": "\n Version: 26.3.0.cl or later\n\nThis API allows the addition or deletion of object level privileges for a set of users and groups, on a set of metadata objects. It provides users to access certain features based on privilege based access control.\n\n#### Usage guidelines\n\n- Specify the `operation`. The supported operations are: `ADD`, `REMOVE`.\n- Specify the type of the objects on which the object privileges are being provided in `metadata_type`. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future.\n- Specify the list of object privilege types in the `object_privilege_types` array. The supported object privilege types are: `SPOTTER_COACHING_PRIVILEGE`.\n- Specify the identifiers (either GUID or name) for the metadata objects in the `metadata_identifiers` array.\n- Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals to which you want to apply the given operation and given object privileges in the `principals` array.\n- Ensure using correct Authorization Bearer Token corresponding to specific user & org.\n\n#### Example request\n\n```json\n{\n \"operation\": \"operation-type\",\n \"metadata_type\": \"metadata-type\",\n \"object_privilege_types\": [\"privilege-type-1\", \"privilege-type-2\"],\n \"metadata_identifiers\": [\"metadata-guid-or-name-1\", \"metadata-guid-or-name-1\"],\n \"principals\": [\n {\n \"type\": \"type-1\", \n \"identifier\": \"principal-guid-or-name-1\"\n },\n {\n \"type\": \"type-2\",\n \"identifier\": \"principal-guid-or-name-2\"\n }\n ]\n}\n```\n\n> ###### Note:\n> * Only admin users, users with edit access and users with coaching privilege on a given data-model can add or remove principals related to SPOTTER_COACHING_PRIVILEGE \n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "26.3.0.cl"],
"requestBody": {
"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/ManageObjectPrivilegeRequest"
}
}
},
@@ -11587,10 +7021,10 @@
"parameters": [],
"responses": {
"204": {
- "description": "User password reset operation successful."
+ "description": "Object privileges added/removed successfully"
},
"400": {
- "description": "Invalid request.",
+ "description": "Invalid request",
"content": {
"application/json": {
"schema": {
@@ -11600,7 +7034,7 @@
}
},
"401": {
- "description": "Unauthorized access.",
+ "description": "Unauthorized access",
"content": {
"application/json": {
"schema": {
@@ -11610,7 +7044,7 @@
}
},
"403": {
- "description": "Forbidden access.",
+ "description": "Forbidden access",
"content": {
"application/json": {
"schema": {
@@ -11632,186 +7066,16 @@
}
}
},
- "/api/rest/2.0/users/search": {
+ "/api/rest/2.0/security/metadata/publish": {
"post": {
- "operationId": "searchUsers",
- "description": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n**NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available users, set `record_size` to `-1`.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "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",
+ "tags": ["Security", "10.9.0.cl"],
"requestBody": {
"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_SETUP_VERSION_CONTROL"
- ]
- }
- },
- "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
- }
- }
+ "$ref": "#/components/schemas/PublishMetadataRequest"
}
}
},
@@ -11819,18 +7083,8 @@
},
"parameters": [],
"responses": {
- "200": {
- "description": "User search result.",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
+ "204": {
+ "description": "Publishing metadata objects is successful."
},
"400": {
"description": "Invalid request.",
@@ -11875,174 +7129,25 @@
}
}
},
- "/api/rest/2.0/users/{user_identifier}/update": {
+ "/api/rest/2.0/security/metadata/share": {
"post": {
- "operationId": "updateUser",
- "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a user object.\n\nYou can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Users",
- "9.0.0.cl"
- ],
+ "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\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"],
"requestBody": {
"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.",
- "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"
- ]
- },
- "extended_properties": {
- "description": "Properties for the user",
- "type": "object"
- },
- "extended_preferences": {
- "description": "Preferences for the user",
- "type": "object"
- }
- }
+ "$ref": "#/components/schemas/ShareMetadataRequest"
}
}
},
"required": true
},
- "parameters": [
- {
- "in": "path",
- "name": "user_identifier",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "GUID / name of the user"
- }
- ],
+ "parameters": [],
"responses": {
"204": {
- "description": "User successfully updated."
+ "description": "Sharing metadata objects is successful."
},
"400": {
"description": "Invalid request.",
@@ -12087,51 +7192,16 @@
}
}
},
- "/api/rest/2.0/template/variables/create": {
+ "/api/rest/2.0/security/metadata/unpublish": {
"post": {
- "operationId": "createVariable",
- "description": "\nCreate a variable which can be used for parameterizing metadata objects
Beta Version: 10.9.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.\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\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 variable values (optional)\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* The variable values are invalid for the specified type \n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Variable",
- "10.9.0.cl"
- ],
+ "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",
+ "tags": ["Security", "10.9.0.cl"],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of variable",
- "type": "string",
- "enum": [
- "CONNECTION_PROPERTY",
- "TABLE_MAPPING",
- "CONNECTION_PROPERTY_PER_PRINCIPAL"
- ]
- },
- "name": {
- "description": "Name of the variable. This is unique across the cluster.",
- "type": "string"
- },
- "sensitive": {
- "description": "If the variable contains sensitive values like passwords",
- "default": false,
- "type": "boolean",
- "nullable": true
- },
- "values": {
- "description": "Values of variable",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/InputVariableValue"
- }
- }
- },
- "required": [
- "type",
- "name"
- ]
+ "$ref": "#/components/schemas/UnpublishMetadataRequest"
}
}
},
@@ -12139,15 +7209,8 @@
},
"parameters": [],
"responses": {
- "200": {
- "description": "Create variable is successful.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Variable"
- }
- }
- }
+ "204": {
+ "description": "Unpublishing metadata objects is successful."
},
"400": {
"description": "Invalid request.",
@@ -12192,31 +7255,28 @@
}
}
},
- "/api/rest/2.0/template/variables/{identifier}/delete": {
+ "/api/rest/2.0/security/column/rules/update": {
"post": {
- "operationId": "deleteVariable",
- "description": "\nDelete a variable
Beta Version: 10.9.0.cl or later\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT 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",
- "tags": [
- "Variable",
- "10.9.0.cl"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "identifier",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Unique id or name of the variable"
- }
- ],
+ "operationId": "updateColumnSecurityRules",
+ "description": "\nBeta Version: 10.12.0.cl or later\n\nCreates, updates, or deletes column security rules for specified tables.\n\nThis API endpoint allows you to create, update, or delete column-level security rules on columns of a table. The operation follows an \"all or none\" policy: if defining security rules for any of the provided columns fails, the entire operation will be rolled back, and no rules will be created.\n\n#### Usage guidelines\n\n- Provide table identifier using either `identifier` (GUID or name) or `obj_identifier` (object ID)\n- Use `clear_csr: true` to remove all column security rules from the table\n- For each column, specify the security rule using `column_security_rules` array\n- Use `is_unsecured: true` to mark a specific column as unprotected\n- Use `group_access` operations to manage group associations:\n - `ADD`: Add groups to the column's access list\n - `REMOVE`: Remove groups from the column's access list\n - `REPLACE`: Replace all existing groups with the specified groups\n\n#### Required permissions\n\n- `ADMINISTRATION` - Can administer ThoughtSpot\n- `DATAMANAGEMENT` - Can manage data (if RBAC is disabled)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables (if RBAC is enabled)\n\n#### Example request\n\n```json\n{\n \"identifier\": \"table-guid\",\n \"obj_identifier\": \"table-object-id\",\n \"clear_csr\": false,\n \"column_security_rules\": [\n {\n \"column_identifier\": \"col id or col name\",\n \"is_unsecured\": false,\n \"group_access\": [\n {\n \"operation\": \"ADD\",\n \"group_identifiers\": [\"hr_group_id\", \"hr_group_name\", \"finance_group_id\"]\n }\n ]\n },\n {\n \"column_identifier\": \"col id or col name\",\n \"is_unsecured\": true\n },\n {\n \"column_identifier\": \"col id or col name\",\n \"is_unsecured\": false,\n \"group_access\": [\n {\n \"operation\": \"REPLACE\",\n \"group_identifiers\": [\"management_group_id\", \"management_group_name\"]\n }\n ]\n }\n ]\n}\n```\n\n#### Request Body Schema\n\n- `identifier` (string, optional): GUID or name of the table for which we want to create column security rules\n- `obj_identifier` (string, optional): The object ID of the table\n- `clear_csr` (boolean, optional): If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed\n- `column_security_rules` (array of objects, required): An array where each object defines the security rule for a specific column\n\nEach column security rule object contains:\n- `column_identifier` (string, required): Column identifier (col_id or name)\n- `is_unsecured` (boolean, optional): If true, the column will be marked as unprotected and all groups associated with it will be removed\n- `group_access` (array of objects, optional): Array of group operation objects\n\nEach group operation object contains:\n- `operation` (string, required): Operation type - ADD, REMOVE, or REPLACE\n- `group_identifiers` (array of strings, required): Array of group identifiers (name or GUID) on which the operation will be performed\n\n#### Response\n\nThis API does not return any response body. A successful operation returns HTTP 200 status code.\n\n#### Operation Types\n\n- **ADD**: Adds the specified groups to the column's access list\n- **REMOVE**: Removes the specified groups from the column's access list \n- **REPLACE**: Replaces all existing groups with the specified groups \n\n\n\n#### Endpoint URL\n",
+ "tags": ["Security", "10.12.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateColumnSecurityRulesRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [],
"responses": {
"204": {
- "description": "Deleting the variable is successful."
+ "description": "Successfully updated column security rules"
},
"400": {
- "description": "Invalid request.",
+ "description": "Bad request - Invalid parameters or table not found",
"content": {
"application/json": {
"schema": {
@@ -12236,7 +7296,7 @@
}
},
"403": {
- "description": "Forbidden access.",
+ "description": "Forbidden - User doesn't have permission to modify security rules for this table",
"content": {
"application/json": {
"schema": {
@@ -12246,7 +7306,7 @@
}
},
"500": {
- "description": "Unexpected error",
+ "description": "Internal server error",
"content": {
"application/json": {
"schema": {
@@ -12258,50 +7318,16 @@
}
}
},
- "/api/rest/2.0/template/variables/search": {
+ "/api/rest/2.0/system/preferences/communication-channels/configure": {
"post": {
- "operationId": "searchVariables",
- "description": "\nSearch variables
Beta Version: 10.9.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\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_ONLY - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n* EDITABLE_METADATA_AND_VALUES - Returns only editable variable metadata and values\n\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Variable",
- "10.9.0.cl"
- ],
+ "operationId": "configureCommunicationChannelPreferences",
+ "description": "\nBeta Version: 10.14.0.cl or later\n\nConfigure communication channel preferences.\n- Use `cluster_preferences` to update the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to specify Org-specific preferences that override the defaults.\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 `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "10.14.0.cl"],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "type": "object",
- "properties": {
- "variable_details": {
- "description": "Variable details",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/VariableDetailInput"
- }
- },
- "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"
- },
- "output_format": {
- "description": "Format in which we want the output",
- "default": "METADATA_ONLY",
- "type": "string",
- "enum": [
- "METADATA_ONLY",
- "METADATA_AND_VALUES",
- "EDITABLE_METADATA_AND_VALUES"
- ]
- }
- }
+ "$ref": "#/components/schemas/ConfigureCommunicationChannelPreferencesRequest"
}
}
},
@@ -12309,18 +7335,8 @@
},
"parameters": [],
"responses": {
- "200": {
- "description": "List of variables is successful.",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Variable"
- }
- }
- }
- }
+ "204": {
+ "description": "Communication channel preferences successfully updated."
},
"400": {
"description": "Invalid request.",
@@ -12365,61 +7381,25 @@
}
}
},
- "/api/rest/2.0/template/variables/{identifier}/update": {
+ "/api/rest/2.0/system/security-settings/configure": {
"post": {
- "operationId": "updateVariable",
- "description": "\nUpdate a variable's properties
Beta Version: 10.9.0.cl or later\n\nAllows updating a variable's properties in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows updating:\n* The variable name\n* The variable values\n\nWhen updating variable values, you need to specify:\n* The operation to perform (ADD, REPLACE, REMOVE)\n* The new values to add/replace/remove\n\nWhen the operation is ADD, a value any pre-existing value with the same set of constraints will be replaced.\nWhen the operation is REPLACE, all values of the variable are replaced with the values specified.\nWhen the operation is REMOVE, all values with the given set of conditions are removed.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Variable",
- "10.9.0.cl"
- ],
+ "operationId": "configureSecuritySettings",
+ "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"],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "type": "object",
- "properties": {
- "name": {
- "description": "New name of the variable if we want to rename.",
- "type": "string"
- },
- "operation": {
- "description": "Operation to perform on the values.",
- "default": "REPLACE",
- "type": "string",
- "enum": [
- "ADD",
- "REMOVE",
- "REPLACE"
- ]
- },
- "values": {
- "description": "Values of variable to be updated.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/InputVariableValue"
- }
- }
- }
+ "$ref": "#/components/schemas/ConfigureSecuritySettingsRequest"
}
}
},
"required": true
},
- "parameters": [
- {
- "in": "path",
- "name": "identifier",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Unique id or name of the variable to update."
- }
- ],
+ "parameters": [],
"responses": {
"204": {
- "description": "Updating the variable is successful."
+ "description": "Successfully configured the security settings."
},
"400": {
"description": "Invalid request.",
@@ -12464,57 +7444,38 @@
}
}
},
- "/api/rest/2.0/template/variables/update": {
- "post": {
- "operationId": "updateVariableValues",
- "description": "\nUpdate values for multiple variables
Beta Version: 10.9.0.cl or later\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\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)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable. Any pre-existing values with the same conditions are replaced.\n* REPLACE - Replaces all values of a given org with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Variable",
- "10.9.0.cl"
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "variable_updates": {
- "description": "Variables and values",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/VariableValueInput"
- }
- },
- "operation": {
- "description": "Type of update operation",
- "type": "string",
- "enum": [
- "ADD",
- "REMOVE",
- "REPLACE"
- ]
- }
- },
- "required": [
- "variable_updates",
- "operation"
- ]
- }
- }
- },
- "required": true
- },
+ "/api/rest/2.0/system/config": {
+ "get": {
+ "operationId": "getSystemConfig",
+ "description": "\n Version: 9.0.0.cl or later\n\nRetrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster.\n\nRequires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required.\n\nThis API does not require any parameters to be passed in the request.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "9.0.0.cl"],
"parameters": [],
"responses": {
- "204": {
- "description": "Updating variable values is successful."
- },
- "400": {
- "description": "Invalid request.",
+ "200": {
+ "description": "Cluster config information.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ "$ref": "#/components/schemas/SystemConfig"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "onboarding_content_url": "",
+ "saml_enabled": false,
+ "okta_enabled": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
}
}
}
@@ -12552,59 +7513,48 @@
}
}
},
- "/api/rest/2.0/vcs/git/branches/commit": {
- "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",
- "tags": [
- "Version Control",
- "9.2.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"
- ]
- }
- }
- },
- "required": true
- },
+ "/api/rest/2.0/system": {
+ "get": {
+ "operationId": "getSystemInformation",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "9.0.0.cl"],
"parameters": [],
"responses": {
"200": {
- "description": "Successfully committed the metadata objects",
+ "description": "Cluster information.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CommitResponse"
+ "$ref": "#/components/schemas/SystemInfo"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "id": "local",
+ "name": "local",
+ "release_version": "test",
+ "time_zone": "America/Los_Angeles",
+ "locale": "",
+ "date_format": "MM/dd/yyyy",
+ "api_version": "v1",
+ "type": "SW",
+ "environment": "DEV",
+ "license": "EAE",
+ "date_time_format": "MM/dd/yyyy h:mm a",
+ "time_format": "HH:mm:ss",
+ "system_user_id": "67e15c06-d153-4924-a4cd-ff615393b60f",
+ "super_user_id": "0f0dd0f7-7411-4195-a4aa-0dc6b58413c9",
+ "hidden_object_id": "31745bb4-defd-4e8b-8de9-8fd01db78827",
+ "system_group_id": "179d8867-cf36-4a8d-a019-63a226fd3196",
+ "tsadmin_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "admin_group_id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b",
+ "all_tables_connection_id": "bfc6feb4-8dac-402c-8ae8-78b43d318777",
+ "all_user_group_id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "accept_language": "undefined",
+ "all_user_group_member_user_count": 13,
+ "logical_model_version": 43
+ }
+ }
}
}
}
@@ -12652,76 +7602,19 @@
}
}
},
- "/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_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\nYou can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository.\n\nBefore using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites:\n\n* You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\n\n* Your access token has `repo` scope that grants full access to public and private repositories.\n* Your Git repository has a branch that can be configured as a default branch in ThoughtSpot.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration).\n\n**Note**: ThoughtSpot supports only GitHub / GitHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Version Control",
- "9.2.0.cl"
- ],
- "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"
- ]
- }
- }
- },
- "required": true
- },
+ "/api/rest/2.0/system/config-overrides": {
+ "get": {
+ "operationId": "getSystemOverrideInfo",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets a list of configuration overrides applied on the cluster. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "9.2.0.cl"],
"parameters": [],
"responses": {
"200": {
- "description": "Successfully configured local repository",
+ "description": "Cluster configuration which can be overridden.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RepoConfigObject"
+ "$ref": "#/components/schemas/SystemOverrideInfo"
}
}
}
@@ -12769,26 +7662,16 @@
}
}
},
- "/api/rest/2.0/vcs/git/config/delete": {
+ "/api/rest/2.0/system/preferences/communication-channels/search": {
"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_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Version Control",
- "9.2.0.cl"
- ],
+ "operationId": "searchCommunicationChannelPreferences",
+ "description": "\nBeta Version: 10.14.0.cl or later\n\nFetch communication channel preferences.\n- Use `cluster_preferences` to fetch the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to fetch any Org-specific preferences that override the defaults.\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 `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "10.14.0.cl"],
"requestBody": {
"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/SearchCommunicationChannelPreferencesRequest"
}
}
},
@@ -12796,8 +7679,41 @@
},
"parameters": [],
"responses": {
- "204": {
- "description": "Successfully deleted local repository configuration"
+ "200": {
+ "description": "Communication channel preferences retrieved successfully.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CommunicationChannelPreferencesResponse"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "cluster_preferences": [
+ {
+ "event_type": "LIVEBOARD_SCHEDULE",
+ "channels": ["WEBHOOK"]
+ }
+ ],
+ "org_preferences": [
+ {
+ "org": {
+ "id": "583464508",
+ "name": "test_org"
+ },
+ "preferences": [
+ {
+ "event_type": "LIVEBOARD_SCHEDULE",
+ "channels": ["EMAIL"]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
},
"400": {
"description": "Invalid request.",
@@ -12842,51 +7758,16 @@
}
}
},
- "/api/rest/2.0/vcs/git/commits/deploy": {
+ "/api/rest/2.0/system/security-settings/search": {
"post": {
- "operationId": "deployCommit",
- "description": "\n Version: 9.2.0.cl or later\n\nAllows you to deploy a commit and publish TML content to your ThoughtSpot instance.\n\nRequires at least edit access to the objects used in the deploy operation.\n\nThe API deploys the head of the branch unless a `commit_id` is specified in the API request. If the branch name is not defined in the request, the default branch is considered for deploying commits.\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"
- ],
+ "operationId": "searchSecuritySettings",
+ "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"],
"requestBody": {
"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/SearchSecuritySettingsRequest"
}
}
},
@@ -12895,13 +7776,54 @@
"parameters": [],
"responses": {
"200": {
- "description": "Successfully deployed the changes",
+ "description": "Successfully retrieved the list of security settings.",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DeployResponse"
+ "$ref": "#/components/schemas/SecuritySettingsResponse"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "cluster_preferences": {
+ "enable_partitioned_cookies": false,
+ "cors_whitelisted_urls": ["example.com"],
+ "csp_settings": {
+ "connect_src_urls": ["https://connect.example.com"],
+ "font_src_urls": ["https://font.example.com"],
+ "visual_embed_hosts": ["https://embed.example.com"],
+ "iframe_src_urls": ["https://embed.example.com"],
+ "img_src_urls": ["https://img.example.com"],
+ "script_src_urls": {
+ "enabled": true,
+ "urls": ["https://script.example.com"]
+ },
+ "style_src_urls": ["https://style.example.com"]
+ },
+ "saml_redirect_urls": ["https://saml.example.com"],
+ "non_embed_access": {
+ "block_full_app_access": true
+ }
+ },
+ "org_preferences": [
+ {
+ "org": {
+ "id": 0,
+ "name": "Primary"
+ },
+ "cors_whitelisted_urls": ["https://cors.example.com"],
+ "non_embed_access": {
+ "block_full_app_access": true,
+ "groups_with_access": [
+ {
+ "id": "1234567890",
+ "name": "Group Name"
+ }
+ ]
+ }
+ }
+ ]
+ }
}
}
}
@@ -12950,67 +7872,25 @@
}
}
},
- "/api/rest/2.0/vcs/git/commits/{commit_id}/revert": {
+ "/api/rest/2.0/system/config-update": {
"post": {
- "operationId": "revertCommit",
- "description": "\n Version: 9.2.0.cl or later\n\nReverts TML objects to a previous commit specified in the API request.\n\nRequires at least edit access to objects.\n\nIn the API request, specify the `commit_id`. If the branch name is not specified in the request, the API will consider the default branch configured on your instance.\n\nBy default, the API reverts all objects. If the revert operation fails for one of the objects provided in the commit, the API returns an error and does not revert any object.\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"
- ],
+ "operationId": "updateSystemConfig",
+ "description": "\n Version: 9.2.0.cl or later\n\nUpdates the current configuration of the cluster. You must send the configuration data in JSON format.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "9.2.0.cl"],
"requestBody": {
"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/UpdateSystemConfigRequest"
}
}
},
"required": true
},
- "parameters": [
- {
- "in": "path",
- "name": "commit_id",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Commit id to which the object should be reverted"
- }
- ],
+ "parameters": [],
"responses": {
- "200": {
- "description": "Reverted the object to the commit point specified",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RevertResponse"
- }
- }
- }
+ "204": {
+ "description": "Configuration successfully updated."
},
"400": {
"description": "Invalid request.",
@@ -13055,52 +7935,16 @@
}
}
},
- "/api/rest/2.0/vcs/git/commits/search": {
+ "/api/rest/2.0/system/communication-channels/validate": {
"post": {
- "operationId": "searchCommits",
- "description": "\n Version: 9.2.0.cl or later\n\nGets a list of commits for a given metadata object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Version Control",
- "9.2.0.cl"
- ],
+ "operationId": "validateCommunicationChannel",
+ "description": "\nBeta Version: 26.4.0.cl or later\n\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["System", "26.4.0.cl"],
"requestBody": {
"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/ValidateCommunicationChannelRequest"
}
}
},
@@ -13109,14 +7953,11 @@
"parameters": [],
"responses": {
"200": {
- "description": "Commit history of the metadata object",
+ "description": "communication channel configuration validated successfully.",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CommitHistoryResponse"
- }
+ "$ref": "#/components/schemas/CommunicationChannelValidateResponse"
}
}
}
@@ -13164,28 +8005,16 @@
}
}
},
- "/api/rest/2.0/vcs/git/config/search": {
+ "/api/rest/2.0/tags/assign": {
"post": {
- "operationId": "searchConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nGets Git repository connections configured on the ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Version Control",
- "9.2.0.cl"
- ],
+ "operationId": "assignTag",
+ "description": "\n Version: 9.0.0.cl or later\n\nAssigns tags to Liveboards, Answers, Tables, and Worksheets.\n\nRequires edit access to the metadata object.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Tags", "9.0.0.cl"],
"requestBody": {
"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/AssignTagRequest"
}
}
},
@@ -13193,18 +8022,8 @@
},
"parameters": [],
"responses": {
- "200": {
- "description": "Details of local repository configuration",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RepoConfigObject"
- }
- }
- }
- }
+ "204": {
+ "description": "Tags successfully assigned."
},
"400": {
"description": "Invalid request.",
@@ -13249,53 +8068,16 @@
}
}
},
- "/api/rest/2.0/vcs/git/config/update": {
+ "/api/rest/2.0/tags/create": {
"post": {
- "operationId": "updateConfig",
- "description": "\n Version: 9.2.0.cl or later\n\nUpdates Git repository configuration settings.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_VERSION_CONTROL` (**Can toggle version control for objects**) privilege.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Version Control",
- "9.2.0.cl"
- ],
+ "operationId": "createTag",
+ "description": "\n Version: 9.0.0.cl or later\n\nCreates a tag object.\n\nTags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Tags", "9.0.0.cl"],
"requestBody": {
"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/CreateTagRequest"
}
}
},
@@ -13304,11 +8086,29 @@
"parameters": [],
"responses": {
"200": {
- "description": "Successfully updated local repository configuration",
+ "description": "Tag successfully created.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RepoConfigObject"
+ "$ref": "#/components/schemas/Tag"
+ },
+ "examples": {
+ "example_1": {
+ "value": {
+ "name": "test5",
+ "id": "6abf5aec-3485-4f83-b25f-8c55b92e2b20",
+ "color": "#342323",
+ "deleted": false,
+ "hidden": false,
+ "external": false,
+ "deprecated": false,
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1685441468684,
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "modifier_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "owner_id": "6abf5aec-3485-4f83-b25f-8c55b92e2b20"
+ }
+ }
}
}
}
@@ -13356,33 +8156,79 @@
}
}
},
- "/api/rest/2.0/vcs/git/branches/validate": {
+ "/api/rest/2.0/tags/{tag_identifier}/delete": {
"post": {
- "operationId": "validateMerge",
- "description": "\n Version: 9.2.0.cl or later\n\nValidates the content of your source branch against the objects in your destination environment.\n\nBefore merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "Version Control",
- "9.2.0.cl"
+ "operationId": "deleteTag",
+ "description": "\n Version: 9.0.0.cl or later\n\nDeletes a tag object from the ThoughtSpot system\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Tags", "9.0.0.cl"],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tag_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Tag identifier Tag name or Tag id."
+ }
],
+ "responses": {
+ "204": {
+ "description": "Tag successfully deleted."
+ },
+ "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/search": {
+ "post": {
+ "operationId": "searchTags",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets a list of tag objects available on the ThoughtSpot system. To get details of a specific tag object, specify the GUID or name.\n\nAny authenticated user can search for tag objects.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Tags", "9.0.0.cl"],
"requestBody": {
"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/SearchTagsRequest"
}
}
},
@@ -13391,13 +8237,47 @@
"parameters": [],
"responses": {
"200": {
- "description": "validation done successfully",
+ "description": "Tags search result.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DeployResponse"
+ "$ref": "#/components/schemas/Tag"
+ }
+ },
+ "examples": {
+ "example_1": {
+ "value": [
+ {
+ "name": "test4",
+ "id": "0935bbb5-17e2-43ab-b657-da6bf347cbb4",
+ "color": "#342323",
+ "deleted": false,
+ "hidden": false,
+ "external": false,
+ "deprecated": false,
+ "creation_time_in_millis": 1684937524885,
+ "modification_time_in_millis": 1684937524885,
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "modifier_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "owner_id": "0935bbb5-17e2-43ab-b657-da6bf347cbb4"
+ },
+ {
+ "name": "test6",
+ "id": "65a5c39a-daf5-4cae-975f-44283628494e",
+ "color": "#342323",
+ "deleted": false,
+ "hidden": false,
+ "external": false,
+ "deprecated": false,
+ "creation_time_in_millis": 1684988834183,
+ "modification_time_in_millis": 1684988887888,
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "modifier_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "owner_id": "65a5c39a-daf5-4cae-975f-44283628494e"
+ }
+ ]
}
}
}
@@ -13445,1464 +8325,4182 @@
}
}
}
- }
- },
- "components": {
- "schemas": {
- "ErrorResponse": {
- "type": "object",
- "properties": {
- "error": {
- "type": "object",
- "nullable": true
- }
- }
- },
- "GetTokenResponse": {
- "type": "object",
- "required": [
- "token",
- "creation_time_in_millis",
- "expiration_time_in_millis",
- "valid_for_user_id",
- "valid_for_username"
- ],
- "properties": {
- "token": {
- "type": "string",
- "description": "Bearer auth token."
+ },
+ "/api/rest/2.0/tags/unassign": {
+ "post": {
+ "operationId": "unassignTag",
+ "description": "\n Version: 9.0.0.cl or later\n\nRemoves the tags applied to a Liveboard, Answer, Table, or Worksheet.\n\nRequires edit access to the metadata object.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Tags", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnassignTagRequest"
+ }
+ }
},
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token creation time in milliseconds."
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "Tags successfully unassigned."
},
- "expiration_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token expiration time in milliseconds."
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "valid_for_user_id": {
- "type": "string",
- "description": "Username to whom the token is issued."
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "valid_for_username": {
- "type": "string",
- "description": "Unique identifier of the user to whom the token is issued."
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "RiseSetter": {
- "type": "object",
- "required": [
- "field",
- "path"
- ],
- "properties": {
- "field": {
- "type": "string"
+ }
+ },
+ "/api/rest/2.0/tags/{tag_identifier}/update": {
+ "post": {
+ "operationId": "updateTag",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates a tag object.\n\nYou can modify the `name` and `color` properties of a tag object. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Tags", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateTagRequest"
+ }
+ }
},
- "path": {
- "type": "string"
+ "required": true
+ },
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tag_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Name or Id of the tag."
}
- }
- },
- "User": {
- "type": "object",
- "required": [
- "id",
- "name",
- "display_name",
- "visibility"
],
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of the user."
+ "responses": {
+ "204": {
+ "description": "Tag successfully updated."
},
- "name": {
- "type": "string",
- "description": "Name of the user."
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "display_name": {
- "type": "string",
- "description": "Display name of the user."
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "visibility": {
- "type": "string",
- "enum": [
- "SHARABLE",
- "NON_SHARABLE"
- ],
- "description": "Visibility of the users. The `SHARABLE` property makes a user visible to other users and group, who can share objects with the user."
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "author_id": {
- "type": "string",
- "description": "Unique identifier of author of the user.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/activate": {
+ "post": {
+ "operationId": "activateUser",
+ "description": "\n Version: 9.7.0.cl or later\n\nActivates a deactivated user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo activate an inactive user account, the API request body must include the following information:\n\n- Username or the GUID of the user account.\n- Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated.\n- Password for the user account.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.7.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActivateUserRequest"
+ }
+ }
},
- "can_change_password": {
- "type": "boolean",
- "description": "Defines whether the user can change their password.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "User activated successfully.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
},
- "complete_detail": {
- "type": "boolean",
- "description": "Defines whether the response has complete detail of the user.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Creation time of the user in milliseconds.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "current_org": {
- "$ref": "#/components/schemas/Org",
- "description": "Current logged-in Org of the user.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "deleted": {
- "type": "boolean",
- "description": "Indicates whether the user is deleted.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/change-password": {
+ "post": {
+ "operationId": "changeUserPassword",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates the current password of the user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ChangeUserPasswordRequest"
+ }
+ }
},
- "deprecated": {
- "type": "boolean",
- "description": "Indicates whether the user is deprecated.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "User password change operation successful."
},
- "account_type": {
- "type": "string",
- "enum": [
- "LOCAL_USER",
- "LDAP_USER",
- "SAML_USER",
- "OIDC_USER",
- "REMOTE_USER"
- ],
- "description": "Type of the user account.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "account_status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "INACTIVE",
- "EXPIRED",
- "LOCKED",
- "PENDING",
- "SUSPENDED"
- ],
- "description": "Status of the user account.",
- "nullable": true
- },
- "email": {
- "type": "string",
- "description": "Email of the user.",
- "nullable": true
- },
- "expiration_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Expiration time of the user in milliseconds.",
- "nullable": true
- },
- "external": {
- "type": "boolean",
- "description": "Indicates whether the user is external.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "favorite_metadata": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FavoriteMetadataItem"
- },
- "description": "Metadata objects to add to the users' favorites list.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "first_login_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Timestamp of the first login session of the user in milliseconds.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/create": {
+ "post": {
+ "operationId": "createUser",
+ "description": "\n Version: 9.0.0.cl or later\n\nCreates a user in ThoughtSpot.\n\nThe API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserRequest"
+ }
+ }
},
- "group_mask": {
- "type": "integer",
- "format": "int32",
- "description": "Group mask of the user.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "User successfully created.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
},
- "hidden": {
- "type": "boolean",
- "description": "Indicates whether the user is hidden.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "home_liveboard": {
- "$ref": "#/components/schemas/Object_ID_And_Name",
- "description": "Unique ID or name of the default Liveboard assigned to the user.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "incomplete_details": {
- "type": "object",
- "description": "Incomplete details of user if any present.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "is_first_login": {
- "type": "boolean",
- "description": "Indicates whether it is first login of the user.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/deactivate": {
+ "post": {
+ "operationId": "deactivateUser",
+ "description": "\n Version: 9.7.0.cl or later\n\nDeactivates a user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo deactivate a user account, the API request body must include the following information:\n\n- Username or the GUID of the user account\n- Base URL of the ThoughtSpot instance\n\nIf the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.7.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeactivateUserRequest"
+ }
+ }
},
- "modification_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Last modified time of the user in milliseconds.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "User deactivated successfully.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResponseActivationURL"
+ }
+ }
+ }
},
- "modifier_id": {
- "type": "string",
- "description": "Unique identifier of modifier of the user.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "notify_on_share": {
- "type": "boolean",
- "description": "User preference for receiving email notifications on shared Answers or Liveboard.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "onboarding_experience_completed": {
- "type": "boolean",
- "description": "The user preference for turning off the onboarding experience.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "orgs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Org"
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/{user_identifier}/delete": {
+ "post": {
+ "operationId": "deleteUser",
+ "description": "\n Version: 9.0.0.cl or later\n\nDeletes a user from the ThoughtSpot system.\n\nIf you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "user_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
},
- "description": "Orgs to which the user belongs.",
- "nullable": true
- },
- "owner_id": {
- "type": "string",
- "description": "Unique identifier of owner of the user.",
- "nullable": true
+ "description": "GUID / name of the user"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "User successfully deleted."
},
- "parent_type": {
- "type": "string",
- "enum": [
- "USER",
- "GROUP"
- ],
- "description": "Parent type of the user.",
- "nullable": true
- },
- "privileges": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Privileges which are assigned to the user.",
- "nullable": true
- },
- "show_onboarding_experience": {
- "type": "boolean",
- "description": "User's preference to revisit the new user onboarding experience.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "super_user": {
- "type": "boolean",
- "description": "Indicates whether the user is a super user.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "system_user": {
- "type": "boolean",
- "description": "Indicates whether the user is a system user.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "tags": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Object_ID_And_Name"
- },
- "description": "Tags associated with the user.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/force-logout": {
+ "post": {
+ "operationId": "forceLogoutUsers",
+ "description": "\n Version: 9.0.0.cl or later\n\nEnforces logout on current user sessions. \n\nUse this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ForceLogoutUsersRequest"
+ }
+ }
},
- "tenant_id": {
- "type": "string",
- "description": "Unique identifier of tenant of the user.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "Force logging out of users operation successful."
},
- "user_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Object_ID_And_Name"
- },
- "description": "Groups to which the user is assigned.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "user_inherited_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Object_ID_And_Name"
- },
- "description": "Inherited User Groups which the user is part of.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "welcome_email_sent": {
- "type": "boolean",
- "description": "Indicates whether welcome email is sent for the user.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "org_privileges": {
- "type": "object",
- "description": "Privileges which are assigned to the user with org.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/import": {
+ "post": {
+ "operationId": "importUsers",
+ "description": "\n Version: 9.0.0.cl or later\n\nImports user data from external databases into ThoughtSpot. During the user import operation:\n\n* If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional.\n* If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted.\n* If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ImportUsersRequest"
+ }
+ }
},
- "preferred_locale": {
- "type": "string",
- "description": "Locale for the user.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Import users operation successful.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ImportUsersResponse"
+ }
+ }
+ }
},
- "extended_properties": {
- "type": "object",
- "description": "Properties for the user",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "extended_preferences": {
- "type": "object",
- "description": "Preferences for the user",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "user_parameters": {
- "type": "object",
- "description": "User Parameters which are specified for the user via JWToken",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "access_control_properties": {
- "type": "object",
- "description": "Access Control Properties which are specified for the user via JWToken",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "Org": {
- "type": "object",
- "required": [
- "id",
- "name"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32",
- "description": "The ID of the object."
+ }
+ },
+ "/api/rest/2.0/users/reset-password": {
+ "post": {
+ "operationId": "resetUserPassword",
+ "description": "\n Version: 9.0.0.cl or later\n\nResets the password of a user account. Administrators can reset password on behalf of a user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResetUserPasswordRequest"
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "Name of the object."
- }
+ "required": true
},
- "description": "The current Org context of the user."
- },
- "FavoriteMetadataItem": {
- "type": "object",
- "required": [
- "id",
- "name",
- "type"
- ],
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique ID of the metadata object."
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "User password reset operation successful."
},
- "name": {
- "type": "string",
- "description": "name of the metadata object."
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION",
- "TAG",
- "USER",
- "USER_GROUP",
- "LOGICAL_RELATIONSHIP"
- ],
- "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier."
- }
- }
- },
- "Object_ID_And_Name": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique identifier of the object.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "Name of the object.",
- "nullable": true
- }
- },
- "description": "The object representation with ID and Name."
- },
- "FavoriteMetadataInput": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata object.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER"
- ],
- "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "SortOptions": {
- "type": "object",
- "properties": {
- "field_name": {
- "type": "string",
- "enum": [
- "NAME",
- "DISPLAY_NAME",
- "AUTHOR",
- "CREATED",
- "MODIFIED"
- ],
- "description": "Name of the field to apply the sort on.",
- "nullable": true
+ }
+ },
+ "/api/rest/2.0/users/search": {
+ "post": {
+ "operationId": "searchUsers",
+ "description": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n**NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available users, set `record_size` to `-1`.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SearchUsersRequest"
+ }
+ }
},
- "order": {
- "type": "string",
- "enum": [
- "ASC",
- "DESC"
- ],
- "description": "Sort order : ASC(Ascending) or DESC(Descending).",
- "nullable": true
- }
+ "required": true
},
- "description": "Sort options."
- },
- "SystemInfo": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique identifier of the object",
- "nullable": true
- },
- "name": {
- "type": "string",
- "description": "Name of the cluster.",
- "nullable": true
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "User search result.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
+ }
},
- "release_version": {
- "type": "string",
- "description": "The release version of the cluster.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "time_zone": {
- "type": "string",
- "description": "The timezone of the cluster.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "locale": {
- "type": "string",
- "description": "The default locale of the cluster.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "date_format": {
- "type": "string",
- "description": "The default date format representation of the cluster.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/users/{user_identifier}/update": {
+ "post": {
+ "operationId": "updateUser",
+ "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a user object.\n\nYou can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Users", "9.0.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateUserRequest"
+ }
+ }
},
- "api_version": {
- "type": "string",
- "description": "The API version of the cluster.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [
+ {
+ "in": "path",
+ "name": "user_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "GUID / name of the user"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "User successfully updated."
},
- "type": {
- "type": "string",
- "description": "The deployment type of the cluster.",
- "nullable": true
- },
- "environment": {
- "type": "string",
- "description": "The deployed environment of the cluster.",
- "nullable": true
- },
- "license": {
- "type": "string",
- "description": "The license applied to the cluster.",
- "nullable": true
- },
- "date_time_format": {
- "type": "string",
- "description": "The default date time format representation of the cluster.",
- "nullable": true
- },
- "time_format": {
- "type": "string",
- "description": "The default time format representation of the cluster.",
- "nullable": true
- },
- "system_user_id": {
- "type": "string",
- "description": "The unique identifier of system user.",
- "nullable": true
- },
- "super_user_id": {
- "type": "string",
- "description": "The unique identifier of super user.",
- "nullable": true
- },
- "hidden_object_id": {
- "type": "string",
- "description": "The unique identifier of hidden object.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "system_group_id": {
- "type": "string",
- "description": "The unique identifier of system group.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "tsadmin_user_id": {
- "type": "string",
- "description": "The unique identifier of tsadmin user.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "admin_group_id": {
- "type": "string",
- "description": "The unique identifier of admin group.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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",
+ "tags": ["Variable", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateVariableRequest"
+ }
+ }
},
- "all_tables_connection_id": {
- "type": "string",
- "description": "The unique identifier of all tables connection.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Create variable is successful.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Variable"
+ }
+ }
+ }
},
- "all_user_group_id": {
- "type": "string",
- "description": "The unique identifier of ALL group.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "accept_language": {
- "type": "string",
- "description": "The supported accept language by the cluster.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "all_user_group_member_user_count": {
- "type": "integer",
- "format": "int32",
- "description": "The count of users of ALL group.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "logical_model_version": {
- "type": "integer",
- "format": "int32",
- "description": "The version number of logical model of the cluster.",
- "nullable": true
- }
- }
- },
- "SystemConfig": {
- "type": "object",
- "properties": {
- "onboarding_content_url": {
- "type": "string",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "SystemOverrideInfo": {
- "type": "object",
- "properties": {
- "config_override_info": {
- "type": "object",
- "nullable": true
+ }
+ },
+ "/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",
+ "tags": ["Variable", "10.14.0.cl"],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Unique id or name of the variable"
}
- }
- },
- "OrgResponse": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32",
- "description": "Unique identifier of the Org.",
- "nullable": true
+ ],
+ "responses": {
+ "204": {
+ "description": "Deleting the variable is successful."
},
- "name": {
- "type": "string",
- "description": "Name of the Org.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "IN_ACTIVE"
- ],
- "description": "Status of the Org.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "description": {
- "type": "string",
- "description": "Description of the Org.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "visibility": {
- "type": "string",
- "enum": [
- "SHOW",
- "HIDDEN"
- ],
- "description": "Visibility of the Org.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "Tag": {
- "type": "object",
- "required": [
- "name",
- "id"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "id": {
- "type": "string"
+ }
+ },
+ "/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",
+ "tags": ["Variable", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SearchVariablesRequest"
+ }
+ }
},
- "color": {
- "type": "string",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "List of variables is successful.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Variable"
+ }
+ }
+ }
+ }
},
- "deleted": {
- "type": "boolean",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "hidden": {
- "type": "boolean",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "external": {
- "type": "boolean",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "deprecated": {
- "type": "boolean",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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",
+ "tags": ["Variable", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateVariableRequest"
+ }
+ }
},
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "nullable": true
+ "required": true
+ },
+ "parameters": [
+ {
+ "in": "path",
+ "name": "identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Unique id or name of the variable to update."
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Variable name updated successfully."
},
- "modification_time_in_millis": {
- "type": "number",
- "format": "float",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "author_id": {
- "type": "string",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "modifier_id": {
- "type": "string",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "owner_id": {
- "type": "string",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "UserGroupResponse": {
- "type": "object",
- "required": [
- "display_name",
- "id",
- "name",
- "visibility"
- ],
- "properties": {
- "author_id": {
- "type": "string",
- "description": "The unique identifier of the object",
- "nullable": true
- },
- "complete_detail": {
- "type": "boolean",
- "description": "Indicates whether the response has complete detail of the group.",
- "nullable": true
- },
+ }
+ },
+ "/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",
+ "tags": ["Variable", "10.14.0.cl"],
+ "requestBody": {
"content": {
- "type": "object",
- "description": "Content details of the group",
- "nullable": true
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateVariableValuesRequest"
+ }
+ }
},
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Creation time of the group in milliseconds",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "Variable values updated successfully."
},
- "default_liveboards": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "Liveboards that are assigned as default Liveboards to the group.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "deleted": {
- "type": "boolean",
- "description": "Indicates whether the group is deleted",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "deprecated": {
- "type": "boolean",
- "description": "Indicates whether the group is deprecated",
- "nullable": true
- },
- "description": {
- "type": "string",
- "description": "Description of the group",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "display_name": {
- "type": "string",
- "description": "Display name of the group."
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/vcs/git/branches/commit": {
+ "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",
+ "tags": ["Version Control", "9.2.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CommitBranchRequest"
+ }
+ }
},
- "external": {
- "type": "boolean",
- "description": "Indicates whether the group is external",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Successfully committed the metadata objects",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CommitResponse"
+ }
+ }
+ }
},
- "generation_number": {
- "type": "integer",
- "format": "int32",
- "description": "Generation number of the group",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "hidden": {
- "type": "boolean",
- "description": "Indicates whether the group is hidden",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "id": {
- "type": "string",
- "description": "The unique identifier of the object"
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "index": {
- "type": "integer",
- "format": "int32",
- "description": "Index number of the group",
- "nullable": true
+ "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"
+ }
+ }
},
- "index_version": {
- "type": "integer",
- "format": "int32",
- "description": "Index version number of the group",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Successfully configured local repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RepoConfigObject"
+ }
+ }
+ }
},
- "metadata_version": {
- "type": "integer",
- "format": "int32",
- "description": "Metadata version number of the group",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "modification_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Last modified time of the group in milliseconds.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "modifier_id": {
- "type": "string",
- "description": "The unique identifier of the object",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "Name of the group."
+ "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"
+ }
+ }
},
- "orgs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "Orgs in which group exists.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "Successfully deleted local repository configuration"
},
- "owner_id": {
- "type": "string",
- "description": "The unique identifier of the object",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "parent_type": {
- "type": "string",
- "enum": [
- "USER",
- "GROUP"
- ],
- "description": "Parent type of the group.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "privileges": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Privileges which are assigned to the group",
- "nullable": true
- },
- "sub_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "Groups who are part of the group",
- "nullable": true
- },
- "system_group": {
- "type": "boolean",
- "description": "Indicates whether the group is a system group.",
- "nullable": true
- },
- "tags": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "Tags associated with the group.",
- "nullable": true
- },
- "type": {
- "type": "string",
- "enum": [
- "LOCAL_GROUP",
- "LDAP_GROUP"
- ],
- "description": "Type of the group.",
- "nullable": true
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "Users who are part of the group.",
- "nullable": true
- },
- "visibility": {
- "type": "string",
- "enum": [
- "SHARABLE",
- "NON_SHARABLE"
- ],
- "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects."
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Role"
- },
- "description": "List of roles assgined to the user",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "Role": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "id of the role",
- "nullable": true
+ }
+ },
+ "/api/rest/2.0/vcs/git/commits/deploy": {
+ "post": {
+ "operationId": "deployCommit",
+ "description": "\n Version: 9.2.0.cl or later\n\nAllows you to deploy a commit and publish TML content to your ThoughtSpot instance.\n\nRequires at least edit access to the objects used in the deploy operation.\n\nThe API deploys the head of the branch unless a `commit_id` is specified in the API request. If the branch name is not defined in the request, the default branch is considered for deploying commits.\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"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeployCommitRequest"
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "name of the role",
- "nullable": true
- }
- }
- },
- "MetadataListItemInput": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Successfully deployed the changes",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DeployResponse"
+ }
+ }
+ }
+ }
},
- "obj_identifier": {
- "type": "string",
- "description": "CustomObjectId of the metadata.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "name_pattern": {
- "type": "string",
- "description": "A pattern to match the case-insensitive name of the metadata object. User % for a wildcard match.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION",
- "TAG",
- "USER",
- "USER_GROUP",
- "LOGICAL_RELATIONSHIP",
- "INSIGHT_SPEC"
- ],
- "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view.\n5. CONNECTION for creating or modify data connections.\n6. TAG for tag objects.\n7. USER for user objects.\n8. USER_GROUP for group objects.\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values\n10. INSIGHT_SPEC for SpotIQ objects",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "subtypes": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "ONE_TO_ONE_LOGICAL",
- "WORKSHEET",
- "PRIVATE_WORKSHEET",
- "USER_DEFINED",
- "AGGR_WORKSHEET",
- "SQL_VIEW"
- ]
- },
- "description": "List of subtype of metadata. Applies for LOGICAL_TABLE type with the following valid values.\n1. ONE_TO_ONE_LOGICAL\n2. WORKSHEET\n3. PRIVATE_WORKSHEET.\n4. USER_DEFINED.\n5. AGGR_WORKSHEET.\n6. SQL_VIEW
Version: 10.11.0.cl or later",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "PermissionInput": {
- "type": "object",
- "required": [
- "principal",
- "share_mode"
- ],
- "properties": {
- "principal": {
- "$ref": "#/components/schemas/PrincipalsInput",
- "description": "Details of users or groups."
+ }
+ },
+ "/api/rest/2.0/vcs/git/commits/{commit_id}/revert": {
+ "post": {
+ "operationId": "revertCommit",
+ "description": "\n Version: 9.2.0.cl or later\n\nReverts TML objects to a previous commit specified in the API request.\n\nRequires at least edit access to objects.\n\nIn the API request, specify the `commit_id`. If the branch name is not specified in the request, the API will consider the default branch configured on your instance.\n\nBy default, the API reverts all objects. If the revert operation fails for one of the objects provided in the commit, the API returns an error and does not revert any object.\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"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RevertCommitRequest"
+ }
+ }
},
- "share_mode": {
- "type": "string",
- "enum": [
- "READ_ONLY",
- "MODIFY",
- "NO_ACCESS"
- ],
- "description": "Object share mode."
- }
+ "required": true
},
- "description": "Details of users or groups."
- },
- "ExcludeMetadataListItemInput": {
- "type": "object",
- "required": [
- "identifier",
- "type"
+ "parameters": [
+ {
+ "in": "path",
+ "name": "commit_id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Commit id to which the object should be reverted"
+ }
],
- "properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata."
+ "responses": {
+ "200": {
+ "description": "Reverted the object to the commit point specified",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RevertResponse"
+ }
+ }
+ }
},
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION",
- "TAG",
- "USER",
- "USER_GROUP",
- "LOGICAL_RELATIONSHIP",
- "INSIGHT_SPEC"
- ],
- "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view\n5. CONNECTION for connection objects\n6. TAG for tag objects\n7. USER for user objects\n8. USER_GROUP for group objects\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values.\n10. INSIGHT_SPEC for SpotIQ objects"
- }
- }
- },
- "FavoriteObjectOptionsInput": {
- "type": "object",
- "properties": {
- "include": {
- "type": "boolean",
- "default": false,
- "description": "Includes objects marked as favorite for the specified users.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "user_identifiers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Unique ID or name of the users. If not specified, the favorite objects of current logged in user are returned.",
- "nullable": true
- }
- },
- "description": "Favorite object options."
- },
- "MetadataSearchSortOptions": {
- "type": "object",
- "properties": {
- "field_name": {
- "type": "string",
- "enum": [
- "NAME",
- "DISPLAY_NAME",
- "AUTHOR",
- "CREATED",
- "MODIFIED",
- "VIEWS",
- "FAVORITES",
- "LAST_ACCESSED"
- ],
- "description": "Name of the field to apply the sort on.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "order": {
- "type": "string",
- "enum": [
- "ASC",
- "DESC"
- ],
- "description": "Sort order : ASC(Ascending) or DESC(Descending).",
- "nullable": true
+ "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/commits/search": {
+ "post": {
+ "operationId": "searchCommits",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets a list of commits for a given metadata object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Version Control", "9.2.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SearchCommitsRequest"
+ }
+ }
+ },
+ "required": true
},
- "description": "Sort options."
- },
- "MetadataSearchResponse": {
- "type": "object",
- "required": [
- "metadata_type"
- ],
- "properties": {
- "metadata_id": {
- "type": "string",
- "description": "Unique identifier of the metadata.",
- "nullable": true
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Commit history of the metadata object",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CommitHistoryResponse"
+ }
+ }
+ }
+ }
},
- "metadata_name": {
- "type": "string",
- "description": "Name of the metadata.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "metadata_type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION",
- "TAG",
- "USER",
- "USER_GROUP",
- "LOGICAL_RELATIONSHIP",
- "INSIGHT_SPEC"
- ],
- "description": "Type of the metadata."
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "metadata_obj_id": {
- "type": "string",
- "description": "Custom identifier of the metadata.\n(Available from 10.8.0.cl onwards)",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "dependent_objects": {
- "type": "object",
- "description": "Details of dependent objects of the metadata objects.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/vcs/git/config/search": {
+ "post": {
+ "operationId": "searchConfig",
+ "description": "\n Version: 9.2.0.cl or later\n\nGets Git repository connections configured on the ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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/SearchConfigRequest"
+ }
+ }
},
- "incomplete_objects": {
- "type": "array",
- "items": {
- "type": "object"
- },
- "description": "Details of incomplete information of the metadata objects if any.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Details of local repository configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RepoConfigObject"
+ }
+ }
+ }
+ }
},
- "metadata_detail": {
- "type": "object",
- "description": "Complete details of the metadata objects.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "metadata_header": {
- "type": "object",
- "description": "Header information of the metadata objects.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "visualization_headers": {
- "type": "array",
- "items": {
- "type": "object"
- },
- "description": "Visualization header information of the metadata objects.",
- "nullable": true
- },
- "stats": {
- "type": "object",
- "description": "Stats of the metadata object. Includes views, favorites, last_accessed.",
- "nullable": true
- }
- },
- "description": "Metadata Search Response Object."
- },
- "GetAsyncImportStatusResponse": {
- "type": "object",
- "properties": {
- "status_list": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ImportEPackAsyncTaskStatus"
- },
- "description": "List of task statuses.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "last_batch": {
- "type": "boolean",
- "description": "Indicates whether there are more task statuses to fetch.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "ImportEPackAsyncTaskStatus": {
- "type": "object",
- "properties": {
- "tenant_id": {
- "type": "string",
- "description": "GUID of tenant from which the task is initiated.",
- "nullable": true
- },
- "org_id": {
- "type": "integer",
- "format": "int32",
- "description": "Organisation ID of the user who initiated the task.",
- "nullable": true
+ }
+ },
+ "/api/rest/2.0/vcs/git/config/update": {
+ "post": {
+ "operationId": "updateConfig",
+ "description": "\n Version: 9.2.0.cl or later\n\nUpdates Git repository configuration settings.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\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/UpdateConfigRequest"
+ }
+ }
},
- "task_id": {
- "type": "string",
- "description": "Unique identifier for the task.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Successfully updated local repository configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RepoConfigObject"
+ }
+ }
+ }
},
- "task_name": {
- "type": "string",
- "description": "Name of the task.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "import_response": {
- "type": "object",
- "description": "Response of imported objects so far.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "task_status": {
- "type": "string",
- "enum": [
- "COMPLETED",
- "IN_QUEUE",
- "IN_PROGRESS",
- "FAILED"
- ],
- "description": "Current status of the task.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "author_id": {
- "type": "string",
- "description": "ID of the user who initiated the task.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/vcs/git/branches/validate": {
+ "post": {
+ "operationId": "validateMerge",
+ "description": "\n Version: 9.2.0.cl or later\n\nValidates the content of your source branch against the objects in your destination environment.\n\nBefore merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n",
+ "tags": ["Version Control", "9.2.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidateMergeRequest"
+ }
+ }
},
- "import_policy": {
- "type": "string",
- "enum": [
- "PARTIAL",
- "ALL_OR_NONE",
- "VALIDATE_ONLY",
- "PARTIAL_OBJECT"
- ],
- "description": "Policy used for the import task.",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "validation done successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DeployResponse"
+ }
+ }
+ }
+ }
},
- "created_at": {
- "type": "number",
- "format": "float",
- "description": "Time when the task was created (in ms since epoch).",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "in_progress_at": {
- "type": "number",
- "format": "float",
- "description": "Time when the task started (in ms since epoch).",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "completed_at": {
- "type": "number",
- "format": "float",
- "description": "Time when the task was completed (in ms since epoch).",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "total_object_count": {
- "type": "integer",
- "format": "int32",
- "description": "Total number of objects to process.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/webhooks/create": {
+ "post": {
+ "operationId": "createWebhookConfiguration",
+ "description": "\nBeta Version: 10.14.0.cl or later\n\nCreates a new webhook configuration to receive notifications for specified events. The webhook will be triggered when the configured events occur in the system.\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", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateWebhookConfigurationRequest"
+ }
+ }
},
- "object_processed_count": {
- "type": "integer",
- "format": "int32",
- "description": "Number of objects processed so far.",
- "nullable": true
- },
- "modified_at": {
- "type": "number",
- "format": "float",
- "description": "Last time the task status was updated (in ms since epoch).",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Webhook configuration created successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WebhookResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Basic webhook with Bearer token authentication",
+ "value": {
+ "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+ "name": "My Liveboard Webhook",
+ "description": "Webhook to notify external system about liveboard schedules",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://myapp.example.com/webhooks/thoughtspot",
+ "url_params": {
+ "api_key": "abc123",
+ "version": "v1"
+ },
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "BEARER_TOKEN": "***"
+ },
+ "signature_verification": {
+ "type": "HMAC_SHA256",
+ "header": "X-Webhook-Signature",
+ "algorithm": "SHA256",
+ "secret": "***"
+ },
+ "creation_time_in_millis": 1724277430243,
+ "modification_time_in_millis": 1724277430243,
+ "created_by": {
+ "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b",
+ "name": "sarah_chen"
+ },
+ "last_modified_by": {
+ "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b",
+ "name": "sarah_chen"
+ }
+ }
+ },
+ "example_2": {
+ "description": "Webhook with OAuth2 authentication",
+ "value": {
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "name": "OAuth2 Webhook",
+ "description": "Webhook with OAuth2 client credentials",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://api.example.com/webhooks",
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "OAUTH2": {
+ "authorization_url": "https://auth.example.com/oauth2/authorize",
+ "client_id": "client_123",
+ "client_secret": "***"
+ }
+ },
+ "creation_time_in_millis": 1724278530123,
+ "modification_time_in_millis": 1724278530123,
+ "created_by": {
+ "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d",
+ "name": "mike_rodriguez"
+ }
+ }
+ }
+ }
+ }
+ }
},
- "author_display_name": {
- "type": "string",
- "description": "Display name of the user who initiated the task.",
- "nullable": true
- }
- }
- },
- "SqlQueryResponse": {
- "type": "object",
- "required": [
- "metadata_id",
- "metadata_name",
- "metadata_type",
- "sql_queries"
- ],
- "properties": {
- "metadata_id": {
- "type": "string",
- "description": "Unique identifier of the metadata."
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "metadata_name": {
- "type": "string",
- "description": "Name of the metadata."
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "metadata_type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION",
- "TAG",
- "USER",
- "USER_GROUP",
- "LOGICAL_RELATIONSHIP"
- ],
- "description": "Type of the metadata."
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "sql_queries": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SqlQuery"
- },
- "description": "SQL query details of metadata objects."
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
}
}
- },
- "SqlQuery": {
- "type": "object",
- "required": [
- "metadata_id",
- "metadata_name",
- "sql_query"
- ],
- "properties": {
- "metadata_id": {
- "type": "string",
- "description": "Unique identifier of the metadata."
- },
- "metadata_name": {
- "type": "string",
- "description": "Name of the metadata."
+ }
+ },
+ "/api/rest/2.0/webhooks/delete": {
+ "post": {
+ "operationId": "deleteWebhookConfigurations",
+ "description": "\nBeta Version: 10.14.0.cl or later\n\nDeletes one or more webhook configurations by their unique id or name. Returns status of each deletion operation, including successfully deleted webhooks and any failures with error details.\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", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteWebhookConfigurationsRequest"
+ }
+ }
},
- "sql_query": {
- "type": "string",
- "description": "SQL query of a metadata object."
- }
+ "required": true
},
- "description": "Response format associated with fetch SQL query api"
- },
- "PdfOptionsInput": {
- "type": "object",
- "properties": {
- "include_cover_page": {
- "type": "boolean",
- "default": true,
- "description": "Indicates whether to include the cover page with the Liveboard title.",
- "nullable": true
- },
- "include_custom_logo": {
- "type": "boolean",
- "default": true,
- "description": "Indicates whether to include customized wide logo in the footer if available.",
- "nullable": true
- },
- "include_filter_page": {
- "type": "boolean",
- "default": true,
- "description": "Indicates whether to include a page with all applied filters.",
- "nullable": true
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Webhook configurations deleted successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WebhookDeleteResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Successful deletion of multiple webhooks",
+ "value": {
+ "deleted_count": 2,
+ "failed_count": 0,
+ "deleted_webhooks": [
+ {
+ "id": "b9e3d8f2-4c7a-4e1b-8d3c-5f9a2b7e4c6d",
+ "name": "Old Webhook 1",
+ "description": "First webhook to be deleted",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://old-service.example.com/webhook1",
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "BEARER_TOKEN": "***"
+ },
+ "creation_time_in_millis": 1724274600000,
+ "modification_time_in_millis": 1724274600000,
+ "created_by": {
+ "id": "1f4e7b2d-9c3a-4e6f-8b1d-3e7c5a9b2f4e",
+ "name": "jennifer_patel"
+ }
+ },
+ {
+ "id": "e7c4a1f8-2b5d-4a9e-7c3f-8b1e5d4a7c9b",
+ "name": "Old Webhook 2",
+ "description": "Second webhook to be deleted",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://old-service.example.com/webhook2",
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "API_KEY": {
+ "key": "X-API-Key",
+ "value": "***"
+ }
+ },
+ "creation_time_in_millis": 1724275530123,
+ "modification_time_in_millis": 1724275530123,
+ "created_by": {
+ "id": "9a5c2e8f-4b7d-4c1e-9f2a-6c8e3b5d7a4c",
+ "name": "david_thompson"
+ }
+ }
+ ],
+ "failed_webhooks": []
+ }
+ },
+ "example_2": {
+ "description": "Partial failure during deletion",
+ "value": {
+ "deleted_count": 1,
+ "failed_count": 1,
+ "deleted_webhooks": [
+ {
+ "id": "c8f2a5e9-3d6b-4f1e-a8c2-7e4b1d9f5a3c",
+ "name": "Successfully Deleted Webhook",
+ "description": "This webhook was deleted successfully",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://service.example.com/webhook",
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "NO_AUTH": ""
+ },
+ "creation_time_in_millis": 1724276415456,
+ "modification_time_in_millis": 1724276415456,
+ "created_by": {
+ "id": "6e9c4f2a-8b5d-4e1f-9c3a-5f8b2e7d4a6c",
+ "name": "emma_wang"
+ }
+ }
+ ],
+ "failed_webhooks": [
+ {
+ "id": "a3f7c1e4-9b2d-4a6e-8f3c-1e5b7a9c4f2e",
+ "name": "Non-existent Webhook",
+ "error_message": "Webhook not found or access denied"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
},
- "include_page_number": {
- "type": "boolean",
- "default": true,
- "description": "Indicates whether to include page number in the footer of each page.",
- "nullable": true
+ "400": {
+ "description": "Invalid request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "page_orientation": {
- "type": "string",
- "enum": [
- "PORTRAIT",
- "LANDSCAPE"
- ],
- "default": "PORTRAIT",
- "description": "Page orientation of the PDF.",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "truncate_table": {
- "type": "boolean",
- "default": false,
- "description": "Indicates whether to include only the first page of the tables.",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "page_footer_text": {
- "type": "string",
- "description": "Text to include in the footer of each page.",
- "nullable": true
- }
- }
- },
- "PngOptionsInput": {
- "type": "object",
- "properties": {
- "include_cover_page": {
- "type": "boolean",
- "default": false,
- "description": "Indicates whether to include the cover page with the Liveboard title.",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
},
- "include_filter_page": {
- "type": "boolean",
- "default": false,
- "description": "Indicates whether to include a page with all applied filters.",
- "nullable": true
+ "400": {
+ "description": "Invalid request. Webhook not found or does not have storage destination configured.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "personalised_view_id": {
- "type": "string",
- "description": "Indicates personalised view of the Liveboard in case of png",
- "nullable": true
+ "401": {
+ "description": "Unauthorized access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "image_resolution": {
- "type": "integer",
- "format": "int32",
- "description": "Desired width of the Liveboard image in pixels. Ex. 1920 for Full HD image
Beta Version: 10.9.0.cl or later",
- "nullable": true
+ "403": {
+ "description": "Forbidden access.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
},
- "image_scale": {
- "type": "integer",
- "format": "int32",
- "description": "The scale of the image in percentage. Ex. 100 for 100% scale.
Beta Version: 10.9.0.cl or later",
- "nullable": true
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/rest/2.0/webhooks/search": {
+ "post": {
+ "operationId": "searchWebhookConfigurations",
+ "description": "\nBeta Version: 10.14.0.cl or later\n\nSearches for webhook configurations based on various criteria such as Org, webhook identifier, event type, with support for pagination and sorting. Returns matching webhook configurations with their complete details.\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", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SearchWebhookConfigurationsRequest"
+ }
+ }
},
- "include_header": {
- "type": "boolean",
- "default": false,
- "description": "Indicates whether to include the header of the liveboard.
Beta Version: 10.9.0.cl or later",
- "nullable": true
+ "required": true
+ },
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Webhook configurations retrieved successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WebhookSearchResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search results with multiple webhooks",
+ "value": {
+ "webhooks": [
+ {
+ "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+ "name": "Liveboard Schedule Webhook",
+ "description": "Webhook for liveboard schedule notifications",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://myapp.example.com/webhooks",
+ "url_params": {
+ "api_key": "abc123"
+ },
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "BEARER_TOKEN": "***"
+ },
+ "signature_verification": {
+ "type": "HMAC_SHA256",
+ "header": "X-Webhook-Signature",
+ "algorithm": "SHA256",
+ "secret": "***"
+ },
+ "creation_time_in_millis": 1724277430243,
+ "modification_time_in_millis": 1724278215123,
+ "created_by": {
+ "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b",
+ "name": "sarah_chen"
+ },
+ "last_modified_by": {
+ "id": "2c9a7e4f-6b3d-4a8e-9f1c-5e7a3b9c2d6f",
+ "name": "alex_kim"
+ }
+ },
+ {
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "name": "API Key Webhook",
+ "description": "Webhook with API key authentication",
+ "org": {
+ "id": "0",
+ "name": "Primary"
+ },
+ "url": "https://api.example.com/notifications",
+ "events": ["LIVEBOARD_SCHEDULE"],
+ "authentication": {
+ "API_KEY": {
+ "key": "X-API-Key",
+ "value": "***"
+ }
+ },
+ "creation_time_in_millis": 1724275845987,
+ "modification_time_in_millis": 1724275845987,
+ "created_by": {
+ "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d",
+ "name": "mike_rodriguez"
+ }
+ }
+ ],
+ "pagination": {
+ "record_offset": 0,
+ "record_size": 50,
+ "total_count": 2,
+ "has_more": false
+ }
+ }
+ },
+ "example_2": {
+ "description": "Empty search results",
+ "value": {
+ "webhooks": [],
+ "pagination": {
+ "record_offset": 0,
+ "record_size": 50,
+ "total_count": 0,
+ "has_more": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
}
}
- },
- "RegionalSettingsInput": {
- "type": "object",
- "properties": {
- "currency_format": {
- "type": "string",
- "description": "ISO code to be appended with currency values.",
- "nullable": true,
- "enum": [
- "ADP",
- "AED",
- "AFN",
- "ALL",
- "AMD",
- "ANG",
- "AOA",
- "ARA",
- "ARS",
- "ATS",
- "AUD",
- "AWG",
- "AZN",
- "BAM",
- "BBD",
- "BDT",
- "BEF",
- "BGL",
- "BGM",
- "BGN",
- "BHD",
- "BIF",
- "BMD",
- "BND",
- "BOB",
- "BOP",
- "BOV",
- "BRL",
- "BSD",
- "BTN",
- "BUK",
- "BWP",
- "BYN",
- "BZD",
- "CAD",
- "CDF",
- "CHE",
- "CHF",
- "CHW",
- "CLE",
- "CLP",
- "CNX",
- "CNY",
- "COP",
- "COU",
- "CRC",
- "CSK",
+ }
+ },
+ "/api/rest/2.0/webhooks/{webhook_identifier}/update": {
+ "post": {
+ "operationId": "updateWebhookConfiguration",
+ "description": "\nBeta Version: 10.14.0.cl or later\n\nUpdates an existing webhook configuration by its unique id or name. Only the provided fields will be updated.\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", "10.14.0.cl"],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateWebhookConfigurationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "parameters": [
+ {
+ "in": "path",
+ "name": "webhook_identifier",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of the webhook configuration."
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Webhook configuration 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"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "ErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "GetTokenResponse": {
+ "type": "object",
+ "required": [
+ "token",
+ "creation_time_in_millis",
+ "expiration_time_in_millis",
+ "valid_for_user_id",
+ "valid_for_username"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "Bearer auth token."
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token creation time in milliseconds."
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token expiration time in milliseconds."
+ },
+ "valid_for_user_id": {
+ "type": "string",
+ "description": "Username to whom the token is issued."
+ },
+ "valid_for_username": {
+ "type": "string",
+ "description": "Unique identifier of the user to whom the token is issued."
+ }
+ }
+ },
+ "RiseSetter": {
+ "type": "object",
+ "required": ["field", "path"],
+ "properties": {
+ "field": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ },
+ "User": {
+ "type": "object",
+ "required": ["id", "name", "display_name", "visibility"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the user."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the user."
+ },
+ "display_name": {
+ "type": "string",
+ "description": "Display name of the user."
+ },
+ "visibility": {
+ "type": "string",
+ "enum": ["SHARABLE", "NON_SHARABLE"],
+ "description": "Visibility of the users. The `SHARABLE` property makes a user visible to other users and group, who can share objects with the user."
+ },
+ "author_id": {
+ "type": "string",
+ "description": "Unique identifier of author of the user.",
+ "nullable": true
+ },
+ "can_change_password": {
+ "type": "boolean",
+ "description": "Defines whether the user can change their password.",
+ "nullable": true
+ },
+ "complete_detail": {
+ "type": "boolean",
+ "description": "Defines whether the response has complete detail of the user.",
+ "nullable": true
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Creation time of the user in milliseconds.",
+ "nullable": true
+ },
+ "current_org": {
+ "$ref": "#/components/schemas/Org",
+ "description": "Current logged-in Org of the user.",
+ "nullable": true
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "Indicates whether the user is deleted.",
+ "nullable": true
+ },
+ "deprecated": {
+ "type": "boolean",
+ "description": "Indicates whether the user is deprecated.",
+ "nullable": true
+ },
+ "account_type": {
+ "type": "string",
+ "enum": [
+ "LOCAL_USER",
+ "LDAP_USER",
+ "SAML_USER",
+ "OIDC_USER",
+ "REMOTE_USER"
+ ],
+ "description": "Type of the user account.",
+ "nullable": true
+ },
+ "account_status": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "INACTIVE",
+ "EXPIRED",
+ "LOCKED",
+ "PENDING",
+ "SUSPENDED"
+ ],
+ "description": "Status of the user account.",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "Email of the user.",
+ "nullable": true
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Expiration time of the user in milliseconds.",
+ "nullable": true
+ },
+ "external": {
+ "type": "boolean",
+ "description": "Indicates whether the user is external.",
+ "nullable": true
+ },
+ "favorite_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FavoriteMetadataItem"
+ },
+ "description": "Metadata objects to add to the users' favorites list.",
+ "nullable": true
+ },
+ "first_login_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Timestamp of the first login session of the user in milliseconds.",
+ "nullable": true
+ },
+ "group_mask": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Group mask of the user.",
+ "nullable": true
+ },
+ "hidden": {
+ "type": "boolean",
+ "description": "Indicates whether the user is hidden.",
+ "nullable": true
+ },
+ "home_liveboard": {
+ "$ref": "#/components/schemas/Object_ID_And_Name",
+ "description": "Unique ID or name of the default Liveboard assigned to the user.",
+ "nullable": true
+ },
+ "incomplete_details": {
+ "type": "object",
+ "description": "Incomplete details of user if any present.",
+ "nullable": true
+ },
+ "is_first_login": {
+ "type": "boolean",
+ "description": "Indicates whether it is first login of the user.",
+ "nullable": true
+ },
+ "modification_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Last modified time of the user in milliseconds.",
+ "nullable": true
+ },
+ "modifier_id": {
+ "type": "string",
+ "description": "Unique identifier of modifier of the user.",
+ "nullable": true
+ },
+ "notify_on_share": {
+ "type": "boolean",
+ "description": "User preference for receiving email notifications on shared Answers or Liveboard.",
+ "nullable": true
+ },
+ "onboarding_experience_completed": {
+ "type": "boolean",
+ "description": "The user preference for turning off the onboarding experience.",
+ "nullable": true
+ },
+ "orgs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Org"
+ },
+ "description": "Orgs to which the user belongs.",
+ "nullable": true
+ },
+ "owner_id": {
+ "type": "string",
+ "description": "Unique identifier of owner of the user.",
+ "nullable": true
+ },
+ "parent_type": {
+ "type": "string",
+ "enum": ["USER", "GROUP"],
+ "description": "Parent type of the user.",
+ "nullable": true
+ },
+ "privileges": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Privileges which are assigned to the user.",
+ "nullable": true
+ },
+ "show_onboarding_experience": {
+ "type": "boolean",
+ "description": "User's preference to revisit the new user onboarding experience.",
+ "nullable": true
+ },
+ "super_user": {
+ "type": "boolean",
+ "description": "Indicates whether the user is a super user.",
+ "nullable": true
+ },
+ "system_user": {
+ "type": "boolean",
+ "description": "Indicates whether the user is a system user.",
+ "nullable": true
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Object_ID_And_Name"
+ },
+ "description": "Tags associated with the user.",
+ "nullable": true
+ },
+ "tenant_id": {
+ "type": "string",
+ "description": "Unique identifier of tenant of the user.",
+ "nullable": true
+ },
+ "user_groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Object_ID_And_Name"
+ },
+ "description": "Groups to which the user is assigned.",
+ "nullable": true
+ },
+ "user_inherited_groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Object_ID_And_Name"
+ },
+ "description": "Inherited User Groups which the user is part of.",
+ "nullable": true
+ },
+ "welcome_email_sent": {
+ "type": "boolean",
+ "description": "Indicates whether welcome email is sent for the user.",
+ "nullable": true
+ },
+ "org_privileges": {
+ "type": "object",
+ "description": "Privileges which are assigned to the user with org.",
+ "nullable": true
+ },
+ "preferred_locale": {
+ "type": "string",
+ "description": "Locale for the user.",
+ "nullable": true
+ },
+ "use_browser_language": {
+ "type": "boolean",
+ "description": "Version: 26.3.0.cl or later
\n\nFlag 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",
+ "nullable": true
+ },
+ "extended_properties": {
+ "type": "object",
+ "description": "Properties for the user",
+ "nullable": true
+ },
+ "extended_preferences": {
+ "type": "object",
+ "description": "Preferences for the user",
+ "nullable": true
+ },
+ "user_parameters": {
+ "type": "object",
+ "description": "User Parameters which are specified for the user via JWToken",
+ "nullable": true
+ },
+ "access_control_properties": {
+ "type": "object",
+ "description": "Access Control Properties which are specified for the user via JWToken",
+ "nullable": true
+ },
+ "variable_values": {
+ "type": "object",
+ "description": "Formula Variables which are specified for the user via JWToken",
+ "nullable": true
+ }
+ }
+ },
+ "Org": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The ID of the object."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the object."
+ }
+ },
+ "description": "The current Org context of the user."
+ },
+ "FavoriteMetadataItem": {
+ "type": "object",
+ "required": ["id", "name", "type"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique ID of the metadata object."
+ },
+ "name": {
+ "type": "string",
+ "description": "name of the metadata object."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION",
+ "TAG",
+ "USER",
+ "USER_GROUP",
+ "LOGICAL_RELATIONSHIP"
+ ],
+ "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier."
+ }
+ }
+ },
+ "Object_ID_And_Name": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the object.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the object.",
+ "nullable": true
+ }
+ },
+ "description": "The object representation with ID and Name."
+ },
+ "FavoriteMetadataInput": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LIVEBOARD", "ANSWER"],
+ "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ }
+ }
+ },
+ "SortOptions": {
+ "type": "object",
+ "properties": {
+ "field_name": {
+ "type": "string",
+ "enum": ["NAME", "DISPLAY_NAME", "AUTHOR", "CREATED", "MODIFIED"],
+ "description": "Name of the field to apply the sort on.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "enum": ["ASC", "DESC"],
+ "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "nullable": true
+ }
+ },
+ "description": "Sort options."
+ },
+ "SystemInfo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the object",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the cluster.",
+ "nullable": true
+ },
+ "release_version": {
+ "type": "string",
+ "description": "The release version of the cluster.",
+ "nullable": true
+ },
+ "time_zone": {
+ "type": "string",
+ "description": "The timezone of the cluster.",
+ "nullable": true
+ },
+ "locale": {
+ "type": "string",
+ "description": "The default locale of the cluster.",
+ "nullable": true
+ },
+ "date_format": {
+ "type": "string",
+ "description": "The default date format representation of the cluster.",
+ "nullable": true
+ },
+ "api_version": {
+ "type": "string",
+ "description": "The API version of the cluster.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "description": "The deployment type of the cluster.",
+ "nullable": true
+ },
+ "environment": {
+ "type": "string",
+ "description": "The deployed environment of the cluster.",
+ "nullable": true
+ },
+ "license": {
+ "type": "string",
+ "description": "The license applied to the cluster.",
+ "nullable": true
+ },
+ "date_time_format": {
+ "type": "string",
+ "description": "The default date time format representation of the cluster.",
+ "nullable": true
+ },
+ "time_format": {
+ "type": "string",
+ "description": "The default time format representation of the cluster.",
+ "nullable": true
+ },
+ "system_user_id": {
+ "type": "string",
+ "description": "The unique identifier of system user.",
+ "nullable": true
+ },
+ "super_user_id": {
+ "type": "string",
+ "description": "The unique identifier of super user.",
+ "nullable": true
+ },
+ "hidden_object_id": {
+ "type": "string",
+ "description": "The unique identifier of hidden object.",
+ "nullable": true
+ },
+ "system_group_id": {
+ "type": "string",
+ "description": "The unique identifier of system group.",
+ "nullable": true
+ },
+ "tsadmin_user_id": {
+ "type": "string",
+ "description": "The unique identifier of tsadmin user.",
+ "nullable": true
+ },
+ "admin_group_id": {
+ "type": "string",
+ "description": "The unique identifier of admin group.",
+ "nullable": true
+ },
+ "all_tables_connection_id": {
+ "type": "string",
+ "description": "The unique identifier of all tables connection.",
+ "nullable": true
+ },
+ "all_user_group_id": {
+ "type": "string",
+ "description": "The unique identifier of ALL group.",
+ "nullable": true
+ },
+ "accept_language": {
+ "type": "string",
+ "description": "The supported accept language by the cluster.",
+ "nullable": true
+ },
+ "all_user_group_member_user_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The count of users of ALL group.",
+ "nullable": true
+ },
+ "logical_model_version": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The version number of logical model of the cluster.",
+ "nullable": true
+ }
+ }
+ },
+ "SystemConfig": {
+ "type": "object",
+ "properties": {
+ "onboarding_content_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "saml_enabled": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "okta_enabled": {
+ "type": "boolean",
+ "nullable": true
+ }
+ }
+ },
+ "SystemOverrideInfo": {
+ "type": "object",
+ "properties": {
+ "config_override_info": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "OrgPreferenceSearchCriteriaInput": {
+ "type": "object",
+ "required": ["org_identifier"],
+ "properties": {
+ "org_identifier": {
+ "type": "string",
+ "description": "Unique identifier or name of the org"
+ },
+ "event_types": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["LIVEBOARD_SCHEDULE"]
+ },
+ "description": "Event types to search for. If not provided, all event types for this org are returned.",
+ "nullable": true
+ }
+ }
+ },
+ "CommunicationChannelPreferencesResponse": {
+ "type": "object",
+ "properties": {
+ "cluster_preferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventChannelConfig"
+ },
+ "description": "Cluster-level default configurations.",
+ "nullable": true
+ },
+ "org_preferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrgChannelConfigResponse"
+ },
+ "description": "Org-specific configurations.",
+ "nullable": true
+ }
+ }
+ },
+ "EventChannelConfig": {
+ "type": "object",
+ "required": ["event_type", "channels"],
+ "properties": {
+ "event_type": {
+ "type": "string",
+ "enum": ["LIVEBOARD_SCHEDULE"],
+ "description": "Type of event for which communication channels are configured"
+ },
+ "channels": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["EMAIL", "WEBHOOK"]
+ },
+ "description": "Communication channels enabled for this event type. Empty array indicates no channels are enabled."
+ }
+ }
+ },
+ "OrgChannelConfigResponse": {
+ "type": "object",
+ "required": ["org", "preferences"],
+ "properties": {
+ "org": {
+ "$ref": "#/components/schemas/OrgDetails",
+ "description": "Org details"
+ },
+ "preferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventChannelConfig"
+ },
+ "description": "Event-specific communication channel configurations for this org"
+ }
+ }
+ },
+ "OrgDetails": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique id of the org"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the org"
+ }
+ }
+ },
+ "SecuritySettingsResponse": {
+ "type": "object",
+ "properties": {
+ "cluster_preferences": {
+ "$ref": "#/components/schemas/SecuritySettingsClusterPreferences",
+ "description": "Cluster-level security preferences.",
+ "nullable": true
+ },
+ "org_preferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SecuritySettingsOrgPreferences"
+ },
+ "description": "Org-level security preferences.",
+ "nullable": true
+ }
+ },
+ "description": "Response type for security settings search."
+ },
+ "SecuritySettingsClusterPreferences": {
+ "type": "object",
+ "properties": {
+ "enable_partitioned_cookies": {
+ "type": "boolean",
+ "description": "Support embedded access when third-party cookies are blocked.",
+ "nullable": true
+ },
+ "cors_whitelisted_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed origins for CORS.",
+ "nullable": true
+ },
+ "csp_settings": {
+ "$ref": "#/components/schemas/CspSettings",
+ "description": "CSP (Content Security Policy) settings.",
+ "nullable": true
+ },
+ "saml_redirect_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed redirect hosts for SAML login.",
+ "nullable": true
+ },
+ "non_embed_access": {
+ "$ref": "#/components/schemas/ClusterNonEmbedAccess",
+ "description": "Non-embed access configuration at cluster level.",
+ "nullable": true
+ }
+ },
+ "description": "Cluster-level security preferences."
+ },
+ "CspSettings": {
+ "type": "object",
+ "properties": {
+ "connect_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for connect-src directive.",
+ "nullable": true
+ },
+ "font_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for font-src directive.",
+ "nullable": true
+ },
+ "visual_embed_hosts": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed hosts for visual embed (frame-ancestors directive).",
+ "nullable": true
+ },
+ "iframe_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for frame-src directive.",
+ "nullable": true
+ },
+ "img_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for img-src directive.",
+ "nullable": true
+ },
+ "script_src_urls": {
+ "$ref": "#/components/schemas/ScriptSrcUrls",
+ "description": "Script-src settings including URLs and enabled flag.",
+ "nullable": true
+ },
+ "style_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for style-src directive.",
+ "nullable": true
+ }
+ },
+ "description": "CSP (Content Security Policy) settings."
+ },
+ "ScriptSrcUrls": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether script-src customization is enabled.",
+ "nullable": true
+ },
+ "urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for script-src directive. Can only be set if enabled is true.",
+ "nullable": true
+ }
+ },
+ "description": "Script-src CSP settings."
+ },
+ "ClusterNonEmbedAccess": {
+ "type": "object",
+ "properties": {
+ "block_full_app_access": {
+ "type": "boolean",
+ "description": "Block full application access for non-embedded usage.",
+ "nullable": true
+ },
+ "groups_with_access": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupInfo"
+ },
+ "description": "Groups that have non-embed full app access.\nOnly applicable when orgs feature is disabled. Use org_preferences when org feature is enabled.",
+ "nullable": true
+ }
+ },
+ "description": "Cluster-level non-embed access configuration."
+ },
+ "GroupInfo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the group.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the group.",
+ "nullable": true
+ }
+ },
+ "description": "Group information for non-embed access."
+ },
+ "SecuritySettingsOrgPreferences": {
+ "type": "object",
+ "properties": {
+ "org": {
+ "$ref": "#/components/schemas/SecuritySettingsOrgDetails",
+ "description": "Org details (id and name).",
+ "nullable": true
+ },
+ "cors_whitelisted_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed origins for CORS for this org.",
+ "nullable": true
+ },
+ "non_embed_access": {
+ "$ref": "#/components/schemas/OrgNonEmbedAccess",
+ "description": "Non-embed access configuration for this org.",
+ "nullable": true
+ }
+ },
+ "description": "Org-level security preferences."
+ },
+ "SecuritySettingsOrgDetails": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique identifier of the org.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the org.",
+ "nullable": true
+ }
+ },
+ "description": "Org details for security settings."
+ },
+ "OrgNonEmbedAccess": {
+ "type": "object",
+ "properties": {
+ "block_full_app_access": {
+ "type": "boolean",
+ "description": "Block full application access for non-embedded usage.",
+ "nullable": true
+ },
+ "groups_with_access": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupInfo"
+ },
+ "description": "Groups that have non-embed full app access.",
+ "nullable": true
+ }
+ },
+ "description": "Org-level non-embed access configuration."
+ },
+ "OrgResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique identifier of the Org.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the Org.",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": ["ACTIVE", "IN_ACTIVE"],
+ "description": "Status of the Org.",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the Org.",
+ "nullable": true
+ },
+ "visibility": {
+ "type": "string",
+ "enum": ["SHOW", "HIDDEN"],
+ "description": "Visibility of the Org.",
+ "nullable": true
+ }
+ }
+ },
+ "Tag": {
+ "type": "object",
+ "required": ["name", "id"],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string",
+ "nullable": true
+ },
+ "deleted": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "hidden": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "external": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "deprecated": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "nullable": true
+ },
+ "modification_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "nullable": true
+ },
+ "author_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "modifier_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "owner_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "UserGroupResponse": {
+ "type": "object",
+ "required": ["display_name", "id", "name", "visibility"],
+ "properties": {
+ "author_id": {
+ "type": "string",
+ "description": "The unique identifier of the object",
+ "nullable": true
+ },
+ "complete_detail": {
+ "type": "boolean",
+ "description": "Indicates whether the response has complete detail of the group.",
+ "nullable": true
+ },
+ "content": {
+ "type": "object",
+ "description": "Content details of the group",
+ "nullable": true
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Creation time of the group in milliseconds",
+ "nullable": true
+ },
+ "default_liveboards": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "Liveboards that are assigned as default Liveboards to the group.",
+ "nullable": true
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "Indicates whether the group is deleted",
+ "nullable": true
+ },
+ "deprecated": {
+ "type": "boolean",
+ "description": "Indicates whether the group is deprecated",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the group",
+ "nullable": true
+ },
+ "display_name": {
+ "type": "string",
+ "description": "Display name of the group."
+ },
+ "external": {
+ "type": "boolean",
+ "description": "Indicates whether the group is external",
+ "nullable": true
+ },
+ "generation_number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Generation number of the group",
+ "nullable": true
+ },
+ "hidden": {
+ "type": "boolean",
+ "description": "Indicates whether the group is hidden",
+ "nullable": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the object"
+ },
+ "index": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Index number of the group",
+ "nullable": true
+ },
+ "index_version": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Index version number of the group",
+ "nullable": true
+ },
+ "metadata_version": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Metadata version number of the group",
+ "nullable": true
+ },
+ "modification_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Last modified time of the group in milliseconds.",
+ "nullable": true
+ },
+ "modifier_id": {
+ "type": "string",
+ "description": "The unique identifier of the object",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the group."
+ },
+ "orgs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "Orgs in which group exists.",
+ "nullable": true
+ },
+ "owner_id": {
+ "type": "string",
+ "description": "The unique identifier of the object",
+ "nullable": true
+ },
+ "parent_type": {
+ "type": "string",
+ "enum": ["USER", "GROUP"],
+ "description": "Parent type of the group.",
+ "nullable": true
+ },
+ "privileges": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Privileges which are assigned to the group",
+ "nullable": true
+ },
+ "sub_groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "Groups who are part of the group",
+ "nullable": true
+ },
+ "system_group": {
+ "type": "boolean",
+ "description": "Indicates whether the group is a system group.",
+ "nullable": true
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "Tags associated with the group.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP"],
+ "description": "Type of the group.",
+ "nullable": true
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "Users who are part of the group.",
+ "nullable": true
+ },
+ "visibility": {
+ "type": "string",
+ "enum": ["SHARABLE", "NON_SHARABLE"],
+ "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects."
+ },
+ "roles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Role"
+ },
+ "description": "List of roles assgined to the user",
+ "nullable": true
+ }
+ }
+ },
+ "Role": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "id of the role",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "name of the role",
+ "nullable": true
+ }
+ }
+ },
+ "MetadataListItemInput": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata.",
+ "nullable": true
+ },
+ "obj_identifier": {
+ "type": "string",
+ "description": "CustomObjectId of the metadata.",
+ "nullable": true
+ },
+ "name_pattern": {
+ "type": "string",
+ "description": "A pattern to match the case-insensitive name of the metadata object. User % for a wildcard match.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION",
+ "TAG",
+ "USER",
+ "USER_GROUP",
+ "LOGICAL_RELATIONSHIP",
+ "INSIGHT_SPEC"
+ ],
+ "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view.\n5. CONNECTION for creating or modify data connections.\n6. TAG for tag objects.\n7. USER for user objects.\n8. USER_GROUP for group objects.\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values\n10. INSIGHT_SPEC for SpotIQ objects",
+ "nullable": true
+ },
+ "subtypes": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "ONE_TO_ONE_LOGICAL",
+ "WORKSHEET",
+ "PRIVATE_WORKSHEET",
+ "USER_DEFINED",
+ "AGGR_WORKSHEET",
+ "SQL_VIEW"
+ ]
+ },
+ "description": "Version: 10.11.0.cl or later
\n\nList of subtype of metadata. Applies for LOGICAL_TABLE type with the following valid values.\n1. ONE_TO_ONE_LOGICAL\n2. WORKSHEET\n3. PRIVATE_WORKSHEET.\n4. USER_DEFINED.\n5. AGGR_WORKSHEET.\n6. SQL_VIEW
Version: 10.11.0.cl or later",
+ "nullable": true
+ }
+ }
+ },
+ "PermissionInput": {
+ "type": "object",
+ "required": ["principal", "share_mode"],
+ "properties": {
+ "principal": {
+ "$ref": "#/components/schemas/PrincipalsInput",
+ "description": "Details of users or groups."
+ },
+ "share_mode": {
+ "type": "string",
+ "enum": ["READ_ONLY", "MODIFY", "NO_ACCESS"],
+ "description": "Object share mode."
+ }
+ },
+ "description": "Details of users or groups."
+ },
+ "ExcludeMetadataListItemInput": {
+ "type": "object",
+ "required": ["identifier", "type"],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION",
+ "TAG",
+ "USER",
+ "USER_GROUP",
+ "LOGICAL_RELATIONSHIP",
+ "INSIGHT_SPEC"
+ ],
+ "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view\n5. CONNECTION for connection objects\n6. TAG for tag objects\n7. USER for user objects\n8. USER_GROUP for group objects\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values.\n10. INSIGHT_SPEC for SpotIQ objects"
+ }
+ }
+ },
+ "FavoriteObjectOptionsInput": {
+ "type": "object",
+ "properties": {
+ "include": {
+ "type": "boolean",
+ "default": false,
+ "description": "Includes objects marked as favorite for the specified users.",
+ "nullable": true
+ },
+ "user_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of the users. If not specified, the favorite objects of current logged in user are returned.",
+ "nullable": true
+ }
+ },
+ "description": "Favorite object options."
+ },
+ "MetadataSearchSortOptions": {
+ "type": "object",
+ "properties": {
+ "field_name": {
+ "type": "string",
+ "enum": [
+ "NAME",
+ "DISPLAY_NAME",
+ "AUTHOR",
+ "CREATED",
+ "MODIFIED",
+ "VIEWS",
+ "FAVORITES",
+ "LAST_ACCESSED"
+ ],
+ "description": "Name of the field to apply the sort on.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "enum": ["ASC", "DESC"],
+ "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "nullable": true
+ }
+ },
+ "description": "Sort options."
+ },
+ "MetadataSearchResponse": {
+ "type": "object",
+ "required": ["metadata_type"],
+ "properties": {
+ "metadata_id": {
+ "type": "string",
+ "description": "Unique identifier of the metadata.",
+ "nullable": true
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata.",
+ "nullable": true
+ },
+ "metadata_type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION",
+ "TAG",
+ "USER",
+ "USER_GROUP",
+ "LOGICAL_RELATIONSHIP",
+ "INSIGHT_SPEC"
+ ],
+ "description": "Type of the metadata."
+ },
+ "metadata_obj_id": {
+ "type": "string",
+ "description": "Custom identifier of the metadata.\n(Available from 10.8.0.cl onwards)",
+ "nullable": true
+ },
+ "dependent_objects": {
+ "type": "object",
+ "description": "Details of dependent objects of the metadata objects.",
+ "nullable": true
+ },
+ "incomplete_objects": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "description": "Details of incomplete information of the metadata objects if any.",
+ "nullable": true
+ },
+ "metadata_detail": {
+ "type": "object",
+ "description": "Complete details of the metadata objects.",
+ "nullable": true
+ },
+ "metadata_header": {
+ "type": "object",
+ "description": "Header information of the metadata objects.",
+ "nullable": true
+ },
+ "visualization_headers": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "description": "Visualization header information of the metadata objects.",
+ "nullable": true
+ },
+ "stats": {
+ "type": "object",
+ "description": "Stats of the metadata object. Includes views, favorites, last_accessed.",
+ "nullable": true
+ }
+ },
+ "description": "Metadata Search Response Object."
+ },
+ "GetAsyncImportStatusResponse": {
+ "type": "object",
+ "properties": {
+ "status_list": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ImportEPackAsyncTaskStatus"
+ },
+ "description": "List of task statuses.",
+ "nullable": true
+ },
+ "last_batch": {
+ "type": "boolean",
+ "description": "Indicates whether there are more task statuses to fetch.",
+ "nullable": true
+ }
+ }
+ },
+ "ImportEPackAsyncTaskStatus": {
+ "type": "object",
+ "properties": {
+ "tenant_id": {
+ "type": "string",
+ "description": "GUID of tenant from which the task is initiated.",
+ "nullable": true
+ },
+ "org_id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Organisation ID of the user who initiated the task.",
+ "nullable": true
+ },
+ "task_id": {
+ "type": "string",
+ "description": "Unique identifier for the task.",
+ "nullable": true
+ },
+ "task_name": {
+ "type": "string",
+ "description": "Name of the task.",
+ "nullable": true
+ },
+ "import_response": {
+ "type": "object",
+ "description": "Response of imported objects so far.",
+ "nullable": true
+ },
+ "task_status": {
+ "type": "string",
+ "enum": ["COMPLETED", "IN_QUEUE", "IN_PROGRESS", "FAILED"],
+ "description": "Current status of the task.",
+ "nullable": true
+ },
+ "author_id": {
+ "type": "string",
+ "description": "ID of the user who initiated the task.",
+ "nullable": true
+ },
+ "import_policy": {
+ "type": "string",
+ "enum": [
+ "PARTIAL",
+ "ALL_OR_NONE",
+ "VALIDATE_ONLY",
+ "PARTIAL_OBJECT"
+ ],
+ "description": "Policy used for the import task.",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "number",
+ "format": "float",
+ "description": "Time when the task was created (in ms since epoch).",
+ "nullable": true
+ },
+ "in_progress_at": {
+ "type": "number",
+ "format": "float",
+ "description": "Time when the task started (in ms since epoch).",
+ "nullable": true
+ },
+ "completed_at": {
+ "type": "number",
+ "format": "float",
+ "description": "Time when the task was completed (in ms since epoch).",
+ "nullable": true
+ },
+ "total_object_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of objects to process.",
+ "nullable": true
+ },
+ "object_processed_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of objects processed so far.",
+ "nullable": true
+ },
+ "modified_at": {
+ "type": "number",
+ "format": "float",
+ "description": "Last time the task status was updated (in ms since epoch).",
+ "nullable": true
+ },
+ "author_display_name": {
+ "type": "string",
+ "description": "Display name of the user who initiated the task.",
+ "nullable": true
+ }
+ }
+ },
+ "SqlQueryResponse": {
+ "type": "object",
+ "required": [
+ "metadata_id",
+ "metadata_name",
+ "metadata_type",
+ "sql_queries"
+ ],
+ "properties": {
+ "metadata_id": {
+ "type": "string",
+ "description": "Unique identifier of the metadata."
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata."
+ },
+ "metadata_type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION",
+ "TAG",
+ "USER",
+ "USER_GROUP",
+ "LOGICAL_RELATIONSHIP"
+ ],
+ "description": "Type of the metadata."
+ },
+ "sql_queries": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SqlQuery"
+ },
+ "description": "SQL query details of metadata objects."
+ }
+ }
+ },
+ "SqlQuery": {
+ "type": "object",
+ "required": ["metadata_id", "metadata_name", "sql_query"],
+ "properties": {
+ "metadata_id": {
+ "type": "string",
+ "description": "Unique identifier of the metadata."
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata."
+ },
+ "sql_query": {
+ "type": "string",
+ "description": "SQL query of a metadata object."
+ }
+ },
+ "description": "Response format associated with fetch SQL query api"
+ },
+ "PdfOptionsInput": {
+ "type": "object",
+ "properties": {
+ "include_cover_page": {
+ "type": "boolean",
+ "default": true,
+ "description": "Indicates whether to include the cover page with the Liveboard title.",
+ "nullable": true
+ },
+ "include_custom_logo": {
+ "type": "boolean",
+ "default": true,
+ "description": "Indicates whether to include customized wide logo in the footer if available.",
+ "nullable": true
+ },
+ "include_filter_page": {
+ "type": "boolean",
+ "default": true,
+ "description": "Indicates whether to include a page with all applied filters.",
+ "nullable": true
+ },
+ "include_page_number": {
+ "type": "boolean",
+ "default": true,
+ "description": "Indicates whether to include page number in the footer of each page.",
+ "nullable": true
+ },
+ "page_orientation": {
+ "type": "string",
+ "enum": ["PORTRAIT", "LANDSCAPE"],
+ "default": "PORTRAIT",
+ "description": "Page orientation of the PDF.",
+ "nullable": true
+ },
+ "truncate_table": {
+ "type": "boolean",
+ "default": false,
+ "description": "Indicates whether to include only the first page of the tables.",
+ "nullable": true
+ },
+ "page_footer_text": {
+ "type": "string",
+ "description": "Text to include in the footer of each page.",
+ "nullable": true
+ }
+ }
+ },
+ "PngOptionsInput": {
+ "type": "object",
+ "properties": {
+ "include_cover_page": {
+ "type": "boolean",
+ "default": false,
+ "description": "Indicates whether to include the cover page with the Liveboard title.",
+ "nullable": true
+ },
+ "include_filter_page": {
+ "type": "boolean",
+ "default": false,
+ "description": "Indicates whether to include a page with all applied filters.",
+ "nullable": true
+ },
+ "personalised_view_id": {
+ "type": "string",
+ "description": "Indicates personalised view of the Liveboard in case of png",
+ "nullable": true
+ },
+ "image_resolution": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Version: 10.9.0.cl or later Early Access
\n\nDesired width of the Liveboard image in pixels. Ex. 1920 for Full HD image
Version: 10.9.0.cl or later",
+ "nullable": true
+ },
+ "image_scale": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Version: 10.9.0.cl or later Early Access
\n\nThe scale of the image in percentage. Ex. 100 for 100% scale.
Version: 10.9.0.cl or later",
+ "nullable": true
+ },
+ "include_header": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 10.9.0.cl or later Early Access
\n\nIndicates whether to include the header of the liveboard.
Version: 10.9.0.cl or later",
+ "nullable": true
+ }
+ }
+ },
+ "RegionalSettingsInput": {
+ "type": "object",
+ "properties": {
+ "currency_format": {
+ "type": "string",
+ "description": "ISO code to be appended with currency values.",
+ "nullable": true,
+ "enum": [
+ "ADP",
+ "AED",
+ "AFN",
+ "ALL",
+ "AMD",
+ "ANG",
+ "AOA",
+ "ARA",
+ "ARS",
+ "ATS",
+ "AUD",
+ "AWG",
+ "AZN",
+ "BAM",
+ "BBD",
+ "BDT",
+ "BEF",
+ "BGL",
+ "BGM",
+ "BGN",
+ "BHD",
+ "BIF",
+ "BMD",
+ "BND",
+ "BOB",
+ "BOP",
+ "BOV",
+ "BRL",
+ "BSD",
+ "BTN",
+ "BUK",
+ "BWP",
+ "BYN",
+ "BZD",
+ "CAD",
+ "CDF",
+ "CHE",
+ "CHF",
+ "CHW",
+ "CLE",
+ "CLP",
+ "CNX",
+ "CNY",
+ "COP",
+ "COU",
+ "CRC",
+ "CSK",
"CUC",
"CUP",
"CVE",
@@ -15092,2175 +12690,7435 @@
"ZMW"
]
},
- "user_locale": {
+ "user_locale": {
+ "type": "string",
+ "description": "Indicates the locale to be used for all formattings.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN",
+ "de-CH",
+ "en-NZ",
+ "es-MX",
+ "en-AU",
+ "zh-Hant",
+ "ko-KR",
+ "en-DE"
+ ]
+ },
+ "number_format_locale": {
+ "type": "string",
+ "description": "Indicates the locale to be used for number formatting.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN",
+ "de-CH",
+ "en-NZ",
+ "es-MX",
+ "en-AU",
+ "zh-Hant",
+ "ko-KR",
+ "en-DE"
+ ]
+ },
+ "date_format_locale": {
+ "type": "string",
+ "description": "Indicates the locale to be used for date formatting.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN",
+ "de-CH",
+ "en-NZ",
+ "es-MX",
+ "en-AU",
+ "zh-Hant",
+ "ko-KR",
+ "en-DE"
+ ]
+ }
+ }
+ },
+ "PermissionOfPrincipalsResponse": {
+ "type": "object",
+ "properties": {
+ "principal_permission_details": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "PermissionOfMetadataResponse": {
+ "type": "object",
+ "properties": {
+ "metadata_permission_details": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "ObjectPrivilegesMetadataInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["LOGICAL_TABLE"],
+ "description": "Type of metadata object.\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object."
+ }
+ }
+ },
+ "ObjectPrivilegesOfMetadataResponse": {
+ "type": "object",
+ "properties": {
+ "metadata_object_privileges": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "PrincipalsInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the principal object such as a user or group."
+ },
+ "type": {
+ "type": "string",
+ "enum": ["USER", "USER_GROUP"],
+ "description": "Principal type.",
+ "nullable": true
+ }
+ }
+ },
+ "PermissionsMetadataTypeInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION"
+ ],
+ "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object."
+ }
+ },
+ "description": "MetadataType InputType used in Permission API's"
+ },
+ "ColumnSecurityRuleTableInput": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Name or GUID of the table",
+ "nullable": true
+ },
+ "obj_identifier": {
+ "type": "string",
+ "description": "Object ID of the table",
+ "nullable": true
+ }
+ }
+ },
+ "ColumnSecurityRuleResponse": {
+ "type": "object",
+ "properties": {
+ "table_guid": {
+ "type": "string",
+ "description": "GUID of the table for which the column security rules are fetched",
+ "nullable": true
+ },
+ "obj_id": {
+ "type": "string",
+ "description": "Object ID of the table for which the column security rules are fetched",
+ "nullable": true
+ },
+ "column_security_rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ColumnSecurityRule"
+ },
+ "description": "Array containing column security rule objects",
+ "nullable": true
+ }
+ }
+ },
+ "ColumnSecurityRule": {
+ "type": "object",
+ "required": ["column"],
+ "properties": {
+ "column": {
+ "$ref": "#/components/schemas/ColumnSecurityRuleColumn",
+ "description": "Information about the column"
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ColumnSecurityRuleGroup"
+ },
+ "description": "Array of groups that have access to this column",
+ "nullable": true
+ },
+ "source_table_details": {
+ "$ref": "#/components/schemas/ColumnSecurityRuleSourceTable",
+ "description": "Information about the source table",
+ "nullable": true
+ }
+ }
+ },
+ "ColumnSecurityRuleColumn": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the column"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the column"
+ }
+ }
+ },
+ "ColumnSecurityRuleGroup": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the group"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the group"
+ }
+ }
+ },
+ "ColumnSecurityRuleSourceTable": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the source table"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the source table"
+ }
+ }
+ },
+ "SearchDataResponse": {
+ "type": "object",
+ "required": ["contents"],
+ "properties": {
+ "contents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AnswerContent"
+ },
+ "description": "Data content of metadata objects"
+ }
+ },
+ "description": "Response format associated with the search data API."
+ },
+ "AnswerContent": {
+ "type": "object",
+ "required": [
+ "available_data_row_count",
+ "column_names",
+ "data_rows",
+ "record_offset",
+ "record_size",
+ "returned_data_row_count",
+ "sampling_ratio"
+ ],
+ "properties": {
+ "available_data_row_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total available data row count."
+ },
+ "column_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Name of the columns."
+ },
+ "data_rows": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "description": "Rows of data set."
+ },
+ "record_offset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The starting record number from where the records should be included."
+ },
+ "record_size": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of records that should be included."
+ },
+ "returned_data_row_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total returned data row count."
+ },
+ "sampling_ratio": {
+ "type": "number",
+ "format": "float",
+ "description": "Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys returned in the data set to the total number of keys expected in the query. If the value is 1.0, this means that the complete result is returned."
+ }
+ }
+ },
+ "LiveboardDataResponse": {
+ "type": "object",
+ "required": ["metadata_id", "metadata_name", "contents"],
+ "properties": {
+ "metadata_id": {
+ "type": "string",
+ "description": "The unique identifier of the object"
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata object"
+ },
+ "contents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LiveboardContent"
+ },
+ "description": "Data content of metadata objects"
+ }
+ }
+ },
+ "LiveboardContent": {
+ "type": "object",
+ "required": [
+ "available_data_row_count",
+ "column_names",
+ "data_rows",
+ "record_offset",
+ "record_size",
+ "returned_data_row_count",
+ "sampling_ratio"
+ ],
+ "properties": {
+ "available_data_row_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total available data row count."
+ },
+ "column_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Name of the columns."
+ },
+ "data_rows": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "description": "Rows of data set."
+ },
+ "record_offset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The starting record number from where the records should be included."
+ },
+ "record_size": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of records that should be included."
+ },
+ "returned_data_row_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total returned data row count."
+ },
+ "sampling_ratio": {
+ "type": "number",
+ "format": "float",
+ "description": "Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys returned in the data set to the total number of keys expected in the query. If the value is 1.0, this means that the complete result is returned."
+ },
+ "visualization_id": {
+ "type": "string",
+ "description": "Unique ID of the visualization.",
+ "nullable": true
+ },
+ "visualization_name": {
+ "type": "string",
+ "description": "Name of the visualization.",
+ "nullable": true
+ }
+ }
+ },
+ "AnswerDataResponse": {
+ "type": "object",
+ "required": ["metadata_id", "metadata_name", "contents"],
+ "properties": {
+ "metadata_id": {
+ "type": "string",
+ "description": "The unique identifier of the object"
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata object"
+ },
+ "contents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AnswerContent"
+ },
+ "description": "Data content of metadata objects"
+ }
+ },
+ "description": "Response format associated with fetch data api"
+ },
+ "LogResponse": {
+ "type": "object",
+ "required": ["date", "log"],
+ "properties": {
+ "date": {
+ "type": "string",
+ "description": "Date timestamp of the log entry"
+ },
+ "log": {
+ "type": "string",
+ "description": "Log data"
+ }
+ }
+ },
+ "RepoConfigObject": {
+ "type": "object",
+ "properties": {
+ "repository_url": {
+ "type": "string",
+ "description": "Remote repository URL configured",
+ "nullable": true
+ },
+ "username": {
+ "type": "string",
+ "description": "Username to authenticate connection to the version control system",
+ "nullable": true
+ },
+ "commit_branch_name": {
+ "type": "string",
+ "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.",
+ "nullable": true
+ },
+ "branches": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Branches that have been pulled in local repository",
+ "nullable": true
+ },
+ "enable_guid_mapping": {
+ "type": "boolean",
+ "description": "Maintain mapping of guid for the deployment to an instance",
+ "nullable": true
+ },
+ "configuration_branch_name": {
+ "type": "string",
+ "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.",
+ "nullable": true
+ },
+ "org": {
+ "$ref": "#/components/schemas/Org",
+ "description": "Details of the Org",
+ "nullable": true
+ }
+ }
+ },
+ "CommitHistoryResponse": {
+ "type": "object",
+ "required": [
+ "committer",
+ "author",
+ "comment",
+ "commit_time",
+ "commit_id",
+ "branch"
+ ],
+ "properties": {
+ "committer": {
+ "$ref": "#/components/schemas/CommiterType",
+ "description": "Repository user using which changes were committed"
+ },
+ "author": {
+ "$ref": "#/components/schemas/AuthorType",
+ "description": "Thoughtspot user who commits the changes"
+ },
+ "comment": {
+ "type": "string",
+ "description": "Comments associated with the commit"
+ },
+ "commit_time": {
+ "type": "string",
+ "description": "Time at which the changes were committed."
+ },
+ "commit_id": {
+ "type": "string",
+ "description": "SHA id associated with the commit"
+ },
+ "branch": {
+ "type": "string",
+ "description": "Branch where changes were committed"
+ }
+ }
+ },
+ "CommiterType": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "Email id of the committer",
+ "nullable": true
+ },
+ "username": {
+ "type": "string",
+ "description": "Username of the committer",
+ "nullable": true
+ }
+ }
+ },
+ "AuthorType": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "Email id of the committer",
+ "nullable": true
+ },
+ "username": {
+ "type": "string",
+ "description": "Username of the committer",
+ "nullable": true
+ }
+ }
+ },
+ "ConnectionInput": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the connection.",
+ "nullable": true
+ },
+ "name_pattern": {
+ "type": "string",
+ "description": "A pattern to match case-insensitive name of the connection object. User `%` for a wildcard match.",
+ "nullable": true
+ },
+ "data_warehouse_objects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DataWarehouseObjectInput"
+ },
+ "description": "Filter options for databases, schemas, tables and columns.",
+ "nullable": true
+ }
+ }
+ },
+ "DataWarehouseObjectInput": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "type": "string",
+ "description": "Name of the database.",
+ "nullable": true
+ },
+ "schema": {
+ "type": "string",
+ "description": "Name of the schema within the database.",
+ "nullable": true
+ },
+ "table": {
+ "type": "string",
+ "description": "Name of the table within the schema.",
+ "nullable": true
+ },
+ "column": {
+ "type": "string",
+ "description": "Name of the column within the table.",
+ "nullable": true
+ }
+ }
+ },
+ "SortOptionInput": {
+ "type": "object",
+ "properties": {
+ "field_name": {
+ "type": "string",
+ "enum": [
+ "NAME",
+ "DISPLAY_NAME",
+ "AUTHOR",
+ "CREATED",
+ "MODIFIED",
+ "LAST_ACCESSED",
+ "SYNCED",
+ "VIEWS",
+ "USER_STATE",
+ "ROW_COUNT"
+ ],
+ "description": "Name of the field to apply the sort on.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "enum": ["ASC", "DESC"],
+ "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "nullable": true
+ }
+ }
+ },
+ "SearchConnectionResponse": {
+ "type": "object",
+ "required": ["id", "name", "data_warehouse_type"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique ID of the connection."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the connection."
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the connection.",
+ "nullable": true
+ },
+ "data_warehouse_type": {
+ "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"
+ ],
+ "description": "Type of data warehouse."
+ },
+ "data_warehouse_objects": {
+ "$ref": "#/components/schemas/DataWarehouseObjects",
+ "description": "List of Data warehouse objects",
+ "nullable": true
+ },
+ "details": {
+ "type": "object",
+ "description": "Details of the connection.",
+ "nullable": true
+ }
+ }
+ },
+ "DataWarehouseObjects": {
+ "type": "object",
+ "required": ["databases"],
+ "properties": {
+ "databases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Database"
+ },
+ "description": "Databases of the connection."
+ }
+ }
+ },
+ "Database": {
+ "type": "object",
+ "required": ["name"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the database."
+ },
+ "schemas": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SchemaObject"
+ },
+ "description": "Schemas of the database.",
+ "nullable": true
+ },
+ "auto_created": {
+ "type": "boolean",
+ "description": "Determines if the object is auto created.",
+ "nullable": true
+ }
+ }
+ },
+ "SchemaObject": {
+ "type": "object",
+ "required": ["name"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the schema."
+ },
+ "tables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Table"
+ },
+ "description": "Tables in the schema.",
+ "nullable": true
+ }
+ }
+ },
+ "Table": {
+ "type": "object",
+ "required": ["name"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the table."
+ },
+ "columns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Column"
+ },
+ "description": "Columns of the table.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "description": "Type of table. Either view or table",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the table",
+ "nullable": true
+ },
+ "selected": {
+ "type": "boolean",
+ "description": "Determines if the table is selected",
+ "nullable": true
+ },
+ "linked": {
+ "type": "boolean",
+ "description": "Determines if the table is linked",
+ "nullable": true
+ },
+ "relationships": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "description": "List of relationships for the table",
+ "nullable": true
+ }
+ }
+ },
+ "Column": {
+ "type": "object",
+ "required": ["name", "data_type"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the column"
+ },
+ "data_type": {
+ "type": "string",
+ "description": "Data type of the column"
+ },
+ "is_aggregate": {
+ "type": "string",
+ "description": "Determines if the column schema is an aggregate",
+ "nullable": true
+ },
+ "can_import": {
+ "type": "boolean",
+ "description": "Determines if the column schema can be imported",
+ "nullable": true
+ },
+ "selected": {
+ "type": "boolean",
+ "description": "Determines if the table is selected",
+ "nullable": true
+ },
+ "is_linked_active": {
+ "type": "boolean",
+ "description": "Determines if the table is linked",
+ "nullable": true
+ }
+ }
+ },
+ "SearchRoleResponse": {
+ "type": "object",
+ "required": ["id", "name", "description", "privileges"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique Id of the role."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the role"
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the role"
+ },
+ "groups_assigned_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "number of groups assigned with this role",
+ "nullable": true
+ },
+ "orgs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GenericInfo"
+ },
+ "description": "Orgs in which role exists.",
+ "nullable": true
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GenericInfo"
+ },
+ "description": "Details of groups assigned with this role",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "description": "Privileges granted to the role."
+ },
+ "permission": {
+ "type": "string",
+ "enum": ["READ_ONLY", "MODIFY", "NO_ACCESS"],
+ "description": "Permission details of the Role",
+ "nullable": true
+ },
+ "author_id": {
+ "type": "string",
+ "description": "Unique identifier of author of the role.",
+ "nullable": true
+ },
+ "modifier_id": {
+ "type": "string",
+ "description": "Unique identifier of modifier of the role.",
+ "nullable": true
+ },
+ "creation_time_in_millis": {
+ "type": "object",
+ "description": "Creation time of the role in milliseconds.",
+ "nullable": true
+ },
+ "modification_time_in_millis": {
+ "type": "object",
+ "description": "Last modified time of the role in milliseconds.",
+ "nullable": true
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "Indicates whether the role is deleted.",
+ "nullable": true
+ },
+ "deprecated": {
+ "type": "boolean",
+ "description": "Indicates whether the role is deprecated.",
+ "nullable": true
+ },
+ "external": {
+ "type": "boolean",
+ "description": "Indicates whether the role is external.",
+ "nullable": true
+ },
+ "hidden": {
+ "type": "boolean",
+ "description": "Indicates whether the role is hidden.",
+ "nullable": true
+ },
+ "shared_via_connection": {
+ "type": "boolean",
+ "description": "Indicates whether the role is shared via connection",
+ "nullable": true
+ }
+ },
+ "description": "Response for search role api should handle hidden privileges as well."
+ },
+ "Default_Action_Config_Search_Input": {
+ "type": "object",
+ "properties": {
+ "visibility": {
+ "type": "boolean",
+ "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.",
+ "nullable": true
+ }
+ },
+ "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
+ },
+ "ResponseCustomAction": {
+ "type": "object",
+ "required": ["action_details", "default_action_config", "id", "name"],
+ "properties": {
+ "action_details": {
+ "$ref": "#/components/schemas/Action_details",
+ "description": "`Type` and configuration data for custom actions"
+ },
+ "default_action_config": {
+ "$ref": "#/components/schemas/Default_action_config",
+ "description": "Default custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique Id of the custom action."
+ },
+ "metadata_association": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Metadata_Association_Item"
+ },
+ "description": "Metadata objects to assign the the custom action to.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Unique name of the custom action."
+ },
+ "user_groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Object_ID_And_Name"
+ },
+ "description": "Unique ID or name of the User groups which are associated with the custom action.",
+ "nullable": true
+ }
+ },
+ "description": "Custom action details"
+ },
+ "Action_details": {
+ "type": "object",
+ "properties": {
+ "CALLBACK": {
+ "$ref": "#/components/schemas/CALLBACK",
+ "description": "CALLBACK Custom Action Type",
+ "nullable": true
+ },
+ "URL": {
+ "$ref": "#/components/schemas/URL",
+ "description": "URL Custom Action Type",
+ "nullable": true
+ }
+ },
+ "description": "Type and Configuration for Custom Actions"
+ },
+ "CALLBACK": {
+ "type": "object",
+ "properties": {
+ "reference": {
+ "type": "string",
+ "description": "Reference name of the SDK. By default, the value will be set to action name.",
+ "nullable": true
+ }
+ },
+ "description": "CALLBACK Custom Action Type"
+ },
+ "URL": {
+ "type": "object",
+ "required": ["url"],
+ "properties": {
+ "authentication": {
+ "$ref": "#/components/schemas/Authentication",
+ "description": "Authorization type for the custom action.",
+ "nullable": true
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParametersListItem"
+ },
+ "description": "Query parameters for url.",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "description": "Request Url for the Custom action."
+ },
+ "reference": {
+ "type": "string",
+ "description": "Reference name of the SDK. By default, the value will be set to action name.",
+ "nullable": true
+ }
+ },
+ "description": "URL Custom Action Type"
+ },
+ "Authentication": {
+ "type": "object",
+ "properties": {
+ "API_Key": {
+ "$ref": "#/components/schemas/API_Key",
+ "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.",
+ "nullable": true
+ },
+ "Basic_Auth": {
+ "$ref": "#/components/schemas/Basic_Auth",
+ "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.",
+ "nullable": true
+ },
+ "Bearer_Token": {
+ "type": "string",
+ "description": "Bearer tokens enable requests to authenticate using an access key.",
+ "nullable": true
+ },
+ "No_Auth": {
+ "type": "string",
+ "description": "No authorization. If your request doesn't require authorization.",
+ "nullable": true
+ }
+ },
+ "description": "Authorization type for the custom action."
+ },
+ "API_Key": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Enter your key name",
+ "nullable": true
+ },
+ "value": {
+ "type": "string",
+ "description": "Enter you key value",
+ "nullable": true
+ }
+ },
+ "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters."
+ },
+ "Basic_Auth": {
+ "type": "object",
+ "properties": {
+ "password": {
+ "type": "string",
+ "description": "Password for the basic authentication",
+ "nullable": true
+ },
+ "username": {
+ "type": "string",
+ "description": "Username for the basic authentication",
+ "nullable": true
+ }
+ },
+ "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request."
+ },
+ "ParametersListItem": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key for the url query parameter",
+ "nullable": true
+ },
+ "value": {
+ "type": "string",
+ "description": "Value for the url query parameter",
+ "nullable": true
+ }
+ }
+ },
+ "Default_action_config": {
+ "type": "object",
+ "properties": {
+ "visibility": {
+ "type": "boolean",
+ "description": "Custom action is available on all visualizations. Earlier , the naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.",
+ "nullable": true
+ }
+ },
+ "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
+ },
+ "Metadata_Association_Item": {
+ "type": "object",
+ "required": ["action_config", "identifier", "type"],
+ "properties": {
+ "action_config": {
+ "$ref": "#/components/schemas/Action_config",
+ "description": "Specify that the association is enabled for the metadata object"
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata."
+ },
+ "type": {
+ "type": "string",
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier."
+ }
+ }
+ },
+ "Action_config": {
+ "type": "object",
+ "properties": {
+ "position": {
+ "type": "string",
+ "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.",
+ "nullable": true
+ },
+ "visibility": {
+ "type": "boolean",
+ "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled",
+ "nullable": true
+ }
+ },
+ "description": "Specify that the association is enabled for the metadata object"
+ },
+ "CustomActionMetadataTypeInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["VISUALIZATION", "ANSWER", "WORKSHEET"],
+ "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object."
+ }
+ },
+ "description": "MetadataType InputType used in Custom Action API's"
+ },
+ "MetadataContext": {
+ "type": "object",
+ "properties": {
+ "data_source_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of data_source_identifiers to provide context for breaking down user query into analytical queries that can be run on them.",
+ "nullable": true
+ },
+ "answer_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of answer unique identifiers (GUIDs) whose data will be used to guide the response.",
+ "nullable": true
+ },
+ "conversation_identifier": {
+ "type": "string",
+ "description": "Unique identifier to denote current conversation.",
+ "nullable": true
+ },
+ "liveboard_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of liveboard unique identifiers (GUIDs) whose data will be used to guide the response.",
+ "nullable": true
+ }
+ }
+ },
+ "AIContext": {
+ "type": "object",
+ "properties": {
+ "instructions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "User specific text instructions sent to AI system for processing the query.",
+ "nullable": true
+ },
+ "content": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "User provided content like text data, csv data as a string message to provide context & potentially improve the quality of the response.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_GetRelevantQuestionsResponse": {
+ "type": "object",
+ "properties": {
+ "relevant_questions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/eureka_RelevantQuestion"
+ },
+ "description": "List of relevant questions that can be run on their respective data sources.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_RelevantQuestion": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "type": "string",
+ "description": "NL query that can be run using spotter aka natural language search to get an AI generated answer.",
+ "nullable": true
+ },
+ "data_source_identifier": {
+ "type": "string",
+ "description": "Unique identifier of the data source on which this query can be run on.",
+ "nullable": true
+ },
+ "data_source_name": {
+ "type": "string",
+ "description": "Display name of the data source on which this query can be run on.",
+ "nullable": true
+ }
+ }
+ },
+ "Input_eureka_NLSRequest": {
+ "type": "object",
+ "properties": {
+ "agentVersion": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Cluster version like 10.4.0.cl, 10.5.0.cl, so on.",
+ "nullable": true
+ },
+ "bypassCache": {
+ "type": "boolean",
+ "description": "If true, results are not returned from cache & calculated every time. Can incur high costs & latency.",
+ "nullable": true
+ },
+ "instructions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "User specific instructions for processing the @query.",
+ "nullable": true
+ },
+ "query": {
+ "type": "string",
+ "description": "User query which is a topical/goal oriented question that needs to be broken down into smaller simple analytical questions.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_DecomposeQueryResponse": {
+ "type": "object",
+ "properties": {
+ "decomposedQueryResponse": {
+ "$ref": "#/components/schemas/eureka_LLMDecomposeQueryResponse",
+ "description": "Decomposed query response for a topical/goal oriented question that contains broken down analytical questions.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_LLMDecomposeQueryResponse": {
+ "type": "object",
+ "properties": {
+ "decomposedQueries": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/eureka_LLMSuggestedQuery"
+ },
+ "description": "List of analytical questions that can be run on their respective worksheet/data sources.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_LLMSuggestedQuery": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "type": "string",
+ "description": "NL query that can be run using spotter aka natural language search to get an AI generated answer.",
+ "nullable": true
+ },
+ "worksheetId": {
+ "type": "string",
+ "description": "Unique identifier of the worksheet on which this query can be run on.",
+ "nullable": true
+ },
+ "worksheetName": {
+ "type": "string",
+ "description": "Display name of the worksheet on which this query can be run on.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_DataSourceSuggestionResponse": {
+ "type": "object",
+ "properties": {
+ "data_sources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DataSource"
+ },
+ "description": "List of data sources suggested.",
+ "nullable": true
+ }
+ }
+ },
+ "DataSource": {
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "type": "number",
+ "format": "float",
+ "description": "Confidence score for the data source suggestion.",
+ "nullable": true
+ },
+ "details": {
+ "$ref": "#/components/schemas/EntityHeader",
+ "description": "Details of the data source.",
+ "nullable": true
+ },
+ "reasoning": {
+ "type": "string",
+ "description": "LLM reasoning for the data source.",
+ "nullable": true
+ }
+ }
+ },
+ "EntityHeader": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "Description of the data source.",
+ "nullable": true
+ },
+ "data_source_name": {
+ "type": "string",
+ "description": "Display name of the data source.",
+ "nullable": true
+ },
+ "data_source_identifier": {
+ "type": "string",
+ "description": "Unique identifier of the data source.",
+ "nullable": true
+ }
+ }
+ },
+ "eureka_GetNLInstructionsResponse": {
+ "type": "object",
+ "required": ["nl_instructions_info"],
+ "properties": {
+ "nl_instructions_info": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NLInstructionsInfo"
+ },
+ "description": "List of NL instructions with their scopes."
+ }
+ }
+ },
+ "NLInstructionsInfo": {
+ "type": "object",
+ "required": ["instructions", "scope"],
+ "properties": {
+ "instructions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "User instructions for natural language processing."
+ },
+ "scope": {
+ "type": "string",
+ "enum": ["GLOBAL"],
+ "description": "Scope of the instruction."
+ }
+ }
+ },
+ "RiseGQLArgWrapper": {
+ "type": "object",
+ "required": ["name", "type"],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "VariableDetailInput": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the variable",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "CONNECTION_PROPERTY",
+ "TABLE_MAPPING",
+ "CONNECTION_PROPERTY_PER_PRINCIPAL",
+ "FORMULA_VARIABLE"
+ ],
+ "description": "Type of variable",
+ "nullable": true
+ },
+ "name_pattern": {
+ "type": "string",
+ "description": "A pattern to match case-insensitive name of the variable. User % for a wildcard match",
+ "nullable": true
+ }
+ },
+ "description": "Input for variable details in search"
+ },
+ "ValueScopeInput": {
+ "type": "object",
+ "properties": {
+ "org_identifier": {
+ "type": "string",
+ "description": "The unique name of the org",
+ "nullable": true
+ },
+ "principal_type": {
+ "type": "string",
+ "enum": ["USER", "USER_GROUP"],
+ "description": "Type of principal to filter by. Use USER to filter values assigned to specific users, or USER_GROUP to filter values assigned to groups.",
+ "nullable": true
+ },
+ "principal_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the principal",
+ "nullable": true
+ },
+ "model_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the model to filter by. Applicable only for FORMULA_VARIABLE type.",
+ "nullable": true
+ }
+ },
+ "description": "Input for filtering variable values by scope in search operations"
+ },
+ "Variable": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the variable"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the variable"
+ },
+ "variable_type": {
+ "type": "string",
+ "enum": [
+ "CONNECTION_PROPERTY",
+ "TABLE_MAPPING",
+ "CONNECTION_PROPERTY_PER_PRINCIPAL",
+ "FORMULA_VARIABLE"
+ ],
+ "description": "Type of the variable",
+ "nullable": true
+ },
+ "sensitive": {
+ "type": "boolean",
+ "description": "If the variable is sensitive",
+ "nullable": true
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/VariableValue"
+ },
+ "description": "Values of the variable",
+ "nullable": true
+ }
+ },
+ "description": "Variable object"
+ },
+ "VariableValue": {
+ "type": "object",
+ "required": ["org_identifier"],
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The value of the variable",
+ "nullable": true
+ },
+ "value_list": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The value of the variable if it is a list type",
+ "nullable": true
+ },
+ "org_identifier": {
+ "type": "string",
+ "description": "The unique name of the org"
+ },
+ "principal_type": {
+ "type": "string",
+ "enum": ["USER", "USER_GROUP"],
+ "description": "Type of principal to which this value applies. Use USER to assign the value to a specific user, or USER_GROUP to assign it to a group.",
+ "nullable": true
+ },
+ "principal_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the principal",
+ "nullable": true
+ },
+ "model_identifier": {
+ "type": "string",
+ "description": "Version: 26.3.0.cl or later Beta
\n\nUnique ID of the model
Beta Version: 26.3.0.cl or later",
+ "nullable": true
+ },
+ "priority": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The priority assigned to this value. If there are 2 matching values, the one with the higher priority will be picked.",
+ "nullable": true
+ }
+ }
+ },
+ "SortOption": {
+ "type": "object",
+ "properties": {
+ "field_name": {
+ "type": "string",
+ "enum": [
+ "DEFAULT",
+ "NAME",
+ "DISPLAY_NAME",
+ "AUTHOR",
+ "CREATED",
+ "MODIFIED"
+ ],
+ "default": "DEFAULT",
+ "description": "Name of the field to apply the sort on.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "enum": ["ASC", "DESC"],
+ "default": "ASC",
+ "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "nullable": true
+ }
+ }
+ },
+ "CalendarResponse": {
+ "type": "object",
+ "properties": {
+ "calendar_name": {
+ "type": "string",
+ "description": "Name of the calendar",
+ "nullable": true
+ },
+ "connection_name": {
+ "type": "string",
+ "description": "Name of the connection",
+ "nullable": true
+ },
+ "data_warehouse_type": {
+ "type": "string",
+ "description": "Type of data warehouse",
+ "nullable": true
+ },
+ "modification_time_in_millis": {
+ "type": "string",
+ "description": "Last modification time in milliseconds",
+ "nullable": true
+ },
+ "author_name": {
+ "type": "string",
+ "description": "Name of the author who created the calendar",
+ "nullable": true
+ },
+ "connection_id": {
+ "type": "string",
+ "description": "Unique ID of the connection",
+ "nullable": true
+ },
+ "calendar_id": {
+ "type": "string",
+ "description": "Unique ID of the calendar",
+ "nullable": true
+ }
+ }
+ },
+ "ConnectionConfigurationResponse": {
+ "type": "object",
+ "properties": {
+ "configuration_identifier": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "configuration": {
+ "type": "object",
+ "nullable": true
+ },
+ "policy_principals": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserPrincipal"
+ },
+ "nullable": true
+ },
+ "policy_processes": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["SAGE_INDEXING", "ROW_COUNT_STATS"]
+ },
+ "nullable": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "data_warehouse_type": {
+ "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"
+ ],
+ "nullable": true
+ },
+ "policy_type": {
+ "type": "string",
+ "enum": ["NO_POLICY", "PRINCIPALS", "PROCESSES"],
+ "nullable": true
+ },
+ "same_as_parent": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "policy_process_options": {
+ "$ref": "#/components/schemas/PolicyProcessOptions",
+ "nullable": true
+ }
+ }
+ },
+ "UserPrincipal": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "PolicyProcessOptions": {
+ "type": "object",
+ "properties": {
+ "impersonate_user": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "WebhookSortOptionsInput": {
+ "type": "object",
+ "properties": {
+ "field_name": {
+ "type": "string",
+ "enum": ["CREATED", "MODIFIED", "NAME"],
+ "default": "CREATED",
+ "description": "Name of the field to apply the sort on.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "enum": ["ASC", "DESC"],
+ "default": "DESC",
+ "description": "Sort order: ASC (Ascending) or DESC (Descending).",
+ "nullable": true
+ }
+ }
+ },
+ "WebhookSearchResponse": {
+ "type": "object",
+ "required": ["webhooks", "pagination"],
+ "properties": {
+ "webhooks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WebhookResponse"
+ },
+ "description": "List of webhook configurations matching the search criteria."
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/WebhookPagination",
+ "description": "Pagination information."
+ }
+ }
+ },
+ "WebhookResponse": {
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "url",
+ "events",
+ "creation_time_in_millis",
+ "modification_time_in_millis"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the webhook configuration."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the webhook configuration."
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the webhook configuration.",
+ "nullable": true
+ },
+ "org": {
+ "$ref": "#/components/schemas/WebhookOrg",
+ "description": "Org details.",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "description": "The webhook endpoint URL."
+ },
+ "url_params": {
+ "type": "object",
+ "description": "Additional URL parameters as key-value pairs.",
+ "nullable": true
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["LIVEBOARD_SCHEDULE"]
+ },
+ "description": "List of events this webhook subscribes to."
+ },
+ "authentication": {
+ "$ref": "#/components/schemas/WebhookAuthentication",
+ "description": "Redacted authorization configuration for the webhook.",
+ "nullable": true
+ },
+ "signature_verification": {
+ "$ref": "#/components/schemas/WebhookSignatureVerification",
+ "description": "Redacted configuration for webhook signature verification.",
+ "nullable": true
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Creation time of the webhook configuration in milliseconds."
+ },
+ "modification_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Last modified time of the webhook configuration in milliseconds."
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/WebhookUser",
+ "description": "User who created the webhook.",
+ "nullable": true
+ },
+ "last_modified_by": {
+ "$ref": "#/components/schemas/WebhookUser",
+ "description": "User who last modified the webhook.",
+ "nullable": true
+ },
+ "storage_destination": {
+ "$ref": "#/components/schemas/StorageDestination",
+ "description": "Storage destination configuration for webhook payload delivery.",
+ "nullable": true
+ }
+ }
+ },
+ "WebhookOrg": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the org."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the org."
+ }
+ }
+ },
+ "WebhookAuthentication": {
+ "type": "object",
+ "properties": {
+ "API_KEY": {
+ "$ref": "#/components/schemas/WebhookAuthApiKey",
+ "description": "Redacted API key authentication configuration.",
+ "nullable": true
+ },
+ "BASIC_AUTH": {
+ "$ref": "#/components/schemas/WebhookAuthBasicAuth",
+ "description": "Redacted Basic authentication configuration.",
+ "nullable": true
+ },
+ "BEARER_TOKEN": {
+ "type": "string",
+ "description": "Redacted Bearer token authentication configuration.",
+ "nullable": true
+ },
+ "OAUTH2": {
+ "$ref": "#/components/schemas/WebhookAuthOAuth2",
+ "description": "Redacted OAuth2 authentication configuration.",
+ "nullable": true
+ }
+ }
+ },
+ "WebhookAuthApiKey": {
+ "type": "object",
+ "required": ["key", "value"],
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "The header or query parameter name for the API key."
+ },
+ "value": {
+ "type": "string",
+ "description": "The API key value."
+ }
+ }
+ },
+ "WebhookAuthBasicAuth": {
+ "type": "object",
+ "required": ["username", "password"],
+ "properties": {
+ "username": {
+ "type": "string",
+ "description": "Username for basic authentication."
+ },
+ "password": {
+ "type": "string",
+ "description": "Password for basic authentication."
+ }
+ }
+ },
+ "WebhookAuthOAuth2": {
+ "type": "object",
+ "required": ["authorization_url", "client_id", "client_secret"],
+ "properties": {
+ "authorization_url": {
+ "type": "string",
+ "description": "OAuth2 authorization server URL."
+ },
+ "client_id": {
+ "type": "string",
+ "description": "OAuth2 client identifier."
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "OAuth2 client secret key."
+ }
+ }
+ },
+ "WebhookSignatureVerification": {
+ "type": "object",
+ "required": ["type", "header", "algorithm", "secret"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["HMAC_SHA256"],
+ "description": "Signature verification method type."
+ },
+ "header": {
+ "type": "string",
+ "description": "HTTP header where the signature is sent."
+ },
+ "algorithm": {
+ "type": "string",
+ "enum": ["SHA256"],
+ "description": "Hash algorithm used for signature verification."
+ },
+ "secret": {
+ "type": "string",
+ "description": "Shared secret used for HMAC signature generation."
+ }
+ }
+ },
+ "WebhookUser": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the user."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the user."
+ }
+ }
+ },
+ "StorageDestination": {
+ "type": "object",
+ "required": ["storage_type", "storage_config"],
+ "properties": {
+ "storage_type": {
+ "type": "string",
+ "enum": ["AWS_S3"],
+ "description": "Type of storage destination (e.g., AWS_S3)."
+ },
+ "storage_config": {
+ "$ref": "#/components/schemas/StorageConfig",
+ "description": "Storage-specific configuration settings."
+ }
+ },
+ "description": "Storage destination configuration for webhook payload delivery."
+ },
+ "StorageConfig": {
+ "type": "object",
+ "properties": {
+ "aws_s3_config": {
+ "$ref": "#/components/schemas/AwsS3Config",
+ "description": "AWS S3 storage configuration.",
+ "nullable": true
+ }
+ },
+ "description": "Storage configuration containing provider-specific settings."
+ },
+ "AwsS3Config": {
+ "type": "object",
+ "required": ["bucket_name", "region", "role_arn"],
+ "properties": {
+ "bucket_name": {
+ "type": "string",
+ "description": "Name of the S3 bucket where webhook payloads are stored."
+ },
+ "region": {
+ "type": "string",
+ "description": "AWS region where the S3 bucket is located."
+ },
+ "role_arn": {
+ "type": "string",
+ "description": "ARN of the IAM role used for S3 access."
+ },
+ "external_id": {
+ "type": "string",
+ "description": "External ID for secure cross-account role assumption.",
+ "nullable": true
+ },
+ "path_prefix": {
+ "type": "string",
+ "description": "Path prefix for organizing objects within the bucket.",
+ "nullable": true
+ }
+ },
+ "description": "AWS S3 storage configuration details."
+ },
+ "WebhookPagination": {
+ "type": "object",
+ "required": ["record_offset", "record_size", "total_count", "has_more"],
+ "properties": {
+ "record_offset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The starting record number from where the records are included."
+ },
+ "record_size": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of records included in the response."
+ },
+ "total_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of webhook configurations available."
+ },
+ "has_more": {
+ "type": "boolean",
+ "description": "Indicates whether more records are available beyond the current response."
+ }
+ }
+ },
+ "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}"
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LOGICAL_TABLE"],
+ "nullable": true
+ }
+ },
+ "description": "Metadata objects."
+ },
+ "User_Parameter_Options": {
+ "type": "object",
+ "properties": {
+ "objects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User_Object"
+ },
+ "nullable": true
+ },
+ "runtime_filters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Runtime_Filters"
+ },
+ "description": "Objects to apply the User_Runtime_Filters.\n\nExamples to set the `runtime_filters` :\n```json\n{ \"column_name\": \"Color\", \"operator\": \"EQ\", \"values\": [\"red\"], \"persist\": false }\n```",
+ "nullable": true
+ },
+ "runtime_sorts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Runtime_Sorts"
+ },
+ "description": "Objects to apply the User_Runtime_Sorts.\n\nExamples to set the `runtime_sorts` :\n```json\n{ \"column_name\": \"Color\", \"order\": \"ASC\", \"persist\": false }\n```",
+ "nullable": true
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Runtime_Parameters"
+ },
+ "description": "Objects to apply the Runtime_Parameters.\n\nExamples to set the `parameters` :\n```json\n{ \"name\": \"Color\", \"values\": [\"Blue\"], \"persist\": false }\n```",
+ "nullable": true
+ }
+ },
+ "description": "Define 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).\n"
+ },
+ "User_Object": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["LOGICAL_TABLE"],
+ "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n \n\n Specify the object type as `LOGICAL_TABLE`.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique name/id of the object."
+ }
+ },
+ "description": "Objects to apply the User_Object."
+ },
+ "Runtime_Filters": {
+ "type": "object",
+ "required": ["column_name", "values", "operator"],
+ "properties": {
+ "column_name": {
+ "type": "string",
+ "description": "The column name to apply filter."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Value of the filters."
+ },
+ "operator": {
+ "type": "string",
+ "enum": [
+ "EQ",
+ "NE",
+ "LT",
+ "LE",
+ "GT",
+ "GE",
+ "IN",
+ "BW",
+ "CONTAINS",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "BW_INC",
+ "BW_INC_MIN",
+ "BW_INC_MAX",
+ "LIKE",
+ "NOT_IN"
+ ],
+ "description": "Operator value. Example: EQ"
+ },
+ "persist": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 9.12.0.cl or later
\n\nFlag to persist the runtime filters.
Version: 9.12.0.cl or later",
+ "nullable": true
+ },
+ "objects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User_Object"
+ },
+ "description": "Object to apply the runtime filter.",
+ "nullable": true
+ }
+ },
+ "description": "Objects to apply the Runtime_Filters."
+ },
+ "Runtime_Sorts": {
+ "type": "object",
+ "properties": {
+ "column_name": {
+ "type": "string",
+ "description": "The column name to apply filter.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "enum": ["ASC", "DESC"],
+ "description": "Order for the sort.",
+ "nullable": true
+ },
+ "persist": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 9.12.0.cl or later
\n\nFlag to persist the runtime sorts.
Version: 9.12.0.cl or later",
+ "nullable": true
+ },
+ "objects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User_Object"
+ },
+ "description": "Object to apply the runtime sort.",
+ "nullable": true
+ }
+ },
+ "description": "Objects to apply the Runtime_Sorts."
+ },
+ "Runtime_Parameters": {
+ "type": "object",
+ "required": ["name", "values"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the parameter."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The array of values."
+ },
+ "persist": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 9.12.0.cl or later
\n\nFlag to persist the parameters.
Version: 9.12.0.cl or later",
+ "nullable": true
+ },
+ "objects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User_Object"
+ },
+ "description": "Object to apply the runtime parameter.",
+ "nullable": true
+ }
+ },
+ "description": "Objects to apply the Runtime_Parameters."
+ },
+ "Token": {
+ "type": "object",
+ "required": [
+ "token",
+ "creation_time_in_millis",
+ "expiration_time_in_millis",
+ "scope",
+ "valid_for_user_id",
+ "valid_for_username"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "Bearer auth token."
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token creation time in milliseconds."
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token expiration time in milliseconds."
+ },
+ "scope": {
+ "$ref": "#/components/schemas/Scope",
+ "description": "Token access scope details"
+ },
+ "valid_for_user_id": {
+ "type": "string",
+ "description": "Username to whom the token is issued."
+ },
+ "valid_for_username": {
+ "type": "string",
+ "description": "Unique identifier of the user to whom the token is issued."
+ }
+ }
+ },
+ "Scope": {
+ "type": "object",
+ "required": ["access_type"],
+ "properties": {
+ "access_type": {
+ "type": "string",
+ "description": "Object access scope type."
+ },
+ "org_id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique identifier of the metadata.",
+ "nullable": true
+ },
+ "metadata_id": {
+ "type": "string",
+ "description": "Unique identifier of the Org.",
+ "nullable": true
+ }
+ }
+ },
+ "JWT_User_Options_Full": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/JWT_Parameter"
+ },
+ "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.*"
+ },
+ "TokenValidationResponse": {
+ "type": "object",
+ "required": [
+ "creation_time_in_millis",
+ "expiration_time_in_millis",
+ "scope",
+ "valid_for_user_id",
+ "token_type"
+ ],
+ "properties": {
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token creation time in milliseconds."
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token expiration time in milliseconds."
+ },
+ "scope": {
+ "$ref": "#/components/schemas/Scope",
+ "description": "Token access scope details"
+ },
+ "valid_for_user_id": {
+ "type": "string",
+ "description": "Username to whom the token is issued."
+ },
+ "token_type": {
+ "type": "string",
+ "description": "Type of token."
+ }
+ }
+ },
+ "FilterRules": {
+ "type": "object",
+ "required": ["column_name", "operator", "values"],
+ "properties": {
+ "column_name": {
+ "type": "string",
+ "description": "The name of the column to apply the filter on."
+ },
+ "operator": {
+ "type": "string",
+ "enum": [
+ "EQ",
+ "NE",
+ "LT",
+ "LE",
+ "GT",
+ "GE",
+ "IN",
+ "BW",
+ "CONTAINS",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "BW_INC",
+ "BW_INC_MIN",
+ "BW_INC_MAX",
+ "LIKE",
+ "NOT_IN"
+ ],
+ "description": "The operator to use for filtering. Example: EQ (equals), GT(greater than), etc."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "description": "The values to filter on. To get all records, use TS_WILDCARD_ALL as values."
+ }
+ },
+ "description": "Filter Rules to be applied on Objects."
+ },
+ "ParameterValues": {
+ "type": "object",
+ "required": ["name", "values"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the column to apply the filter on."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "description": "The values to filter on. Only single value is supported currently."
+ }
+ },
+ "description": "Filter Rules to be applied on Objects."
+ },
+ "VariableValues": {
+ "type": "object",
+ "required": ["name", "values"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the existing formula variable."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "description": "The values to filter on."
+ }
+ },
+ "description": "Variable values."
+ },
+ "TokenAccessScopeObject": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["LOGICAL_TABLE"],
+ "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n \n\n Specify the object type as `LOGICAL_TABLE`.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique name/id of the object."
+ }
+ },
+ "description": "Objects on which the filter rules and parameters values should be applied to"
+ },
+ "Group_Object": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "description": "Groups objects."
+ },
+ "AccessToken": {
+ "type": "object",
+ "required": [
+ "token",
+ "org",
+ "user",
+ "creation_time_in_millis",
+ "expiration_time_in_millis"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "GUID of the auth token.",
+ "nullable": true
+ },
+ "token": {
+ "type": "string",
+ "description": "Bearer auth token."
+ },
+ "org": {
+ "$ref": "#/components/schemas/OrgInfo",
+ "description": "Org information for which the token is generated."
+ },
+ "user": {
+ "$ref": "#/components/schemas/UserInfo",
+ "description": "User information for which the token is generated."
+ },
+ "creation_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token creation time in milliseconds."
+ },
+ "expiration_time_in_millis": {
+ "type": "number",
+ "format": "float",
+ "description": "Token expiration time in milliseconds."
+ }
+ }
+ },
+ "OrgInfo": {
+ "type": "object",
+ "required": ["id"],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Id."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name.",
+ "nullable": true
+ }
+ }
+ },
+ "UserInfo": {
+ "type": "object",
+ "required": ["id"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Id."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name.",
+ "nullable": true
+ }
+ }
+ },
+ "ResponseActivationURL": {
+ "type": "object",
+ "properties": {
+ "activation_link": {
+ "type": "string",
+ "description": "Activation link to activate the user.",
+ "nullable": true
+ }
+ },
+ "description": "The object representation with activation link."
+ },
+ "ImportUser": {
+ "type": "object",
+ "required": ["user_identifier", "display_name"],
+ "properties": {
+ "user_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the user."
+ },
+ "display_name": {
+ "type": "string",
+ "description": "Display name of the user."
+ },
+ "password": {
+ "type": "string",
+ "description": "Password of the user.",
+ "nullable": true
+ },
+ "account_type": {
+ "type": "string",
+ "enum": [
+ "LOCAL_USER",
+ "LDAP_USER",
+ "SAML_USER",
+ "OIDC_USER",
+ "REMOTE_USER"
+ ],
+ "default": "LOCAL_USER",
+ "description": "Type of the user account.",
+ "nullable": true
+ },
+ "account_status": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "INACTIVE",
+ "EXPIRED",
+ "LOCKED",
+ "PENDING",
+ "SUSPENDED"
+ ],
+ "default": "ACTIVE",
+ "description": "Status of the user account.",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "Email address of the user.",
+ "nullable": true
+ },
+ "org_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "ID or name of the Orgs to which the user belongs.",
+ "nullable": true
+ },
+ "group_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "ID or name of the groups to which the user belongs.",
+ "nullable": true
+ },
+ "visibility": {
+ "type": "string",
+ "enum": ["SHARABLE", "NON_SHARABLE"],
+ "description": "Visibility of the users. The SHARABLE property makes a user visible to other users and group, who can share objects with the user.",
+ "nullable": true
+ },
+ "notify_on_share": {
+ "type": "boolean",
+ "default": true,
+ "description": "Notify user when other users or groups share metadata objects",
+ "nullable": true
+ },
+ "show_onboarding_experience": {
+ "type": "boolean",
+ "description": "Show or hide the new user onboarding walkthroughs",
+ "nullable": true
+ },
+ "onboarding_experience_completed": {
+ "type": "boolean",
+ "description": "Revisit the new user onboarding walkthroughs",
+ "nullable": true
+ },
+ "home_liveboard_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the default Liveboard assigned to the user.",
+ "nullable": true
+ },
+ "favorite_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FavoriteMetadataInput"
+ },
+ "description": "Metadata objects to add to the user's favorites list.",
+ "nullable": true
+ },
+ "preferred_locale": {
+ "type": "string",
+ "description": "Locale for the user. When setting this value, do not set use_browser_language to true, otherwise the browser's language setting will take precedence and the preferred_locale value will be ignored.",
+ "nullable": true,
+ "enum": [
+ "en-CA",
+ "en-GB",
+ "en-US",
+ "de-DE",
+ "ja-JP",
+ "zh-CN",
+ "pt-BR",
+ "fr-FR",
+ "fr-CA",
+ "es-US",
+ "da-DK",
+ "es-ES",
+ "fi-FI",
+ "sv-SE",
+ "nb-NO",
+ "pt-PT",
+ "nl-NL",
+ "it-IT",
+ "ru-RU",
+ "en-IN",
+ "de-CH",
+ "en-NZ",
+ "es-MX",
+ "en-AU",
+ "zh-Hant",
+ "ko-KR",
+ "en-DE"
+ ]
+ },
+ "use_browser_language": {
+ "type": "boolean",
+ "description": "Version: 26.3.0.cl or later
\n\nFlag 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",
+ "nullable": true
+ }
+ }
+ },
+ "ImportUsersResponse": {
+ "type": "object",
+ "properties": {
+ "users_added": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ImportUserType"
+ },
+ "nullable": true
+ },
+ "users_updated": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ImportUserType"
+ },
+ "nullable": true
+ },
+ "users_deleted": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ImportUserType"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "ImportUserType": {
+ "type": "object",
+ "required": ["name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the user.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the user."
+ }
+ }
+ },
+ "EventChannelConfigInput": {
+ "type": "object",
+ "required": ["event_type", "channels"],
+ "properties": {
+ "event_type": {
+ "type": "string",
+ "enum": ["LIVEBOARD_SCHEDULE"],
+ "description": "Type of event for which communication channels are configured"
+ },
+ "channels": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["EMAIL", "WEBHOOK"]
+ },
+ "description": "Communication channels enabled for this event type. Empty array disables all channels for this event."
+ }
+ }
+ },
+ "OrgChannelConfigInput": {
+ "type": "object",
+ "required": ["org_identifier"],
+ "properties": {
+ "org_identifier": {
+ "type": "string",
+ "description": "Unique identifier or name of the org"
+ },
+ "operation": {
+ "type": "string",
+ "enum": ["REPLACE", "RESET"],
+ "default": "REPLACE",
+ "description": "Operation to perform. REPLACE: Update preferences (default). RESET: Remove org-specific configurations, causing fallback to cluster-level preferences.",
+ "nullable": true
+ },
+ "preferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventChannelConfigInput"
+ },
+ "description": "Event-specific configurations. Required for REPLACE operation.",
+ "nullable": true
+ },
+ "reset_events": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["LIVEBOARD_SCHEDULE"]
+ },
+ "description": "Event types to reset. Required for RESET operation. Org-specific configurations for these events will be removed, causing fallback to cluster-level preferences.",
+ "nullable": true
+ }
+ }
+ },
+ "SecuritySettingsClusterPreferencesInput": {
+ "type": "object",
+ "properties": {
+ "enable_partitioned_cookies": {
+ "type": "boolean",
+ "description": "Support embedded access when third-party cookies are blocked.",
+ "nullable": true
+ },
+ "cors_whitelisted_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed origins for CORS.",
+ "nullable": true
+ },
+ "csp_settings": {
+ "$ref": "#/components/schemas/CspSettingsInput",
+ "description": "CSP (Content Security Policy) settings.",
+ "nullable": true
+ },
+ "saml_redirect_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed redirect hosts for SAML login.",
+ "nullable": true
+ },
+ "non_embed_access": {
+ "$ref": "#/components/schemas/ClusterNonEmbedAccessInput",
+ "description": "Non-embed access configuration at cluster level.",
+ "nullable": true
+ }
+ },
+ "description": "Input for cluster-level security preferences configuration."
+ },
+ "CspSettingsInput": {
+ "type": "object",
+ "properties": {
+ "connect_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for connect-src directive.",
+ "nullable": true
+ },
+ "font_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for font-src directive.",
+ "nullable": true
+ },
+ "visual_embed_hosts": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed hosts for visual embed (frame-ancestors directive).",
+ "nullable": true
+ },
+ "iframe_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for frame-src directive.",
+ "nullable": true
+ },
+ "img_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for img-src directive.",
+ "nullable": true
+ },
+ "script_src_urls": {
+ "$ref": "#/components/schemas/ScriptSrcUrlsInput",
+ "description": "Script-src settings including URLs and enabled flag.",
+ "nullable": true
+ },
+ "style_src_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for style-src directive.",
+ "nullable": true
+ }
+ },
+ "description": "Input for CSP (Content Security Policy) settings."
+ },
+ "ScriptSrcUrlsInput": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether script-src customization is enabled.",
+ "nullable": true
+ },
+ "urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed URLs for script-src directive. Can only be set if enabled is true.",
+ "nullable": true
+ }
+ },
+ "description": "Input for script-src CSP settings."
+ },
+ "ClusterNonEmbedAccessInput": {
+ "type": "object",
+ "properties": {
+ "block_full_app_access": {
+ "type": "boolean",
+ "description": "Block full application access for non-embedded usage.",
+ "nullable": true
+ },
+ "groups_identifiers_with_access": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Group identifiers that are allowed non-embed full app access.\nCan only be set when orgs feature is disabled and block_full_app_access is true.",
+ "nullable": true
+ }
+ },
+ "description": "Input for cluster-level non-embed access configuration."
+ },
+ "SecuritySettingsOrgPreferencesInput": {
+ "type": "object",
+ "required": ["org_identifier"],
+ "properties": {
+ "org_identifier": {
+ "type": "string",
+ "description": "Unique identifier or name of the org"
+ },
+ "cors_whitelisted_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed origins for CORS for this org.",
+ "nullable": true
+ },
+ "non_embed_access": {
+ "$ref": "#/components/schemas/OrgNonEmbedAccessInput",
+ "description": "Non-embed access configuration for this org.",
+ "nullable": true
+ }
+ },
+ "description": "Input for org-level security preferences configuration.\nNote: cross-org operations are not supported currently."
+ },
+ "OrgNonEmbedAccessInput": {
+ "type": "object",
+ "properties": {
+ "block_full_app_access": {
+ "type": "boolean",
+ "description": "Block full application access for non-embedded usage.",
+ "nullable": true
+ },
+ "groups_identifiers_with_access": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Group identifiers that are allowed non-embed full app access. Can only be set if block_full_app_access is true.",
+ "nullable": true
+ }
+ },
+ "description": "Input for org-level non-embed access configuration."
+ },
+ "CommunicationChannelValidateResponse": {
+ "type": "object",
+ "required": ["channel_type", "channel_id", "event_type", "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."
+ },
+ "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
+ }
+ },
+ "description": "Validation detail result for a sub-step."
+ },
+ "TagMetadataTypeInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION"
+ ],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n 1. LIVEBOARD\n 2. ANSWERS\n 3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n 4. LOGICAL_COLUMN for a column of any data object such as tables, worksheets or views.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata."
+ }
+ }
+ },
+ "GroupsImportListInput": {
+ "type": "object",
+ "required": ["display_name", "group_identifier"],
+ "properties": {
+ "display_name": {
+ "type": "string",
+ "description": "Unique display name of the group."
+ },
+ "group_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the group."
+ },
+ "default_liveboard_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Unique ID of Liveboards that will be assigned as default Liveboards to the users in the group.",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the group.",
+ "nullable": true
+ },
+ "privileges": {
+ "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"
+ ]
+ },
+ "description": "Privileges that will be assigned to the group.",
+ "nullable": true
+ },
+ "sub_group_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of the sub-groups to add to the group.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP"],
+ "description": "Type of the group.",
+ "nullable": true
+ },
+ "user_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of the users to assign to the group.",
+ "nullable": true
+ },
+ "visibility": {
+ "type": "string",
+ "enum": ["SHARABLE", "NON_SHARABLE"],
+ "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects.",
+ "nullable": true
+ }
+ }
+ },
+ "ImportUserGroupsResponse": {
+ "type": "object",
+ "required": ["groups_added", "groups_deleted", "groups_updated"],
+ "properties": {
+ "groups_added": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "The groups which are added into the system."
+ },
+ "groups_deleted": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "The groups which are deleted from the system."
+ },
+ "groups_updated": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserGroup"
+ },
+ "description": "The groups which are updated in the system."
+ }
+ }
+ },
+ "Export_Options": {
+ "type": "object",
+ "properties": {
+ "include_obj_id_ref": {
+ "type": "boolean",
+ "default": false,
+ "description": "Boolean Flag to export Object ID of referenced object. This flag will work only after the Object ID feature has been enabled. Please contact support to enable the feature.",
+ "nullable": true
+ },
+ "include_guid": {
+ "type": "boolean",
+ "default": true,
+ "description": "Boolean flag to export guid 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
+ },
+ "include_obj_id": {
+ "type": "boolean",
+ "default": false,
+ "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
+ },
+ "export_with_associated_feedbacks": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 10.7.0.cl or later
\n\nBoolean flag indicating whether to export associated feedbacks of the object. This will only be respected when the object can have feedbacks.
Version: 10.7.0.cl or later",
+ "nullable": true
+ },
+ "export_column_security_rules": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 10.12.0.cl or later Beta
\n\nBoolean flag indicating whether to export column security rules of the object. This will only be respected when the object can have column security rules and export_associated is true.
Beta Version: 10.12.0.cl or later",
+ "nullable": true
+ },
+ "export_with_column_aliases": {
+ "type": "boolean",
+ "default": false,
+ "description": "Version: 10.13.0.cl or later Beta
\n\nBoolean flag indicating whether to export column aliases of the model. This will only be respected when the object can have column aliases.
Beta Version: 10.13.0.cl or later",
+ "nullable": true
+ }
+ },
+ "description": "Flags to specify additional options for export. This will only be active when UserDefinedId in TML is enabled."
+ },
+ "ResponseCopyObject": {
+ "type": "object",
+ "properties": {
+ "metadata_id": {
+ "type": "string",
+ "description": "The unique identifier of the object.",
+ "nullable": true
+ }
+ }
+ },
+ "ResponseWorksheetToModelConversion": {
+ "type": "object",
+ "required": [
+ "name",
+ "success_count",
+ "failure_count",
+ "incomplete_count",
+ "post_upgrade_failed_count",
+ "total_time_in_millis",
+ "successful_entities",
+ "failed_entities",
+ "incomplete_entities",
+ "post_upgrade_failed_entities"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "success_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets successfully converted to models."
+ },
+ "failure_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets that failed to convert."
+ },
+ "incomplete_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets that were incomplete during the conversion process."
+ },
+ "post_upgrade_failed_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of worksheets that failed after an upgrade during the conversion process."
+ },
+ "total_time_in_millis": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The total time taken to complete the conversion process in milliseconds."
+ },
+ "successful_entities": {
+ "$ref": "#/components/schemas/ResponseSuccessfulEntities",
+ "description": "List of worksheets successfully converted to models."
+ },
+ "failed_entities": {
+ "$ref": "#/components/schemas/ResponseFailedEntities",
+ "description": "List of worksheets that failed to convert."
+ },
+ "incomplete_entities": {
+ "$ref": "#/components/schemas/ResponseIncompleteEntities",
+ "description": "List of worksheets that were incomplete during the conversion."
+ },
+ "post_upgrade_failed_entities": {
+ "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntities",
+ "description": "List of worksheets that failed after an upgrade during the conversion process."
+ }
+ },
+ "description": "Name of the conversion process, which involves converting worksheets to models."
+ },
+ "ResponseSuccessfulEntities": {
+ "type": "object",
+ "required": ["data"],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseSuccessfulEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the successful entities, as they are inside a 'data' field in the response."
+ },
+ "ResponseSuccessfulEntity": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the worksheet."
+ }
+ },
+ "description": "Unique ID of the worksheet."
+ },
+ "ResponseFailedEntities": {
+ "type": "object",
+ "required": ["data"],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseFailedEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the failed entities, as they are inside a 'data' field in the response."
+ },
+ "ResponseFailedEntity": {
+ "type": "object",
+ "required": ["id", "name", "error"],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the worksheet that failed to convert."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error details related to the failed conversion."
+ }
+ },
+ "description": "Unique ID of the failed worksheet."
+ },
+ "ResponseIncompleteEntities": {
+ "type": "object",
+ "required": ["data"],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseIncompleteEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the incomplete entities, as they are inside a 'data' field in the response."
+ },
+ "ResponseIncompleteEntity": {
+ "type": "object",
+ "required": ["id", "name", "error"],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the incomplete worksheet."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error details related to the incomplete conversion."
+ }
+ },
+ "description": "Unique ID of the incomplete worksheet."
+ },
+ "ResponsePostUpgradeFailedEntities": {
+ "type": "object",
+ "required": ["data"],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntity"
+ }
+ }
+ },
+ "description": "Wrapper for the post-upgrade failed entities, as they are inside a 'data' field in the response."
+ },
+ "ResponsePostUpgradeFailedEntity": {
+ "type": "object",
+ "required": ["id", "name", "error"],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the worksheet that failed post-upgrade."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error details related to the post-upgrade failure."
+ }
+ },
+ "description": "Unique ID of the worksheet that failed post-upgrade."
+ },
+ "HeaderUpdateInput": {
+ "type": "object",
+ "required": ["attributes"],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID of a specified type to identify the header.",
+ "nullable": true
+ },
+ "obj_identifier": {
+ "type": "string",
+ "description": "Custom object identifier to uniquely identify header.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "LIVEBOARD",
+ "ACTION_OBJECT",
+ "DATA_SOURCE",
+ "USER",
+ "USER_GROUP"
+ ],
+ "description": "Optional type of the header object.",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/HeaderAttributeInput"
+ },
+ "description": "List of attributes to update"
+ }
+ },
+ "description": "Favorite object options."
+ },
+ "HeaderAttributeInput": {
+ "type": "object",
+ "required": ["name", "value"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Attribute name to be updated."
+ },
+ "value": {
+ "type": "string",
+ "description": "Attribute's new value."
+ }
+ },
+ "description": "Attribute to update in a header."
+ },
+ "UpdateObjIdInput": {
+ "type": "object",
+ "required": ["new_obj_id"],
+ "properties": {
+ "metadata_identifier": {
+ "type": "string",
+ "description": "GUID or name of the metadata object.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "LIVEBOARD",
+ "ACTION_OBJECT",
+ "DATA_SOURCE",
+ "USER",
+ "USER_GROUP"
+ ],
+ "description": "Type of metadata. Required if metadata_identifier is name of the object.",
+ "nullable": true
+ },
+ "current_obj_id": {
+ "type": "string",
+ "description": "Current object ID value.",
+ "nullable": true
+ },
+ "new_obj_id": {
+ "type": "string",
+ "description": "New object ID value to set."
+ }
+ },
+ "description": "Input for updating object ID of a metadata object."
+ },
+ "ExportMetadataTypeInput": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "CONNECTION",
+ "CUSTOM_ACTION",
+ "USER",
+ "USER_GROUP",
+ "ROLE",
+ "FEEDBACK"
+ ],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object. Not required if the metadata type is ANSWER when session_id and generation_number is set.",
+ "nullable": true
+ },
+ "session_identifier": {
+ "type": "string",
+ "description": "Unique ID of the Answer session. Required if the metadata type is ANSWER and identifier is not set.",
+ "nullable": true
+ },
+ "generation_number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Generation Number of the Answer session. Required if the metadata type is ANSWER and identifier is not set.",
+ "nullable": true
+ }
+ },
+ "description": "MetadataType InputType used in Export MetadataType API"
+ },
+ "DeleteMetadataTypeInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "LOGICAL_RELATIONSHIP"
+ ],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object."
+ }
+ },
+ "description": "MetadataType InputType used in Delete MetadataType API"
+ },
+ "PublishMetadataListItem": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata."
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LIVEBOARD", "ANSWER", "LOGICAL_TABLE"],
+ "description": "Type of metadata. Required if identifier is name.",
+ "nullable": true
+ }
+ }
+ },
+ "AuthorMetadataTypeInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CONNECTION"],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object."
+ }
+ },
+ "description": "MetadataType InputType used in Author API's"
+ },
+ "ShareMetadataTypeInput": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LIVEBOARD",
+ "ANSWER",
+ "LOGICAL_TABLE",
+ "LOGICAL_COLUMN",
+ "CONNECTION"
+ ],
+ "description": " Type of metadata.\n \n\nType of metadata. Required if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata object."
+ }
+ }
+ },
+ "SharePermissionsInput": {
+ "type": "object",
+ "required": ["principal", "share_mode"],
+ "properties": {
+ "principal": {
+ "$ref": "#/components/schemas/PrincipalsInput",
+ "description": "Details of users or groups."
+ },
+ "share_mode": {
+ "type": "string",
+ "enum": ["READ_ONLY", "MODIFY", "NO_ACCESS"],
+ "description": "Type of access to the shared object"
+ }
+ }
+ },
+ "ColumnSecurityRuleUpdate": {
+ "type": "object",
+ "required": ["column_identifier"],
+ "properties": {
+ "column_identifier": {
+ "type": "string",
+ "description": "Column identifier (col_id or name)"
+ },
+ "is_unsecured": {
+ "type": "boolean",
+ "description": "If true, the column will be marked as unprotected and all groups associated with it will be removed",
+ "nullable": true
+ },
+ "group_access": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ColumnSecurityRuleGroupOperation"
+ },
+ "description": "Array of group operation objects that specifies the actions for groups to be associated with a column",
+ "nullable": true
+ }
+ }
+ },
+ "ColumnSecurityRuleGroupOperation": {
+ "type": "object",
+ "required": ["operation", "group_identifiers"],
+ "properties": {
+ "operation": {
+ "type": "string",
+ "enum": ["ADD", "REMOVE", "REPLACE"],
+ "description": "Type of operation to be performed on the groups"
+ },
+ "group_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Array of group identifiers (name or GUID) on which the operation will be performed"
+ }
+ }
+ },
+ "MetadataObject": {
+ "type": "object",
+ "required": ["identifier"],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the metadata"
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CUSTOM_ACTION"],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
+ }
+ }
+ },
+ "CommitResponse": {
+ "type": "object",
+ "properties": {
+ "committer": {
+ "$ref": "#/components/schemas/CommiterType",
+ "description": "Repository user using which changes were committed",
+ "nullable": true
+ },
+ "author": {
+ "$ref": "#/components/schemas/AuthorType",
+ "description": "Thoughtspot user who commits the changes",
+ "nullable": true
+ },
+ "comment": {
+ "type": "string",
+ "description": "Comments associated with the commit",
+ "nullable": true
+ },
+ "commit_time": {
+ "type": "string",
+ "description": "Time at which the changes were committed.",
+ "nullable": true
+ },
+ "commit_id": {
+ "type": "string",
+ "description": "SHA id associated with the commit",
+ "nullable": true
+ },
+ "branch": {
+ "type": "string",
+ "description": "Branch where changes were committed",
+ "nullable": true
+ },
+ "committed_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CommitFileType"
+ },
+ "description": "Files that were pushed as part of this commit",
+ "nullable": true
+ }
+ }
+ },
+ "CommitFileType": {
+ "type": "object",
+ "required": ["file_name", "status_code"],
+ "properties": {
+ "file_name": {
+ "type": "string",
+ "description": "Name of the file deployed"
+ },
+ "status_code": {
+ "type": "string",
+ "description": "Indicates the status of deployment for the file"
+ },
+ "status_message": {
+ "type": "string",
+ "description": "Any error or warning with the deployment",
+ "nullable": true
+ }
+ }
+ },
+ "RevertResponse": {
+ "type": "object",
+ "properties": {
+ "committer": {
+ "$ref": "#/components/schemas/CommiterType",
+ "description": "Repository user using which changes were committed",
+ "nullable": true
+ },
+ "author": {
+ "$ref": "#/components/schemas/AuthorType",
+ "description": "Thoughtspot user who commits the changes",
+ "nullable": true
+ },
+ "comment": {
+ "type": "string",
+ "description": "Comments associated with the commit",
+ "nullable": true
+ },
+ "commit_time": {
+ "type": "string",
+ "description": "Time at which the changes were committed.",
+ "nullable": true
+ },
+ "commit_id": {
+ "type": "string",
+ "description": "SHA id associated with the commit",
+ "nullable": true
+ },
+ "branch": {
+ "type": "string",
+ "description": "Branch where changes were committed",
+ "nullable": true
+ },
+ "committed_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CommitFileType"
+ },
+ "description": "Files that were pushed as part of this commit",
+ "nullable": true
+ },
+ "reverted_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RevertedMetadata"
+ },
+ "description": "Metadata of reverted file of this commit",
+ "nullable": true
+ }
+ }
+ },
+ "RevertedMetadata": {
+ "type": "object",
+ "required": [
+ "file_name",
+ "metadata_name",
+ "metadata_type",
+ "status_code",
+ "status_message"
+ ],
+ "properties": {
+ "file_name": {
+ "type": "string",
+ "description": "Name of the file deployed"
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata object"
+ },
+ "metadata_type": {
+ "type": "string",
+ "description": "Type of the metadata object"
+ },
+ "status_code": {
+ "type": "string",
+ "description": "Indicates the status of deployment for the file"
+ },
+ "status_message": {
+ "type": "string",
+ "description": "Any error or warning with the deployment"
+ }
+ }
+ },
+ "DeployResponse": {
+ "type": "object",
+ "properties": {
+ "file_name": {
+ "type": "string",
+ "description": "Name of the file deployed",
+ "nullable": true
+ },
+ "metadata_name": {
+ "type": "string",
+ "description": "Name of the metadata object",
+ "nullable": true
+ },
+ "metadata_type": {
+ "type": "string",
+ "description": "Type of the metadata object",
+ "nullable": true
+ },
+ "status_code": {
+ "type": "string",
+ "description": "Indicates the status of deployment for the file",
+ "nullable": true
+ },
+ "status_message": {
+ "type": "string",
+ "description": "Any error or warning with the deployment",
+ "nullable": true
+ }
+ }
+ },
+ "CreateConnectionResponse": {
+ "type": "object",
+ "required": ["id", "name", "data_warehouse_type"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the connection created."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the connection."
+ },
+ "data_warehouse_type": {
+ "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"
+ ],
+ "description": "Type of data warehouse."
+ },
+ "details": {
+ "type": "object",
+ "description": "Details of the connection.",
+ "nullable": true
+ }
+ }
+ },
+ "FetchConnectionDiffStatusResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "boolean",
+ "description": "Status of the connection diff.",
+ "nullable": true
+ }
+ }
+ },
+ "RevokeRefreshTokensResponse": {
+ "type": "object",
+ "required": ["data"],
+ "properties": {
+ "data": {
+ "type": "string",
+ "description": "Result message describing the outcome of the refresh token revocation operation."
+ }
+ }
+ },
+ "RoleResponse": {
+ "type": "object",
+ "required": ["id", "name", "description", "privileges"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique Id of the role."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the role"
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the role"
+ },
+ "groups_assigned_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "number of groups assigned with this role",
+ "nullable": true
+ },
+ "orgs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GenericInfo"
+ },
+ "description": "Orgs in which role exists.",
+ "nullable": true
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GenericInfo"
+ },
+ "description": "Details of groups assigned with this role",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "description": "Privileges granted to the role."
+ },
+ "permission": {
+ "type": "string",
+ "enum": ["READ_ONLY", "MODIFY", "NO_ACCESS"],
+ "description": "Permission details of the Role",
+ "nullable": true
+ },
+ "author_id": {
+ "type": "string",
+ "description": "Unique identifier of author of the role.",
+ "nullable": true
+ },
+ "modifier_id": {
+ "type": "string",
+ "description": "Unique identifier of modifier of the role.",
+ "nullable": true
+ },
+ "creation_time_in_millis": {
+ "type": "object",
+ "description": "Creation time of the role in milliseconds.",
+ "nullable": true
+ },
+ "modification_time_in_millis": {
+ "type": "object",
+ "description": "Last modified time of the role in milliseconds.",
+ "nullable": true
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "Indicates whether the role is deleted.",
+ "nullable": true
+ },
+ "deprecated": {
+ "type": "boolean",
+ "description": "Indicates whether the role is deprecated.",
+ "nullable": true
+ },
+ "external": {
+ "type": "boolean",
+ "description": "Indicates whether the role is external.",
+ "nullable": true
+ },
+ "hidden": {
+ "type": "boolean",
+ "description": "Indicates whether the role is hidden.",
+ "nullable": true
+ },
+ "shared_via_connection": {
+ "type": "boolean",
+ "description": "Indicates whether the role is shared via connection",
+ "nullable": true
+ }
+ }
+ },
+ "LiveboardOptionsInput": {
+ "type": "object",
+ "required": ["visualization_identifiers"],
+ "properties": {
+ "visualization_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of visualizations."
+ }
+ },
+ "description": "Options to specify details of Liveboard."
+ },
+ "SchedulesPdfOptionsInput": {
+ "type": "object",
+ "properties": {
+ "complete_liveboard": {
+ "type": "boolean",
+ "description": "Indicates whether to include complete Liveboard.",
+ "nullable": true
+ },
+ "include_cover_page": {
+ "type": "boolean",
+ "description": "Indicates whether to include cover page with the Liveboard title.",
+ "nullable": true
+ },
+ "include_custom_logo": {
+ "type": "boolean",
+ "description": "Indicates whether to include customized wide logo in the footer if available.",
+ "nullable": true
+ },
+ "include_filter_page": {
+ "type": "boolean",
+ "description": "Indicates whether to include a page with all applied filters.",
+ "nullable": true
+ },
+ "include_page_number": {
+ "type": "boolean",
+ "description": "Indicates whether to include page number in the footer of each page",
+ "nullable": true
+ },
+ "page_footer_text": {
+ "type": "string",
+ "description": "Text to include in the footer of each page.",
+ "nullable": true
+ },
+ "page_orientation": {
+ "type": "string",
+ "description": "Page orientation of the PDF.",
+ "nullable": true
+ },
+ "page_size": {
+ "type": "string",
+ "enum": ["A4"],
+ "description": "Page size.",
+ "nullable": true
+ },
+ "truncate_table": {
+ "type": "boolean",
+ "description": "Indicates whether to include only first page of the tables.",
+ "nullable": true
+ }
+ },
+ "description": "Options for PDF export."
+ },
+ "FrequencyInput": {
+ "type": "object",
+ "required": ["cron_expression"],
+ "properties": {
+ "cron_expression": {
+ "$ref": "#/components/schemas/CronExpressionInput",
+ "description": "Schedule selected cron expression."
+ }
+ },
+ "description": "Configuration of schedule with cron expression"
+ },
+ "CronExpressionInput": {
+ "type": "object",
+ "required": [
+ "day_of_month",
+ "day_of_week",
+ "hour",
+ "minute",
+ "month",
+ "second"
+ ],
+ "properties": {
+ "day_of_month": {
+ "type": "string",
+ "description": "Day of month of the object."
+ },
+ "day_of_week": {
+ "type": "string",
+ "description": "Day of Week of the object."
+ },
+ "hour": {
+ "type": "string",
+ "description": "Hour of the object."
+ },
+ "minute": {
+ "type": "string",
+ "description": "Minute of the object."
+ },
+ "month": {
+ "type": "string",
+ "description": "Month of the object."
+ },
+ "second": {
+ "type": "string",
+ "description": "Second of the object."
+ }
+ },
+ "description": "Schedule selected cron expression."
+ },
+ "RecipientDetailsInput": {
+ "type": "object",
+ "properties": {
+ "emails": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Emails of the recipients.",
+ "nullable": true
+ },
+ "principals": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PrincipalsListItemInput"
+ },
+ "description": "User or groups to be set as recipients of the schedule notifications.",
+ "nullable": true
+ }
+ },
+ "description": "Recipients of the scheduled job notification."
+ },
+ "PrincipalsListItemInput": {
+ "type": "object",
+ "required": ["identifier", "type"],
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the user or group."
+ },
+ "type": {
+ "type": "string",
+ "description": "Principal type."
+ }
+ }
+ },
+ "ResponseSchedule": {
+ "type": "object",
+ "required": [
+ "author",
+ "creation_time_in_millis",
+ "file_format",
+ "frequency",
+ "id",
+ "metadata",
+ "name",
+ "recipient_details",
+ "time_zone"
+ ],
+ "properties": {
+ "author": {
+ "$ref": "#/components/schemas/Author",
+ "description": "Author of the schedule."
+ },
+ "creation_time_in_millis": {
+ "type": "object",
+ "description": "Schedule creation time in milliseconds."
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the job.",
+ "nullable": true
+ },
+ "file_format": {
+ "type": "string",
+ "description": "Export file format."
+ },
+ "frequency": {
+ "$ref": "#/components/schemas/Frequency",
+ "description": "Configuration of schedule with cron expression"
+ },
+ "id": {
+ "type": "string",
+ "description": "GUID of the scheduled job."
+ },
+ "liveboard_options": {
+ "$ref": "#/components/schemas/LiveboardOptions",
+ "description": "Options to specify details of Liveboard.",
+ "nullable": true
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/MetadataResponse",
+ "description": "Unique ID or name of the metadata."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the scheduled job."
+ },
+ "pdf_options": {
+ "$ref": "#/components/schemas/PdfOptions",
+ "description": "Options for PDF export.",
+ "nullable": true
+ },
+ "recipient_details": {
+ "$ref": "#/components/schemas/RecipientDetails",
+ "description": "Recipient of the scheduled job notifications."
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the job",
+ "nullable": true
+ },
+ "time_zone": {
+ "type": "string",
+ "description": "Time zone"
+ },
+ "history_runs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseScheduleRun"
+ },
+ "description": "Schedule runs history records.",
+ "nullable": true
+ },
+ "personalised_view_id": {
+ "type": "string",
+ "description": "Personalised view id of the liveboard to be scheduled.",
+ "nullable": true
+ }
+ }
+ },
+ "Author": {
+ "type": "object",
+ "required": ["id", "name"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the object."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the object."
+ }
+ },
+ "description": "Author of the schedule."
+ },
+ "Frequency": {
+ "type": "object",
+ "required": ["cron_expression"],
+ "properties": {
+ "cron_expression": {
+ "$ref": "#/components/schemas/CronExpression",
+ "description": "Schedule selected cron expression."
+ }
+ },
+ "description": "Configuration of schedule with cron expression"
+ },
+ "CronExpression": {
+ "type": "object",
+ "required": [
+ "day_of_month",
+ "day_of_week",
+ "hour",
+ "minute",
+ "month",
+ "second"
+ ],
+ "properties": {
+ "day_of_month": {
+ "type": "string",
+ "description": "Day of month of the object."
+ },
+ "day_of_week": {
+ "type": "string",
+ "description": "Day of Week of the object."
+ },
+ "hour": {
+ "type": "string",
+ "description": "Hour of the object."
+ },
+ "minute": {
+ "type": "string",
+ "description": "Minute of the object."
+ },
+ "month": {
+ "type": "string",
+ "description": "Month of the object."
+ },
+ "second": {
+ "type": "string",
+ "description": "Second of the object."
+ }
+ },
+ "description": "Schedule selected cron expression."
+ },
+ "LiveboardOptions": {
+ "type": "object",
+ "required": ["visualization_identifiers"],
+ "properties": {
+ "visualization_identifiers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Unique ID or name of visualizations."
+ }
+ },
+ "description": "Options to specify details of Liveboard."
+ },
+ "MetadataResponse": {
+ "type": "object",
+ "required": ["id", "type"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LIVEBOARD"]
+ }
+ }
+ },
+ "PdfOptions": {
+ "type": "object",
+ "properties": {
+ "complete_liveboard": {
+ "type": "boolean",
+ "description": "Indicates whether to include complete Liveboard.",
+ "nullable": true
+ },
+ "include_cover_page": {
+ "type": "boolean",
+ "description": "Indicates whether to include cover page with the Liveboard title.",
+ "nullable": true
+ },
+ "include_custom_logo": {
+ "type": "boolean",
+ "description": "Indicates whether to include customized wide logo in the footer if available.",
+ "nullable": true
+ },
+ "include_filter_page": {
+ "type": "boolean",
+ "description": "Indicates whether to include a page with all applied filters.",
+ "nullable": true
+ },
+ "include_page_number": {
+ "type": "boolean",
+ "description": "Indicates whether to include page number in the footer of each page",
+ "nullable": true
+ },
+ "page_footer_text": {
+ "type": "string",
+ "description": "Text to include in the footer of each page.",
+ "nullable": true
+ },
+ "page_orientation": {
"type": "string",
- "description": "Indicates the locale to be used for all formattings.",
- "nullable": true,
- "enum": [
- "en-CA",
- "en-GB",
- "en-US",
- "de-DE",
- "ja-JP",
- "zh-CN",
- "pt-BR",
- "fr-FR",
- "fr-CA",
- "es-US",
- "da-DK",
- "es-ES",
- "fi-FI",
- "sv-SE",
- "nb-NO",
- "pt-PT",
- "nl-NL",
- "it-IT",
- "ru-RU",
- "en-IN",
- "de-CH",
- "en-NZ",
- "es-MX",
- "en-AU",
- "zh-Hant",
- "ko-KR",
- "en-DE"
- ]
+ "description": "Page orientation of the PDF.",
+ "nullable": true
},
- "number_format_locale": {
+ "page_size": {
"type": "string",
- "description": "Indicates the locale to be used for number formatting.",
- "nullable": true,
- "enum": [
- "en-CA",
- "en-GB",
- "en-US",
- "de-DE",
- "ja-JP",
- "zh-CN",
- "pt-BR",
- "fr-FR",
- "fr-CA",
- "es-US",
- "da-DK",
- "es-ES",
- "fi-FI",
- "sv-SE",
- "nb-NO",
- "pt-PT",
- "nl-NL",
- "it-IT",
- "ru-RU",
- "en-IN",
- "de-CH",
- "en-NZ",
- "es-MX",
- "en-AU",
- "zh-Hant",
- "ko-KR",
- "en-DE"
- ]
+ "enum": ["A4"],
+ "description": "Page size.",
+ "nullable": true
},
- "date_format_locale": {
+ "truncate_table": {
+ "type": "boolean",
+ "description": "Indicates whether to include only first page of the tables.",
+ "nullable": true
+ }
+ },
+ "description": "Options for PDF export."
+ },
+ "RecipientDetails": {
+ "type": "object",
+ "properties": {
+ "emails": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Emails of the recipients. Specify email address if the recipient is not a ThoughtSpot user.",
+ "nullable": true
+ },
+ "principals": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PrincipalsListItem"
+ },
+ "description": "List of user or groups to subscribe for the scheduled job notifications.",
+ "nullable": true
+ }
+ },
+ "description": "Recipient configuration which includes email address, ID or name of the users and groups."
+ },
+ "PrincipalsListItem": {
+ "type": "object",
+ "required": ["identifier", "type"],
+ "properties": {
+ "identifier": {
"type": "string",
- "description": "Indicates the locale to be used for date formatting.",
- "nullable": true,
- "enum": [
- "en-CA",
- "en-GB",
- "en-US",
- "de-DE",
- "ja-JP",
- "zh-CN",
- "pt-BR",
- "fr-FR",
- "fr-CA",
- "es-US",
- "da-DK",
- "es-ES",
- "fi-FI",
- "sv-SE",
- "nb-NO",
- "pt-PT",
- "nl-NL",
- "it-IT",
- "ru-RU",
- "en-IN",
- "de-CH",
- "en-NZ",
- "es-MX",
- "en-AU",
- "zh-Hant",
- "ko-KR",
- "en-DE"
- ]
+ "description": "Unique ID or name of the user or group."
+ },
+ "type": {
+ "type": "string",
+ "description": "Principal type. Valid values are"
}
}
},
- "PermissionOfPrincipalsResponse": {
+ "ResponseScheduleRun": {
"type": "object",
+ "required": [
+ "id",
+ "start_time_in_millis",
+ "end_time_in_millis",
+ "status"
+ ],
"properties": {
- "principal_permission_details": {
- "type": "object",
+ "id": {
+ "type": "string",
+ "description": "GUID of the scheduled job."
+ },
+ "start_time_in_millis": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Schedule run start time in milliseconds."
+ },
+ "end_time_in_millis": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Schedule run end time in milliseconds."
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the schedule run."
+ },
+ "detail": {
+ "type": "string",
+ "description": "Message details related to the schedule run.",
+ "nullable": true
+ }
+ },
+ "description": "Schedule run response object"
+ },
+ "MetadataInput": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": ["LIVEBOARD"],
+ "nullable": true
+ }
+ }
+ },
+ "SortingOptions": {
+ "type": "object",
+ "properties": {
+ "field_name": {
+ "type": "string",
+ "description": "Name of the field to apply the sort on.",
+ "nullable": true
+ },
+ "order": {
+ "type": "string",
+ "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "nullable": true
+ }
+ },
+ "description": "Sort options."
+ },
+ "ScheduleHistoryRunsOptionsInput": {
+ "type": "object",
+ "properties": {
+ "include_history_runs": {
+ "type": "boolean",
+ "default": false,
+ "description": "Indicates whether to fetch history runs for the scheduled notification.",
+ "nullable": true
+ },
+ "record_size": {
+ "type": "integer",
+ "format": "int32",
+ "default": 10,
+ "description": "Indicates the max number of records that can be fetched as past runs of any scheduled job.",
+ "nullable": true
+ },
+ "record_offset": {
+ "type": "integer",
+ "format": "int32",
+ "default": 0,
+ "description": "Indicates the starting record number from where history runs records should be fetched.",
+ "nullable": true
+ }
+ }
+ },
+ "Action_Details_Input_Create": {
+ "type": "object",
+ "properties": {
+ "CALLBACK": {
+ "$ref": "#/components/schemas/CALLBACKInputMandatory",
+ "description": "CALLBACK Custom Action Type",
+ "nullable": true
+ },
+ "URL": {
+ "$ref": "#/components/schemas/URLInputMandatory",
+ "description": "URL Custom Action Type",
+ "nullable": true
+ }
+ },
+ "description": "Action details includes Type and Configuration for Custom Actions, either Callback or URL is required.\nWhen both callback and url are provided, callback would be considered"
+ },
+ "CALLBACKInputMandatory": {
+ "type": "object",
+ "properties": {
+ "reference": {
+ "type": "string",
+ "description": "Reference name. By default, the value will be set to action name.",
"nullable": true
}
- }
+ },
+ "description": "CALLBACK Custom Action Type"
},
- "PermissionOfMetadataResponse": {
+ "URLInputMandatory": {
"type": "object",
+ "required": ["url"],
"properties": {
- "metadata_permission_details": {
- "type": "object",
+ "authentication": {
+ "$ref": "#/components/schemas/AuthenticationInput",
+ "description": "Authorization type for the custom action.",
+ "nullable": true
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParametersListItemInput"
+ },
+ "description": "Query parameters for url.",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "description": "Request Url for the Custom action."
+ },
+ "reference": {
+ "type": "string",
+ "description": "Reference name. By default the value will be set to action name",
"nullable": true
}
- }
+ },
+ "description": "URL Custom Action Type"
},
- "PrincipalsInput": {
+ "AuthenticationInput": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "identifier": {
+ "API_Key": {
+ "$ref": "#/components/schemas/API_KeyInput",
+ "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.",
+ "nullable": true
+ },
+ "Basic_Auth": {
+ "$ref": "#/components/schemas/Basic_AuthInput",
+ "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.",
+ "nullable": true
+ },
+ "Bearer_Token": {
"type": "string",
- "description": "Unique ID or name of the principal object such as a user or group."
+ "description": "Bearer tokens enable requests to authenticate using an access key.",
+ "nullable": true
},
- "type": {
+ "No_Auth": {
"type": "string",
- "enum": [
- "USER",
- "USER_GROUP"
- ],
- "description": "Principal type.",
+ "description": "No authorization. If your request doesn't require authorization.",
"nullable": true
}
- }
+ },
+ "description": "Authorization type for the custom action."
},
- "PermissionsMetadataTypeInput": {
+ "API_KeyInput": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
+ "key": {
"type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION"
- ],
- "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "description": "Enter your key name",
"nullable": true
},
- "identifier": {
+ "value": {
"type": "string",
- "description": "Unique ID or name of the metadata object."
+ "description": "Enter you key value",
+ "nullable": true
}
},
- "description": "MetadataType InputType used in Permission API's"
+ "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters."
},
- "SearchDataResponse": {
+ "Basic_AuthInput": {
"type": "object",
- "required": [
- "contents"
- ],
"properties": {
- "contents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnswerContent"
- },
- "description": "Data content of metadata objects"
+ "password": {
+ "type": "string",
+ "description": "Password for the basic authentication",
+ "nullable": true
+ },
+ "username": {
+ "type": "string",
+ "description": "Username for the basic authentication",
+ "nullable": true
}
},
- "description": "Response format associated with the search data API."
+ "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request."
},
- "AnswerContent": {
+ "ParametersListItemInput": {
"type": "object",
- "required": [
- "available_data_row_count",
- "column_names",
- "data_rows",
- "record_offset",
- "record_size",
- "returned_data_row_count",
- "sampling_ratio"
- ],
"properties": {
- "available_data_row_count": {
- "type": "integer",
- "format": "int32",
- "description": "Total available data row count."
- },
- "column_names": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Name of the columns."
- },
- "data_rows": {
- "type": "array",
- "items": {
- "type": "object"
- },
- "description": "Rows of data set."
- },
- "record_offset": {
- "type": "integer",
- "format": "int32",
- "description": "The starting record number from where the records should be included."
- },
- "record_size": {
- "type": "integer",
- "format": "int32",
- "description": "The number of records that should be included."
- },
- "returned_data_row_count": {
- "type": "integer",
- "format": "int32",
- "description": "Total returned data row count."
+ "key": {
+ "type": "string",
+ "description": "Key for the url query parameter",
+ "nullable": true
},
- "sampling_ratio": {
- "type": "number",
- "format": "float",
- "description": "Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys returned in the data set to the total number of keys expected in the query. If the value is 1.0, this means that the complete result is returned."
+ "value": {
+ "type": "string",
+ "description": "Value for the url query parameter",
+ "nullable": true
}
}
},
- "LiveboardDataResponse": {
+ "Associate_Metadata_Input_Create": {
"type": "object",
- "required": [
- "metadata_id",
- "metadata_name",
- "contents"
- ],
+ "required": ["identifier"],
"properties": {
- "metadata_id": {
- "type": "string",
- "description": "The unique identifier of the object"
+ "action_config": {
+ "$ref": "#/components/schemas/ActionConfigInputCreate",
+ "description": "Specify that the association is enabled for the metadata object",
+ "nullable": true
},
- "metadata_name": {
+ "identifier": {
"type": "string",
- "description": "Name of the metadata object"
+ "description": "Unique ID or name of the metadata."
},
- "contents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LiveboardContent"
- },
- "description": "Data content of metadata objects"
+ "type": {
+ "type": "string",
+ "enum": ["VISUALIZATION", "ANSWER", "WORKSHEET"],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
}
}
},
- "LiveboardContent": {
+ "ActionConfigInputCreate": {
"type": "object",
- "required": [
- "available_data_row_count",
- "column_names",
- "data_rows",
- "record_offset",
- "record_size",
- "returned_data_row_count",
- "sampling_ratio"
- ],
"properties": {
- "available_data_row_count": {
- "type": "integer",
- "format": "int32",
- "description": "Total available data row count."
- },
- "column_names": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Name of the columns."
- },
- "data_rows": {
- "type": "array",
- "items": {
- "type": "object"
- },
- "description": "Rows of data set."
- },
- "record_offset": {
- "type": "integer",
- "format": "int32",
- "description": "The starting record number from where the records should be included."
- },
- "record_size": {
- "type": "integer",
- "format": "int32",
- "description": "The number of records that should be included."
- },
- "returned_data_row_count": {
- "type": "integer",
- "format": "int32",
- "description": "Total returned data row count."
- },
- "sampling_ratio": {
- "type": "number",
- "format": "float",
- "description": "Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys returned in the data set to the total number of keys expected in the query. If the value is 1.0, this means that the complete result is returned."
- },
- "visualization_id": {
+ "position": {
"type": "string",
- "description": "Unique ID of the visualization.",
+ "enum": ["MENU", "PRIMARY", "CONTEXT_MENU"],
+ "default": "MENU",
+ "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.",
"nullable": true
},
- "visualization_name": {
- "type": "string",
- "description": "Name of the visualization.",
+ "visibility": {
+ "type": "boolean",
+ "default": true,
+ "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled",
+ "nullable": true
+ }
+ },
+ "description": "Specify that the association is enabled for the metadata object Default"
+ },
+ "Default_Action_Config_Input_Create": {
+ "type": "object",
+ "properties": {
+ "visibility": {
+ "type": "boolean",
+ "default": true,
+ "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.\nDefault: true",
"nullable": true
}
- }
+ },
+ "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
},
- "AnswerDataResponse": {
+ "Action_Details_Input": {
"type": "object",
- "required": [
- "metadata_id",
- "metadata_name",
- "contents"
- ],
"properties": {
- "metadata_id": {
- "type": "string",
- "description": "The unique identifier of the object"
- },
- "metadata_name": {
- "type": "string",
- "description": "Name of the metadata object"
+ "CALLBACK": {
+ "$ref": "#/components/schemas/CALLBACKInput",
+ "description": "CALLBACK Custom Action Type",
+ "nullable": true
},
- "contents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnswerContent"
- },
- "description": "Data content of metadata objects"
+ "URL": {
+ "$ref": "#/components/schemas/URLInput",
+ "description": "URL Custom Action Type",
+ "nullable": true
}
},
- "description": "Response format associated with fetch data api"
+ "description": "Action details includes `Type` and configuration details of Custom Actions. Either Callback or URL is required."
},
- "LogResponse": {
+ "CALLBACKInput": {
"type": "object",
- "required": [
- "date",
- "log"
- ],
"properties": {
- "date": {
- "type": "string",
- "description": "Date timestamp of the log entry"
- },
- "log": {
+ "reference": {
"type": "string",
- "description": "Log data"
+ "description": "Reference name. By default, the value will be set to action name.",
+ "nullable": true
}
- }
+ },
+ "description": "CALLBACK Custom Action Type"
},
- "RepoConfigObject": {
+ "URLInput": {
"type": "object",
"properties": {
- "repository_url": {
- "type": "string",
- "description": "Remote repository URL configured",
- "nullable": true
- },
- "username": {
- "type": "string",
- "description": "Username to authenticate connection to the version control system",
- "nullable": true
- },
- "commit_branch_name": {
- "type": "string",
- "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.",
+ "authentication": {
+ "$ref": "#/components/schemas/AuthenticationInput",
+ "description": "Authorization type for the custom action.",
"nullable": true
},
- "branches": {
+ "parameters": {
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/ParametersListItemInput"
},
- "description": "Branches that have been pulled in local repository",
- "nullable": true
- },
- "enable_guid_mapping": {
- "type": "boolean",
- "description": "Maintain mapping of guid for the deployment to an instance",
+ "description": "Query parameters for url.",
"nullable": true
},
- "configuration_branch_name": {
+ "url": {
"type": "string",
- "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.",
+ "description": "Request Url for the Custom action.",
"nullable": true
},
- "org": {
- "$ref": "#/components/schemas/Org",
- "description": "Details of the Org",
+ "reference": {
+ "type": "string",
+ "description": "Reference name. By default the value will be set to action name",
"nullable": true
}
- }
+ },
+ "description": "URL Custom Action Type"
},
- "CommitHistoryResponse": {
+ "Associate_Metadata_Input": {
"type": "object",
- "required": [
- "committer",
- "author",
- "comment",
- "commit_time",
- "commit_id",
- "branch"
- ],
"properties": {
- "committer": {
- "$ref": "#/components/schemas/CommiterType",
- "description": "Repository user using which changes were committed"
- },
- "author": {
- "$ref": "#/components/schemas/AuthorType",
- "description": "Thoughtspot user who commits the changes"
- },
- "comment": {
- "type": "string",
- "description": "Comments associated with the commit"
- },
- "commit_time": {
- "type": "string",
- "description": "Time at which the changes were committed."
+ "action_config": {
+ "$ref": "#/components/schemas/ActionConfigInput",
+ "description": "Specify that the association is enabled for the metadata object",
+ "nullable": true
},
- "commit_id": {
+ "identifier": {
"type": "string",
- "description": "SHA id associated with the commit"
+ "description": "Unique ID or name of the metadata.",
+ "nullable": true
},
- "branch": {
+ "type": {
"type": "string",
- "description": "Branch where changes were committed"
+ "enum": ["VISUALIZATION", "ANSWER", "WORKSHEET"],
+ "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "nullable": true
}
}
},
- "CommiterType": {
+ "ActionConfigInput": {
"type": "object",
"properties": {
- "email": {
+ "position": {
"type": "string",
- "description": "Email id of the committer",
+ "enum": ["MENU", "PRIMARY", "CONTEXT_MENU"],
+ "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.",
"nullable": true
},
- "username": {
- "type": "string",
- "description": "Username of the committer",
+ "visibility": {
+ "type": "boolean",
+ "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled",
"nullable": true
}
- }
+ },
+ "description": "Specify that the association is enabled for the metadata object Default"
},
- "AuthorType": {
+ "Default_Action_Config_Input": {
"type": "object",
"properties": {
- "email": {
- "type": "string",
- "description": "Email id of the committer",
- "nullable": true
- },
- "username": {
- "type": "string",
- "description": "Username of the committer",
+ "visibility": {
+ "type": "boolean",
+ "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.",
"nullable": true
}
- }
+ },
+ "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
},
- "ConnectionInput": {
+ "ModelTableList": {
"type": "object",
+ "required": ["model_name", "tables"],
"properties": {
- "identifier": {
+ "model_name": {
"type": "string",
- "description": "Unique ID or name of the connection.",
- "nullable": true
+ "description": "Name of the Model."
},
- "name_pattern": {
+ "model_path": {
"type": "string",
- "description": "A pattern to match case-insensitive name of the connection object. User `%` for a wildcard match.",
+ "description": "Model directory path, this is optional param and required if there are duplicate models with the same name.",
"nullable": true
},
- "data_warehouse_objects": {
+ "tables": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DataWarehouseObjectInput"
+ "type": "string"
},
- "description": "Filter options for databases, schemas, tables and columns.",
- "nullable": true
+ "description": "List of Tables."
}
}
},
- "DataWarehouseObjectInput": {
+ "DbtSearchResponse": {
"type": "object",
"properties": {
- "database": {
+ "dbt_connection_identifier": {
"type": "string",
- "description": "Name of the database.",
"nullable": true
},
- "schema": {
+ "project_name": {
"type": "string",
- "description": "Name of the schema within the database.",
"nullable": true
},
- "table": {
+ "connection_id": {
"type": "string",
- "description": "Name of the table within the schema.",
"nullable": true
},
- "column": {
+ "connection_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "cdw_database": {
+ "type": "string",
+ "nullable": true
+ },
+ "import_type": {
+ "type": "string",
+ "nullable": true
+ },
+ "author_name": {
"type": "string",
- "description": "Name of the column within the table.",
"nullable": true
}
}
},
- "SortOptionInput": {
+ "Conversation": {
"type": "object",
+ "required": ["conversation_identifier"],
"properties": {
- "field_name": {
+ "conversation_identifier": {
"type": "string",
- "enum": [
- "NAME",
- "DISPLAY_NAME",
- "AUTHOR",
- "CREATED",
- "MODIFIED",
- "LAST_ACCESSED",
- "SYNCED",
- "VIEWS",
- "USER_STATE",
- "ROW_COUNT"
- ],
- "description": "Name of the field to apply the sort on.",
+ "description": "Unique identifier of the conversation."
+ }
+ }
+ },
+ "ResponseMessage": {
+ "type": "object",
+ "required": ["message_type"],
+ "properties": {
+ "session_identifier": {
+ "type": "string",
+ "description": "Unique identifier of the generated response.",
+ "nullable": true
+ },
+ "generation_number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Generate number of the response.",
+ "nullable": true
+ },
+ "message_type": {
+ "type": "string",
+ "enum": ["TSAnswer"],
+ "description": "Type of the generated response."
+ },
+ "visualization_type": {
+ "type": "string",
+ "enum": ["Chart", "Table", "Undefined"],
+ "description": "Generated visualization type.",
+ "nullable": true
+ },
+ "tokens": {
+ "type": "string",
+ "description": "Tokens for the response.",
"nullable": true
},
- "order": {
+ "display_tokens": {
"type": "string",
- "enum": [
- "ASC",
- "DESC"
- ],
- "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "description": "User friendly tokens for the response.",
"nullable": true
}
}
},
- "SearchConnectionResponse": {
+ "ContextPayloadV2Input": {
"type": "object",
- "required": [
- "id",
- "name",
- "data_warehouse_type"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "Unique ID of the connection."
- },
- "name": {
- "type": "string",
- "description": "Name of the connection."
- },
- "description": {
+ "type": {
"type": "string",
- "description": "Description of the connection.",
+ "enum": ["answer", "liveboard", "data_source"],
+ "description": "Type of the context.",
"nullable": true
},
- "data_warehouse_type": {
- "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"
- ],
- "description": "Type of data warehouse."
+ "answer_context": {
+ "$ref": "#/components/schemas/AnswerContextInput",
+ "description": "Answer context.",
+ "nullable": true
},
- "data_warehouse_objects": {
- "$ref": "#/components/schemas/DataWarehouseObjects",
- "description": "List of Data warehouse objects",
+ "liveboard_context": {
+ "$ref": "#/components/schemas/LBContextInput",
+ "description": "Liveboard context.",
"nullable": true
},
- "details": {
- "type": "object",
- "description": "Details of the connection.",
+ "data_source_context": {
+ "$ref": "#/components/schemas/DataSourceContextInput",
+ "description": "Data source context.",
"nullable": true
}
}
},
- "DataWarehouseObjects": {
+ "AnswerContextInput": {
"type": "object",
- "required": [
- "databases"
- ],
+ "required": ["session_identifier", "generation_number"],
"properties": {
- "databases": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Database"
- },
- "description": "Databases of the connection."
+ "session_identifier": {
+ "type": "string",
+ "description": "Unique identifier of the answer session."
+ },
+ "generation_number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Generation number of the answer."
}
}
},
- "Database": {
+ "LBContextInput": {
"type": "object",
- "required": [
- "name"
- ],
+ "required": ["liveboard_identifier", "visualization_identifier"],
"properties": {
- "name": {
+ "liveboard_identifier": {
"type": "string",
- "description": "Name of the database."
+ "description": "Unique identifier of the liveboard."
},
- "schemas": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SchemaObject"
- },
- "description": "Schemas of the database.",
+ "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."
+ }
+ }
+ },
+ "ConversationSettingsInput": {
+ "type": "object",
+ "properties": {
+ "enable_contextual_change_analysis": {
+ "type": "boolean",
+ "default": false,
+ "description": "Enable contextual change analysis.",
"nullable": true
},
- "auto_created": {
+ "enable_natural_language_answer_generation": {
"type": "boolean",
- "description": "Determines if the object is auto created.",
+ "default": true,
+ "description": "Enable natural language to answer generation.",
+ "nullable": true
+ },
+ "enable_reasoning": {
+ "type": "boolean",
+ "default": false,
+ "description": "Enable reasoning.",
"nullable": true
}
}
},
- "SchemaObject": {
+ "AgentConversation": {
"type": "object",
- "required": [
- "name"
- ],
+ "required": ["conversation_id"],
"properties": {
- "name": {
+ "conversation_id": {
"type": "string",
- "description": "Name of the schema."
+ "description": "Unique identifier of the conversation."
+ }
+ }
+ },
+ "SendAgentMessageResponse": {
+ "type": "object",
+ "required": ["success"],
+ "properties": {
+ "success": {
+ "type": "boolean"
},
- "tables": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "NLInstructionsInfoInput": {
+ "type": "object",
+ "required": ["instructions", "scope"],
+ "properties": {
+ "instructions": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Table"
+ "type": "string"
},
- "description": "Tables in the schema.",
- "nullable": true
+ "description": "User instructions for natural language processing."
+ },
+ "scope": {
+ "type": "string",
+ "enum": ["GLOBAL"],
+ "description": "Scope of the instruction (USER or GLOBAL). Defaults to GLOBAL."
}
}
},
- "Table": {
+ "eureka_SetNLInstructionsResponse": {
"type": "object",
- "required": [
- "name"
- ],
+ "required": ["success"],
"properties": {
- "name": {
+ "success": {
+ "type": "boolean",
+ "description": "Success status of the operation."
+ }
+ }
+ },
+ "VariableUpdateAssignmentInput": {
+ "type": "object",
+ "required": ["variable_identifier", "variable_values", "operation"],
+ "properties": {
+ "variable_identifier": {
"type": "string",
- "description": "Name of the table."
+ "description": "ID or Name of the variable"
},
- "columns": {
+ "variable_values": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Column"
+ "type": "string"
},
- "description": "Columns of the table.",
- "nullable": true
+ "description": "Values of the variable"
},
- "type": {
+ "operation": {
"type": "string",
- "description": "Type of table. Either view or table",
- "nullable": true
+ "enum": ["ADD", "REMOVE", "REPLACE", "RESET"],
+ "description": "Operation to perform"
+ }
+ },
+ "description": "Input for variable value update in batch operations"
+ },
+ "VariableUpdateScopeInput": {
+ "type": "object",
+ "required": ["org_identifier"],
+ "properties": {
+ "org_identifier": {
+ "type": "string",
+ "description": "The unique name of the org"
},
- "description": {
+ "principal_type": {
"type": "string",
- "description": "Description of the table",
+ "enum": ["USER", "USER_GROUP"],
+ "description": "Type of principal to which the variable value applies. Use USER to assign values to a specific user, or USER_GROUP to assign values to a group.",
"nullable": true
},
- "selected": {
- "type": "boolean",
- "description": "Determines if the table is selected",
+ "principal_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the principal",
"nullable": true
},
- "linked": {
- "type": "boolean",
- "description": "Determines if the table is linked",
+ "model_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the model. Required for FORMULA_VARIABLE type to scope the variable value to a specific worksheet.",
"nullable": true
},
- "relationships": {
- "type": "array",
- "items": {
- "type": "object"
- },
- "description": "List of relationships for the table",
+ "priority": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The priority level for this scope assignment, used for conflict resolution when multiple values match. Higher priority values (larger numbers) take precedence.",
"nullable": true
}
- }
+ },
+ "description": "Input for defining the scope of variable value assignments in batch update operations"
},
- "Column": {
+ "CreateEmailCustomizationResponse": {
"type": "object",
- "required": [
- "name",
- "data_type"
- ],
+ "required": ["tenant_id", "org", "name", "template_properties"],
"properties": {
- "name": {
+ "tenant_id": {
"type": "string",
- "description": "Name of the column"
+ "description": "Tenant ID"
},
- "data_type": {
- "type": "string",
- "description": "Data type of the column"
+ "org": {
+ "$ref": "#/components/schemas/OrgType",
+ "description": "Email customization org"
},
- "is_aggregate": {
+ "name": {
"type": "string",
- "description": "Determines if the column schema is an aggregate",
- "nullable": true
- },
- "can_import": {
- "type": "boolean",
- "description": "Determines if the column schema can be imported",
- "nullable": true
+ "description": "Email customization name."
},
- "selected": {
- "type": "boolean",
- "description": "Determines if the table is selected",
+ "template_properties": {
+ "type": "object",
+ "description": "Customization configuration for the email"
+ }
+ }
+ },
+ "OrgType": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
"nullable": true
},
- "is_linked_active": {
- "type": "boolean",
- "description": "Determines if the table is linked",
+ "id": {
+ "type": "integer",
+ "format": "int32",
"nullable": true
}
}
},
- "SearchRoleResponse": {
+ "Template_Properties_Input_Create": {
"type": "object",
- "required": [
- "id",
- "name",
- "description",
- "privileges"
- ],
"properties": {
- "id": {
+ "cta_button_bg_color": {
"type": "string",
- "description": "Unique Id of the role."
+ "description": "Background color for call-to-action button in hex format",
+ "nullable": true
+ },
+ "cta_text_font_color": {
+ "type": "string",
+ "description": "Text color for call-to-action button in hex format",
+ "nullable": true
+ },
+ "primary_bg_color": {
+ "type": "string",
+ "description": "Primary background color in hex format",
+ "nullable": true
},
- "name": {
+ "home_url": {
"type": "string",
- "description": "Name of the role"
+ "description": "Home page URL (HTTP/HTTPS only)",
+ "nullable": true
},
- "description": {
+ "logo_url": {
"type": "string",
- "description": "Description of the role"
+ "description": "Logo image URL (HTTP/HTTPS only)",
+ "nullable": true
},
- "groups_assigned_count": {
- "type": "integer",
- "format": "int32",
- "description": "number of groups assigned with this role",
+ "font_family": {
+ "type": "string",
+ "description": "Font family for email content (e.g., Arial, sans-serif)",
"nullable": true
},
- "orgs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GenericInfo"
- },
- "description": "Orgs in which role exists.",
+ "product_name": {
+ "type": "string",
+ "description": "Product name to display",
"nullable": true
},
- "groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GenericInfo"
- },
- "description": "Details of groups assigned with this role",
+ "footer_address": {
+ "type": "string",
+ "description": "Footer address text",
"nullable": true
},
- "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",
- "PREVIEW_DOCUMENT_SEARCH",
- "CAN_SETUP_VERSION_CONTROL"
- ]
- },
- "description": "Privileges granted to the role."
+ "footer_phone": {
+ "type": "string",
+ "description": "Footer phone number",
+ "nullable": true
},
- "permission": {
+ "replacement_value_for_liveboard": {
"type": "string",
- "enum": [
- "READ_ONLY",
- "MODIFY",
- "NO_ACCESS"
- ],
- "description": "Permission details of the Role",
+ "description": "Replacement value for Liveboard",
"nullable": true
},
- "author_id": {
+ "replacement_value_for_answer": {
"type": "string",
- "description": "Unique identifier of author of the role.",
+ "description": "Replacement value for Answer",
"nullable": true
},
- "modifier_id": {
+ "replacement_value_for_spot_iq": {
"type": "string",
- "description": "Unique identifier of modifier of the role.",
+ "description": "Replacement value for SpotIQ",
"nullable": true
},
- "creation_time_in_millis": {
- "type": "object",
- "description": "Creation time of the role in milliseconds.",
+ "hide_footer_address": {
+ "type": "boolean",
+ "description": "Whether to hide footer address",
"nullable": true
},
- "modification_time_in_millis": {
- "type": "object",
- "description": "Last modified time of the role in milliseconds.",
+ "hide_footer_phone": {
+ "type": "boolean",
+ "description": "Whether to hide footer phone number",
"nullable": true
},
- "deleted": {
+ "hide_manage_notification": {
"type": "boolean",
- "description": "Indicates whether the role is deleted.",
+ "description": "Whether to hide manage notification link",
"nullable": true
},
- "deprecated": {
+ "hide_mobile_app_nudge": {
"type": "boolean",
- "description": "Indicates whether the role is deprecated.",
+ "description": "Whether to hide mobile app nudge",
"nullable": true
},
- "external": {
+ "hide_privacy_policy": {
"type": "boolean",
- "description": "Indicates whether the role is external.",
+ "description": "Whether to hide privacy policy link",
"nullable": true
},
- "hidden": {
+ "hide_product_name": {
"type": "boolean",
- "description": "Indicates whether the role is hidden.",
+ "description": "Whether to hide product name",
"nullable": true
},
- "shared_via_connection": {
+ "hide_ts_vocabulary_definitions": {
"type": "boolean",
- "description": "Indicates whether the role is shared via connection",
+ "description": "Whether to hide ThoughtSpot vocabulary definitions",
"nullable": true
- }
- },
- "description": "Response for search role api should handle hidden privileges as well."
- },
- "Default_Action_Config_Search_Input": {
- "type": "object",
- "properties": {
- "visibility": {
+ },
+ "hide_notification_status": {
"type": "boolean",
- "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.",
+ "description": "Whether to hide notification status",
"nullable": true
- }
- },
- "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
- },
- "ResponseCustomAction": {
- "type": "object",
- "required": [
- "action_details",
- "default_action_config",
- "id",
- "name"
- ],
- "properties": {
- "action_details": {
- "$ref": "#/components/schemas/Action_details",
- "description": "`Type` and configuration data for custom actions"
},
- "default_action_config": {
- "$ref": "#/components/schemas/Default_action_config",
- "description": "Default custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
+ "hide_error_message": {
+ "type": "boolean",
+ "description": "Whether to hide error message",
+ "nullable": true
},
- "id": {
+ "hide_unsubscribe_link": {
+ "type": "boolean",
+ "description": "Whether to hide unsubscribe link",
+ "nullable": true
+ },
+ "hide_modify_alert": {
+ "type": "boolean",
+ "description": "Whether to hide modify alert",
+ "nullable": true
+ },
+ "company_privacy_policy_url": {
"type": "string",
- "description": "Unique Id of the custom action."
+ "description": "Company privacy policy URL (HTTP/HTTPS only)",
+ "nullable": true
},
- "metadata_association": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Metadata_Association_Item"
- },
- "description": "Metadata objects to assign the the custom action to.",
+ "company_website_url": {
+ "type": "string",
+ "description": "Company website URL (HTTP/HTTPS only)",
"nullable": true
},
- "name": {
+ "contact_support_url": {
"type": "string",
- "description": "Unique name of the custom action."
+ "description": "Version: 26.2.0.cl or later
\n\nContact support url (HTTP/HTTPS only).
Version: 26.2.0.cl or later",
+ "nullable": true
},
- "user_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Object_ID_And_Name"
- },
- "description": "Unique ID or name of the User groups which are associated with the custom action.",
+ "hide_contact_support_url": {
+ "type": "boolean",
+ "description": "Version: 26.2.0.cl or later
\n\nWhether to hide contact support url.
Version: 26.2.0.cl or later",
+ "nullable": true
+ },
+ "hide_logo_url": {
+ "type": "boolean",
+ "description": "Version: 26.4.0.cl or later
\n\nWhether to hide logo
Version: 26.4.0.cl or later",
"nullable": true
}
},
- "description": "Custom action details"
+ "description": "Email customization configuration properties"
},
- "Action_details": {
+ "ExternalTableInput": {
"type": "object",
+ "required": ["connection_identifier", "table_name"],
"properties": {
- "CALLBACK": {
- "$ref": "#/components/schemas/CALLBACK",
- "description": "CALLBACK Custom Action Type",
+ "connection_identifier": {
+ "type": "string",
+ "description": "Unique ID or name of the connection."
+ },
+ "database_name": {
+ "type": "string",
+ "default": "",
+ "description": "Name of the database.",
"nullable": true
},
- "URL": {
- "$ref": "#/components/schemas/URL",
- "description": "URL Custom Action Type",
+ "schema_name": {
+ "type": "string",
+ "default": "",
+ "description": "Name of the schema.",
"nullable": true
+ },
+ "table_name": {
+ "type": "string",
+ "description": "Name of the table. Table names may be case-sensitive depending on the database system."
}
- },
- "description": "Type and Configuration for Custom Actions"
+ }
},
- "CALLBACK": {
+ "PolicyProcessOptionsInput": {
"type": "object",
"properties": {
- "reference": {
+ "impersonate_user": {
"type": "string",
- "description": "Reference name of the SDK. By default, the value will be set to action name.",
"nullable": true
}
- },
- "description": "CALLBACK Custom Action Type"
+ }
},
- "URL": {
+ "WebhookAuthenticationInput": {
"type": "object",
- "required": [
- "url"
- ],
"properties": {
- "authentication": {
- "$ref": "#/components/schemas/Authentication",
- "description": "Authorization type for the custom action.",
+ "API_KEY": {
+ "$ref": "#/components/schemas/WebhookAuthApiKeyInput",
+ "description": "API key authentication configuration.",
"nullable": true
},
- "parameters": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ParametersListItem"
- },
- "description": "Query parameters for url.",
+ "BASIC_AUTH": {
+ "$ref": "#/components/schemas/WebhookAuthBasicAuthInput",
+ "description": "Basic authentication configuration.",
"nullable": true
},
- "url": {
+ "BEARER_TOKEN": {
"type": "string",
- "description": "Request Url for the Custom action."
+ "description": "Bearer token authentication configuration.",
+ "nullable": true
},
- "reference": {
+ "OAUTH2": {
+ "$ref": "#/components/schemas/WebhookAuthOAuth2Input",
+ "description": "OAuth2 authentication configuration.",
+ "nullable": true
+ }
+ }
+ },
+ "WebhookAuthApiKeyInput": {
+ "type": "object",
+ "required": ["key", "value"],
+ "properties": {
+ "key": {
"type": "string",
- "description": "Reference name of the SDK. By default, the value will be set to action name.",
+ "description": "The header or query parameter name for the API key."
+ },
+ "value": {
+ "type": "string",
+ "description": "The API key value."
+ }
+ }
+ },
+ "WebhookAuthBasicAuthInput": {
+ "type": "object",
+ "required": ["username", "password"],
+ "properties": {
+ "username": {
+ "type": "string",
+ "description": "Username for basic authentication."
+ },
+ "password": {
+ "type": "string",
+ "description": "Password for basic authentication."
+ }
+ }
+ },
+ "WebhookAuthOAuth2Input": {
+ "type": "object",
+ "required": ["authorization_url", "client_id", "client_secret"],
+ "properties": {
+ "authorization_url": {
+ "type": "string",
+ "description": "OAuth2 authorization server URL."
+ },
+ "client_id": {
+ "type": "string",
+ "description": "OAuth2 client identifier."
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "OAuth2 client secret key."
+ }
+ }
+ },
+ "WebhookSignatureVerificationInput": {
+ "type": "object",
+ "required": ["type", "header", "algorithm", "secret"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["HMAC_SHA256"],
+ "description": "Signature verification method type."
+ },
+ "header": {
+ "type": "string",
+ "description": "HTTP header where the signature is sent."
+ },
+ "algorithm": {
+ "type": "string",
+ "enum": ["SHA256"],
+ "description": "Hash algorithm used for signature verification."
+ },
+ "secret": {
+ "type": "string",
+ "description": "Shared secret used for HMAC signature generation."
+ }
+ }
+ },
+ "StorageDestinationInput": {
+ "type": "object",
+ "required": ["storage_type", "storage_config"],
+ "properties": {
+ "storage_type": {
+ "type": "string",
+ "enum": ["AWS_S3"],
+ "description": "Type of storage destination.\nExample: \"AWS_S3\""
+ },
+ "storage_config": {
+ "$ref": "#/components/schemas/StorageConfigInput",
+ "description": "Storage-specific configuration settings.\nExample: {\"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/\"}}"
+ }
+ },
+ "description": "Input type for storage destination configuration."
+ },
+ "StorageConfigInput": {
+ "type": "object",
+ "properties": {
+ "aws_s3_config": {
+ "$ref": "#/components/schemas/AwsS3ConfigInput",
+ "description": "AWS S3 storage configuration.\nExample: {\"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/\"}",
"nullable": true
}
},
- "description": "URL Custom Action Type"
+ "description": "Input type for storage configuration."
},
- "Authentication": {
+ "AwsS3ConfigInput": {
"type": "object",
+ "required": ["bucket_name", "region", "role_arn"],
"properties": {
- "API_Key": {
- "$ref": "#/components/schemas/API_Key",
- "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.",
- "nullable": true
+ "bucket_name": {
+ "type": "string",
+ "description": "Name of the S3 bucket where webhook payloads will be stored.\nExample: \"my-webhook-files\""
},
- "Basic_Auth": {
- "$ref": "#/components/schemas/Basic_Auth",
- "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.",
- "nullable": true
+ "region": {
+ "type": "string",
+ "description": "AWS region where the S3 bucket is located.\nExample: \"us-west-2\""
},
- "Bearer_Token": {
+ "role_arn": {
"type": "string",
- "description": "Bearer tokens enable requests to authenticate using an access key.",
+ "description": "ARN of the IAM role to assume for S3 access.\nExample: \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\""
+ },
+ "external_id": {
+ "type": "string",
+ "description": "External ID for secure cross-account role assumption.\nExample: \"ts-webhook-a1b2c3d4-7890\"",
"nullable": true
},
- "No_Auth": {
+ "path_prefix": {
"type": "string",
- "description": "No authorization. If your request doesn't require authorization.",
+ "description": "Optional path prefix for organizing objects within the bucket.\nExample: \"thoughtspot-webhooks/\"",
"nullable": true
}
},
- "description": "Authorization type for the custom action."
+ "description": "Input type for AWS S3 storage configuration."
},
- "API_Key": {
+ "WebhookDeleteResponse": {
"type": "object",
+ "required": [
+ "deleted_count",
+ "failed_count",
+ "deleted_webhooks",
+ "failed_webhooks"
+ ],
"properties": {
- "key": {
- "type": "string",
- "description": "Enter your key name",
- "nullable": true
+ "deleted_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of webhooks successfully deleted."
},
- "value": {
- "type": "string",
- "description": "Enter you key value",
- "nullable": true
+ "failed_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of webhooks that failed to delete."
+ },
+ "deleted_webhooks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WebhookResponse"
+ },
+ "description": "List of successfully deleted webhooks."
+ },
+ "failed_webhooks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WebhookDeleteFailure"
+ },
+ "description": "List of webhooks that failed to delete with error details."
}
- },
- "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters."
+ }
},
- "Basic_Auth": {
+ "WebhookDeleteFailure": {
"type": "object",
+ "required": ["id", "name", "error"],
"properties": {
- "password": {
+ "id": {
"type": "string",
- "description": "Password for the basic authentication",
- "nullable": true
+ "description": "Unique identifier of the webhook that failed to delete."
},
- "username": {
+ "name": {
"type": "string",
- "description": "Username for the basic authentication",
- "nullable": true
+ "description": "Name of the webhook that failed to delete."
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message describing why the deletion failed."
+ }
+ }
+ },
+ "Runtime_Filter": {
+ "type": "object",
+ "properties": {
+ "runtime_filter": {
+ "type": "object",
+ "description": "Runtime filter parameter type in JWT."
}
},
- "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request."
+ "description": "List of runtime parameters need to set during the session."
},
- "ParametersListItem": {
+ "Runtime_Sort": {
"type": "object",
"properties": {
- "key": {
- "type": "string",
- "description": "Key for the url query parameter",
- "nullable": true
- },
- "value": {
- "type": "string",
- "description": "Value for the url query parameter",
- "nullable": true
+ "runtime_sort": {
+ "type": "object",
+ "description": "Runtime sort parameter type in JWT."
}
- }
+ },
+ "description": "List of runtime parameters need to set during the session."
},
- "Default_action_config": {
+ "Runtime_Param_Override": {
"type": "object",
"properties": {
- "visibility": {
- "type": "boolean",
- "description": "Custom action is available on all visualizations. Earlier , the naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.",
- "nullable": true
+ "runtime_param_override": {
+ "type": "object",
+ "description": "Runtime param override type in JWT."
}
},
- "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
+ "description": "List of runtime parameters need to set during the session."
},
- "Metadata_Association_Item": {
+ "CreateAgentConversationRequest": {
"type": "object",
- "required": [
- "action_config",
- "identifier",
- "type"
- ],
"properties": {
- "action_config": {
- "$ref": "#/components/schemas/Action_config",
- "description": "Specify that the association is enabled for the metadata object"
- },
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata."
+ "metadata_context": {
+ "description": "Context for the conversation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ContextPayloadV2Input"
+ }
+ ]
},
- "type": {
- "type": "string",
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier."
+ "conversation_settings": {
+ "description": "Conversation settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConversationSettingsInput"
+ }
+ ]
}
- }
+ },
+ "required": ["metadata_context", "conversation_settings"]
},
- "Action_config": {
+ "CreateConversationRequest": {
"type": "object",
"properties": {
- "position": {
- "type": "string",
- "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.",
- "nullable": true
+ "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"
},
- "visibility": {
- "type": "boolean",
- "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled",
- "nullable": true
+ "tokens": {
+ "description": "Token string to set the context for the conversation. For example,`[sales],[item type],[state]`.",
+ "type": "string"
}
},
- "description": "Specify that the association is enabled for the metadata object"
+ "required": ["metadata_identifier"]
},
- "CustomActionMetadataTypeInput": {
+ "GetDataSourceSuggestionsRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "VISUALIZATION",
- "ANSWER",
- "WORKSHEET"
- ],
- "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
- "nullable": true
- },
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata object."
+ "query": {
+ "description": "User query used to suggest data sources.",
+ "type": "string"
}
},
- "description": "MetadataType InputType used in Custom Action API's"
+ "required": ["query"]
},
- "Input_eureka_NLSRequest": {
+ "GetNLInstructionsRequest": {
"type": "object",
"properties": {
- "agentVersion": {
+ "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",
- "description": "Cluster version like 10.4.0.cl, 10.5.0.cl, so on.",
- "nullable": true
+ "format": "int32"
},
- "bypassCache": {
+ "bypass_cache": {
+ "description": "If true, results are not returned from cache & calculated every time.",
"type": "boolean",
- "description": "If true, results are not returned from cache & calculated every time. Can incur high costs & latency.",
"nullable": true
},
- "instructions": {
+ "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"
- },
- "description": "User specific instructions for processing the @query.",
- "nullable": true
+ }
},
- "query": {
- "type": "string",
- "description": "User query which is a topical/goal oriented question that needs to be broken down into smaller simple analytical questions.",
- "nullable": true
+ "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"
+ }
}
}
},
- "eureka_DecomposeQueryResponse": {
+ "SendAgentMessageRequest": {
"type": "object",
"properties": {
- "decomposedQueryResponse": {
- "$ref": "#/components/schemas/eureka_LLMDecomposeQueryResponse",
- "description": "Decomposed query response for a topical/goal oriented question that contains broken down analytical questions.",
- "nullable": true
+ "messages": {
+ "description": "messages to be sent to the agent",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- }
+ },
+ "required": ["messages"]
},
- "eureka_LLMDecomposeQueryResponse": {
+ "SendAgentMessageStreamingRequest": {
"type": "object",
"properties": {
- "decomposedQueries": {
+ "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": {
- "$ref": "#/components/schemas/eureka_LLMSuggestedQuery"
- },
- "description": "List of analytical questions that can be run on their respective worksheet/data sources.",
- "nullable": true
+ "type": "string"
+ }
}
- }
+ },
+ "required": ["conversation_identifier", "messages"]
},
- "eureka_LLMSuggestedQuery": {
+ "SendMessageRequest": {
"type": "object",
"properties": {
- "query": {
- "type": "string",
- "description": "NL query that can be run using spotter aka natural language search to get an AI generated answer.",
- "nullable": true
+ "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"
},
- "worksheetId": {
- "type": "string",
- "description": "Unique identifier of the worksheet on which this query can be run on.",
- "nullable": true
+ "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"
},
- "worksheetName": {
- "type": "string",
- "description": "Display name of the worksheet on which this query can be run on.",
- "nullable": true
+ "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"]
},
- "RiseGQLArgWrapper": {
+ "SingleAnswerRequest": {
"type": "object",
- "required": [
- "name",
- "type"
- ],
"properties": {
- "name": {
+ "query": {
+ "description": "A natural language query string to generate the Answer.",
"type": "string"
},
- "type": {
+ "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"]
},
- "VariableDetailInput": {
+ "GetCustomAccessTokenRequest": {
"type": "object",
"properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the variable",
- "nullable": true
+ "username": {
+ "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.",
+ "type": "string"
},
- "type": {
- "type": "string",
- "enum": [
- "CONNECTION_PROPERTY",
- "TABLE_MAPPING",
- "CONNECTION_PROPERTY_PER_PRINCIPAL"
- ],
- "description": "Type of variable",
- "nullable": true
+ "password": {
+ "description": "Password of the user account",
+ "default": "",
+ "type": "string"
},
- "name_pattern": {
+ "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",
- "description": "A pattern to match case-insensitive name of the variable. User % for a wildcard match",
+ "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
}
},
- "description": "Input for variable details in search"
+ "required": ["username", "persist_option"]
},
- "Variable": {
+ "GetFullAccessTokenRequest": {
"type": "object",
- "required": [
- "id",
- "name"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of the variable"
+ "username": {
+ "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.",
+ "type": "string"
},
- "name": {
- "type": "string",
- "description": "Name of the variable"
+ "password": {
+ "description": "Password of the user account",
+ "default": "",
+ "type": "string"
},
- "variable_type": {
- "type": "string",
- "enum": [
- "CONNECTION_PROPERTY",
- "TABLE_MAPPING",
- "CONNECTION_PROPERTY_PER_PRINCIPAL"
- ],
- "description": "Type of the variable",
- "nullable": true
+ "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"
},
- "sensitive": {
+ "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",
- "description": "If the variable is sensitive",
"nullable": true
},
- "values": {
+ "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": {
- "$ref": "#/components/schemas/VariableValue"
- },
- "description": "Values of the variable",
- "nullable": true
+ "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"
+ }
+ ]
}
},
- "description": "Variable object"
+ "required": ["username"]
},
- "VariableValue": {
+ "GetObjectAccessTokenRequest": {
"type": "object",
- "required": [
- "org_identifier"
- ],
"properties": {
- "value": {
- "type": "string",
- "description": "The value of the variable",
- "nullable": true
+ "username": {
+ "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.",
+ "type": "string"
},
- "org_identifier": {
- "type": "string",
- "description": "The unique name of the org"
+ "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"
},
- "principal_type": {
- "type": "string",
- "enum": [
- "USER",
- "USER_GROUP"
- ],
- "description": "Principal type",
- "nullable": true
+ "password": {
+ "description": "Password of the user account",
+ "default": "",
+ "type": "string"
},
- "principal_identifier": {
- "type": "string",
- "description": "Unique ID or name of the principal",
- "nullable": true
+ "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"
},
- "priority": {
+ "validity_time_in_sec": {
+ "description": "Token validity duration in seconds",
+ "default": 300,
"type": "integer",
- "format": "int32",
- "description": "The priority assigned to this value. If there are 2 matching values, the one with the higher priority will be picked.",
+ "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"]
},
- "GenericInfo": {
+ "LoginRequest": {
"type": "object",
"properties": {
- "id": {
- "type": "string",
- "nullable": true
+ "username": {
+ "description": "Username of the ThoughtSpot user",
+ "type": "string"
},
- "name": {
- "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
}
}
},
- "UserGroup": {
+ "RevokeTokenRequest": {
"type": "object",
"properties": {
- "id": {
- "type": "string",
- "nullable": true
+ "user_identifier": {
+ "type": "string"
},
- "name": {
- "type": "string",
- "nullable": true
+ "token": {
+ "type": "string"
}
}
},
- "JWT_User_Options": {
+ "ValidateTokenRequest": {
"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
+ "token": {
+ "type": "string"
}
},
- "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.*"
+ "required": ["token"]
},
- "JWT_Parameter": {
+ "ConnectionConfigurationSearchRequest": {
"type": "object",
"properties": {
- "runtime_filter": {
- "type": "object",
- "description": "Runtime filter parameter type in JWT.",
- "nullable": true
+ "connection_identifier": {
+ "description": "Unique ID or name of the connection.",
+ "type": "string"
},
- "runtime_sort": {
- "type": "object",
- "description": "Runtime sort parameter type in JWT.",
- "nullable": true
+ "configuration_identifier": {
+ "description": "Unique ID or name of the configuration.",
+ "type": "string"
},
- "runtime_param_override": {
- "type": "object",
- "description": "Runtime param override type in JWT.",
- "nullable": true
+ "policy_type": {
+ "description": "Type of policy.",
+ "type": "string",
+ "enum": ["NO_POLICY", "PRINCIPALS", "PROCESSES"]
}
},
- "description": "List of runtime parameters need to set during the session."
+ "required": ["connection_identifier"]
},
- "JWT_Metadata_Object": {
+ "CreateConnectionConfigurationRequest": {
"type": "object",
"properties": {
- "identifier": {
- "type": "string",
+ "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
},
- "type": {
+ "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": [
- "LOGICAL_TABLE"
- ],
- "nullable": true
- }
- },
- "description": "Metadata objects."
- },
- "User_Parameter_Options": {
- "type": "object",
- "properties": {
- "objects": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User_Object"
- },
- "nullable": true
+ "SERVICE_ACCOUNT",
+ "KEY_PAIR",
+ "PERSONAL_ACCESS_TOKEN",
+ "OAUTH_WITH_SERVICE_PRINCIPAL",
+ "OAUTH_CLIENT_CREDENTIALS"
+ ]
},
- "runtime_filters": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Runtime_Filters"
- },
- "description": "Objects to apply the User_Runtime_Filters.\n\nExamples to set the `runtime_filters` :\n```json\n{ \"column_name\": \"Color\", \"operator\": \"EQ\", \"values\": [\"red\"], \"persist\": false }\n```",
- "nullable": true
+ "configuration": {
+ "description": "Configuration properties in JSON.",
+ "type": "object"
},
- "runtime_sorts": {
+ "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": {
- "$ref": "#/components/schemas/Runtime_Sorts"
- },
- "description": "Objects to apply the User_Runtime_Sorts.\n\nExamples to set the `runtime_sorts` :\n```json\n{ \"column_name\": \"Color\", \"order\": \"ASC\", \"persist\": false }\n```",
- "nullable": true
+ "type": "string"
+ }
},
- "parameters": {
+ "policy_processes": {
+ "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING and ROW_COUNT_STATS.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/Runtime_Parameters"
- },
- "description": "Objects to apply the Runtime_Parameters.\n\nExamples to set the `parameters` :\n```json\n{ \"name\": \"Color\", \"values\": [\"Blue\"], \"persist\": false }\n```",
- "nullable": true
+ "type": "string",
+ "enum": ["SAGE_INDEXING", "ROW_COUNT_STATS"]
+ }
}
},
- "description": "Define 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).\n"
+ "required": ["name", "connection_identifier", "configuration"]
},
- "User_Object": {
+ "DeleteConnectionConfigurationRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "LOGICAL_TABLE"
- ],
- "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n \n\n Specify the object type as `LOGICAL_TABLE`. The `LIVEBOARD` and `ANSWER` object types are not supported.",
- "nullable": true
+ "configuration_identifier": {
+ "description": "Unique ID or name of the configuration.",
+ "type": "string"
},
- "identifier": {
- "type": "string",
- "description": "Unique name/id of the object."
+ "connection_identifier": {
+ "description": "Unique ID or name of the connection.",
+ "type": "string"
}
},
- "description": "Objects to apply the User_Object."
+ "required": ["configuration_identifier", "connection_identifier"]
},
- "Runtime_Filters": {
+ "UpdateConnectionConfigurationRequest": {
"type": "object",
- "required": [
- "column_name",
- "values",
- "operator"
- ],
"properties": {
- "column_name": {
- "type": "string",
- "description": "The column name to apply filter."
+ "connection_identifier": {
+ "description": "Unique ID or name of the connection.",
+ "type": "string"
},
- "values": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Value of the filters."
+ "name": {
+ "description": "Name of the configuration to update.",
+ "type": "string"
},
- "operator": {
- "type": "string",
- "enum": [
- "EQ",
- "NE",
- "LT",
- "LE",
- "GT",
- "GE",
- "IN",
- "BW",
- "CONTAINS",
- "BEGINS_WITH",
- "ENDS_WITH",
- "BW_INC",
- "BW_INC_MIN",
- "BW_INC_MAX",
- "LIKE",
- "NOT_IN"
- ],
- "description": "Operator value. Example: EQ"
+ "description": {
+ "description": "Description of the configuration.",
+ "type": "string"
},
- "persist": {
- "type": "boolean",
+ "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,
- "description": "Flag to persist the runtime filters.
Version: 9.12.0.cl or later",
+ "type": "boolean",
"nullable": true
},
- "objects": {
+ "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": {
- "$ref": "#/components/schemas/User_Object"
- },
- "description": "Object to apply the runtime filter.",
+ "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
}
},
- "description": "Objects to apply the Runtime_Filters."
+ "required": ["connection_identifier"]
},
- "Runtime_Sorts": {
+ "CreateConnectionRequest": {
"type": "object",
"properties": {
- "column_name": {
- "type": "string",
- "description": "The column name to apply filter.",
- "nullable": true
+ "name": {
+ "description": "Unique name for the connection.",
+ "type": "string"
},
- "order": {
+ "description": {
+ "description": "Description of the connection.",
+ "type": "string"
+ },
+ "data_warehouse_type": {
+ "description": "Type of the data warehouse.",
"type": "string",
"enum": [
- "ASC",
- "DESC"
- ],
- "description": "Order for the sort.",
- "nullable": true
+ "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"
+ ]
},
- "persist": {
- "type": "boolean",
- "default": false,
- "description": "Flag to persist the runtime sorts.
Version: 9.12.0.cl or later",
- "nullable": true
+ "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"
},
- "objects": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User_Object"
- },
- "description": "Object to apply the runtime sort.",
+ "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
}
},
- "description": "Objects to apply the Runtime_Sorts."
+ "required": ["name", "data_warehouse_type", "data_warehouse_config"]
},
- "Runtime_Parameters": {
+ "DeleteConnectionRequest": {
"type": "object",
- "required": [
- "name",
- "values"
- ],
"properties": {
- "name": {
- "type": "string",
- "description": "The name of the parameter."
- },
- "values": {
+ "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"
- },
- "description": "The array of values."
+ }
},
- "persist": {
- "type": "boolean",
- "default": false,
- "description": "Flag to persist the parameters.
Version: 9.12.0.cl or later",
- "nullable": true
+ "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"
+ }
},
- "objects": {
+ "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": {
- "$ref": "#/components/schemas/User_Object"
- },
- "description": "Object to apply the runtime parameter.",
- "nullable": true
+ "type": "string"
+ }
}
- },
- "description": "Objects to apply the Runtime_Parameters."
+ }
},
- "Token": {
+ "SearchConnectionRequest": {
"type": "object",
- "required": [
- "token",
- "creation_time_in_millis",
- "expiration_time_in_millis",
- "scope",
- "valid_for_user_id",
- "valid_for_username"
- ],
"properties": {
- "token": {
+ "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",
- "description": "Bearer auth token."
+ "enum": ["DATABASE", "SCHEMA", "TABLE", "COLUMN"]
},
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token creation time in milliseconds."
+ "sort_options": {
+ "description": "Sort options.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SortOptionInput"
+ }
+ ]
},
- "expiration_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token expiration time in milliseconds."
+ "include_details": {
+ "description": "Indicates whether to include complete details of the connection objects.",
+ "type": "boolean",
+ "nullable": true
},
- "scope": {
- "$ref": "#/components/schemas/Scope",
- "description": "Token access scope details"
+ "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"
},
- "valid_for_user_id": {
+ "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",
- "description": "Username to whom the token is issued."
+ "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"
+ ]
},
- "valid_for_username": {
- "type": "string",
- "description": "Unique identifier of the user to whom the token is issued."
+ "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
}
}
},
- "Scope": {
+ "UpdateConnectionRequest": {
"type": "object",
- "required": [
- "access_type"
- ],
"properties": {
- "access_type": {
- "type": "string",
- "description": "Object access scope type."
+ "connection_identifier": {
+ "description": "Unique ID or name of the connection.",
+ "type": "string"
},
- "org_id": {
- "type": "integer",
- "format": "int32",
- "description": "Unique identifier of the metadata.",
+ "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"
},
- "metadata_id": {
- "type": "string",
- "description": "Unique identifier of the Org.",
+ "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
}
}
},
- "JWT_User_Options_Full": {
+ "CreateCustomActionRequest": {
"type": "object",
"properties": {
- "parameters": {
+ "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/JWT_Parameter"
- },
- "nullable": true
+ "$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"
+ }
}
},
- "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.*"
+ "required": ["name", "action_details"]
},
- "TokenValidationResponse": {
+ "SearchCustomActionsRequest": {
"type": "object",
- "required": [
- "creation_time_in_millis",
- "expiration_time_in_millis",
- "scope",
- "valid_for_user_id",
- "token_type"
- ],
"properties": {
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token creation time in milliseconds."
+ "custom_action_identifier": {
+ "description": "Name or ID of the custom action.",
+ "type": "string"
},
- "expiration_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token expiration time in milliseconds."
+ "name_pattern": {
+ "description": "A pattern to match case-insensitive name of the custom-action object.",
+ "type": "string"
},
- "scope": {
- "$ref": "#/components/schemas/Scope",
- "description": "Token access scope details"
+ "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"
+ }
+ ]
},
- "valid_for_user_id": {
- "type": "string",
- "description": "Username to whom the token is issued."
+ "include_group_associations": {
+ "description": "When set to true, returns the associated groups for a custom action.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
},
- "token_type": {
+ "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",
- "description": "Type of token."
+ "enum": ["CALLBACK", "URL"]
}
}
},
- "FilterRules": {
+ "UpdateCustomActionRequest": {
"type": "object",
- "required": [
- "column_name",
- "operator",
- "values"
- ],
"properties": {
- "column_name": {
- "type": "string",
- "description": "The name of the column to apply the filter on."
+ "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"
+ }
+ ]
},
- "operator": {
- "type": "string",
- "enum": [
- "EQ",
- "NE",
- "LT",
- "LE",
- "GT",
- "GE",
- "IN",
- "BW",
- "CONTAINS",
- "BEGINS_WITH",
- "ENDS_WITH",
- "BW_INC",
- "BW_INC_MIN",
- "BW_INC_MAX",
- "LIKE",
- "NOT_IN"
- ],
- "description": "The operator to use for filtering. Example: EQ (equals), GT(greater than), etc."
+ "associate_metadata": {
+ "description": "Metadata objects to which the custom action needs to be associated.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Associate_Metadata_Input"
+ }
},
- "values": {
+ "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": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "boolean"
- },
- {
- "type": "number"
- }
- ]
- },
- "description": "The values to filter on. To get all records, use TS_WILDCARD_ALL as values."
+ "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"]
}
- },
- "description": "Filter Rules to be applied on Objects."
+ }
},
- "ParameterValues": {
+ "CreateCalendarRequest": {
"type": "object",
- "required": [
- "name",
- "values"
- ],
"properties": {
"name": {
+ "description": "Name of the custom calendar.",
+ "type": "string"
+ },
+ "creation_method": {
+ "description": "Type of create operation.",
"type": "string",
- "description": "The name of the column to apply the filter on."
+ "enum": ["FROM_INPUT_PARAMS", "FROM_EXISTING_TABLE"]
},
- "values": {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "boolean"
- },
- {
- "type": "number"
- }
- ]
- },
- "description": "The values to filter on. Only single value is supported currently."
- }
- },
- "description": "Filter Rules to be applied on Objects."
- },
- "TokenAccessScopeObject": {
- "type": "object",
- "required": [
- "identifier"
- ],
- "properties": {
- "type": {
+ "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": [
- "LOGICAL_TABLE"
- ],
- "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n \n\n Specify the object type as `LOGICAL_TABLE`. The `LIVEBOARD` and `ANSWER` object types are not supported.",
- "nullable": true
+ "MONTH_OFFSET",
+ "FOUR_FOUR_FIVE",
+ "FOUR_FIVE_FOUR",
+ "FIVE_FOUR_FOUR"
+ ]
},
- "identifier": {
+ "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",
- "description": "Unique name/id of the object."
- }
- },
- "description": "Objects on which the filter rules and parameters values should be applied to"
- },
- "Group_Object": {
- "type": "object",
- "properties": {
- "identifier": {
+ "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",
- "nullable": true
+ "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"
}
},
- "description": "Groups objects."
+ "required": ["name", "creation_method", "table_reference"]
},
- "AccessToken": {
+ "GenerateCSVRequest": {
"type": "object",
- "required": [
- "token",
- "org",
- "user",
- "creation_time_in_millis",
- "expiration_time_in_millis"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "GUID of the auth token.",
- "nullable": true
+ "start_date": {
+ "description": "Start date for the calendar in `MM/dd/yyyy` format.",
+ "type": "string"
},
- "token": {
+ "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",
- "description": "Bearer auth token."
+ "enum": [
+ "MONTH_OFFSET",
+ "FOUR_FOUR_FIVE",
+ "FOUR_FIVE_FOUR",
+ "FIVE_FOUR_FOUR"
+ ]
},
- "org": {
- "$ref": "#/components/schemas/OrgInfo",
- "description": "Org information for which the token is generated."
+ "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"
+ ]
},
- "user": {
- "$ref": "#/components/schemas/UserInfo",
- "description": "User information for which the token is generated."
+ "start_day_of_week": {
+ "description": "Specify the starting day of the week.",
+ "default": "Sunday",
+ "type": "string",
+ "enum": [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ]
},
- "creation_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token creation time in milliseconds."
+ "quarter_name_prefix": {
+ "description": "Prefix to add before the quarter.",
+ "type": "string"
},
- "expiration_time_in_millis": {
- "type": "number",
- "format": "float",
- "description": "Token expiration time in milliseconds."
+ "year_name_prefix": {
+ "description": "Prefix to add before the year.",
+ "type": "string"
}
- }
+ },
+ "required": ["start_date", "end_date"]
},
- "OrgInfo": {
+ "SearchCalendarsRequest": {
"type": "object",
- "required": [
- "id"
- ],
"properties": {
- "id": {
+ "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",
- "description": "Id."
+ "format": "int32"
},
- "name": {
- "type": "string",
- "description": "Name.",
- "nullable": true
+ "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"
+ }
+ ]
}
}
},
- "UserInfo": {
+ "UpdateCalendarRequest": {
"type": "object",
- "required": [
- "id"
- ],
"properties": {
- "id": {
+ "update_method": {
+ "description": "Type of update operation.",
+ "default": "FROM_INPUT_PARAMS",
"type": "string",
- "description": "Id."
+ "enum": ["FROM_INPUT_PARAMS", "FROM_EXISTING_TABLE"]
},
- "name": {
+ "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",
- "description": "Name.",
- "nullable": true
- }
- }
- },
- "ResponseActivationURL": {
- "type": "object",
- "properties": {
- "activation_link": {
+ "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",
- "description": "Activation link to activate the user.",
- "nullable": true
+ "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"
}
},
- "description": "The object representation with activation link."
+ "required": ["table_reference"]
},
- "ImportUser": {
+ "FetchAnswerDataRequest": {
"type": "object",
- "required": [
- "user_identifier",
- "display_name"
- ],
"properties": {
- "user_identifier": {
- "type": "string",
- "description": "Unique ID or name of the user."
+ "metadata_identifier": {
+ "description": "GUID or name of the Answer.",
+ "type": "string"
},
- "display_name": {
+ "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",
- "description": "Display name of the user."
+ "enum": ["FULL", "COMPACT"]
},
- "password": {
- "type": "string",
- "description": "Password of the user.",
- "nullable": true
+ "record_offset": {
+ "description": "The starting record number from where the records should be included.",
+ "default": 0,
+ "type": "integer",
+ "format": "int32"
},
- "account_type": {
- "type": "string",
- "enum": [
- "LOCAL_USER",
- "LDAP_USER",
- "SAML_USER",
- "OIDC_USER",
- "REMOTE_USER"
- ],
- "default": "LOCAL_USER",
- "description": "Type of the user account.",
- "nullable": true
+ "record_size": {
+ "description": "The number of records to include in a batch.",
+ "default": 10,
+ "type": "integer",
+ "format": "int32"
},
- "account_status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "INACTIVE",
- "EXPIRED",
- "LOCKED",
- "PENDING",
- "SUSPENDED"
- ],
- "default": "ACTIVE",
- "description": "Status of the user account.",
- "nullable": true
+ "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"
},
- "email": {
- "type": "string",
- "description": "Email address of the user.",
- "nullable": true
+ "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"
},
- "org_identifiers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "ID or name of the Orgs to which the user belongs.",
- "nullable": true
+ "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"
},
- "group_identifiers": {
+ "visualization_identifiers": {
+ "description": "GUIDs or names of the visualizations on the Liveboard.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "ID or name of the groups to which the user belongs.",
- "nullable": true
+ }
},
- "visibility": {
+ "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": [
- "SHARABLE",
- "NON_SHARABLE"
- ],
- "description": "Visibility of the users. The SHARABLE property makes a user visible to other users and group, who can share objects with the user.",
- "nullable": true
+ "enum": ["FULL", "COMPACT"]
},
- "notify_on_share": {
- "type": "boolean",
- "default": true,
- "description": "Notify user when other users or groups share metadata objects",
- "nullable": true
+ "record_offset": {
+ "description": "The starting record number from where the records should be included.",
+ "default": 0,
+ "type": "integer",
+ "format": "int32"
},
- "show_onboarding_experience": {
- "type": "boolean",
- "description": "Show or hide the new user onboarding walkthroughs",
- "nullable": true
+ "record_size": {
+ "description": "The number of records to include in a batch.",
+ "default": 10,
+ "type": "integer",
+ "format": "int32"
},
- "onboarding_experience_completed": {
- "type": "boolean",
- "description": "Revisit the new user onboarding walkthroughs",
- "nullable": true
+ "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"
},
- "home_liveboard_identifier": {
+ "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",
- "description": "Unique ID or name of the default Liveboard assigned to the user.",
- "nullable": true
+ "enum": ["FULL", "COMPACT"]
},
- "favorite_metadata": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FavoriteMetadataInput"
- },
- "description": "Metadata objects to add to the user's favorites list.",
- "nullable": true
+ "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"]
},
- "ImportUsersResponse": {
+ "DeleteOrgEmailCustomizationRequest": {
"type": "object",
"properties": {
- "users_added": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ImportUserType"
- },
- "nullable": true
- },
- "users_updated": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ImportUserType"
- },
- "nullable": true
- },
- "users_deleted": {
+ "org_identifiers": {
+ "description": "Unique identifier of the organization.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportUserType"
- },
- "nullable": true
+ "type": "string"
+ }
}
}
},
- "ImportUserType": {
+ "SearchEmailCustomizationRequest": {
"type": "object",
- "required": [
- "name"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of the user.",
- "nullable": true
- },
- "name": {
- "type": "string",
- "description": "Name of the user."
+ "org_identifiers": {
+ "description": "Unique ID or name of org
Version: 10.12.0.cl or later",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
}
},
- "TagMetadataTypeInput": {
+ "UpdateEmailCustomizationRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n 1. LIVEBOARD\n 2. ANSWERS\n 3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n 4. LOGICAL_COLUMN for a column of any data object such as tables, worksheets or views.",
- "nullable": true
+ "template_properties": {
+ "description": "Email customization configuration as key value pair",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Template_Properties_Input_Create"
+ }
+ ]
},
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata."
+ "org_identifier": {
+ "description": "Unique ID or name of org",
+ "type": "string"
}
- }
+ },
+ "required": ["template_properties"]
},
- "GroupsImportListInput": {
+ "CreateUserGroupRequest": {
"type": "object",
- "required": [
- "display_name",
- "group_identifier"
- ],
"properties": {
- "display_name": {
- "type": "string",
- "description": "Unique display name of the group."
+ "name": {
+ "description": "Name of the group. The group name must be unique.",
+ "type": "string"
},
- "group_identifier": {
- "type": "string",
- "description": "Unique ID or name of the group."
+ "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": "Unique ID of Liveboards that will be assigned as default Liveboards to the users in the group.",
- "nullable": true
+ }
},
"description": {
- "type": "string",
- "description": "Description of the group.",
- "nullable": true
+ "description": "Description of the group",
+ "type": "string"
},
"privileges": {
+ "description": "Privileges to assign to the group",
"type": "array",
"items": {
"type": "string",
@@ -17290,885 +20148,1349 @@
"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_SETUP_VERSION_CONTROL",
+ "CAN_DOWNLOAD_VISUALS",
+ "CAN_DOWNLOAD_DETAILED_DATA",
+ "CAN_USE_SPOTTER"
]
- },
- "description": "Privileges that will be assigned to the group.",
- "nullable": true
+ }
},
"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"
- },
- "description": "Unique ID or name of the sub-groups to add to the group.",
- "nullable": true
+ }
},
"type": {
+ "description": "Group type.",
+ "default": "LOCAL_GROUP",
"type": "string",
- "enum": [
- "LOCAL_GROUP",
- "LDAP_GROUP"
- ],
- "description": "Type of the group.",
- "nullable": true
+ "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"
- },
- "description": "Unique ID or name of the users to assign to the group.",
- "nullable": true
+ }
},
"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"
- ],
- "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects.",
- "nullable": true
- }
- }
- },
- "ImportUserGroupsResponse": {
- "type": "object",
- "required": [
- "groups_added",
- "groups_deleted",
- "groups_updated"
- ],
- "properties": {
- "groups_added": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "The groups which are added into the system."
- },
- "groups_deleted": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "The groups which are deleted from the system."
+ "enum": ["SHARABLE", "NON_SHARABLE"]
},
- "groups_updated": {
+ "role_identifiers": {
+ "description": "Role identifiers of the roles that should be assigned to the group.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/UserGroup"
- },
- "description": "The groups which are updated in the system."
+ "type": "string"
+ }
}
- }
+ },
+ "required": ["name", "display_name"]
},
- "Export_Options": {
+ "ImportUserGroupsRequest": {
"type": "object",
"properties": {
- "include_obj_id_ref": {
- "type": "boolean",
- "default": false,
- "description": "Boolean Flag to export Object ID of referenced object. This flag will work only after the Object ID feature has been enabled. Please contact support to enable the feature.",
- "nullable": true
- },
- "include_guid": {
- "type": "boolean",
- "default": true,
- "description": "Boolean flag to export guid 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
+ "groups": {
+ "description": "Details of groups which are to be imported",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupsImportListInput"
+ }
},
- "include_obj_id": {
- "type": "boolean",
+ "delete_unspecified_groups": {
+ "description": "If set to true, removes groups that are not specified in the API request.",
"default": false,
- "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.",
+ "type": "boolean",
"nullable": true
},
- "export_with_associated_feedbacks": {
+ "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",
- "default": false,
- "description": "Boolean flag indicating whether to export associated feedbacks of the object. This will only be respected when the object can have feedbacks.
Version: 10.7.0.cl or later",
- "nullable": true
- }
- },
- "description": "Flags to specify additional options for export. This will only be active when UserDefinedId in TML is enabled."
- },
- "ResponseCopyObject": {
- "type": "object",
- "properties": {
- "metadata_id": {
- "type": "string",
- "description": "The unique identifier of the object.",
"nullable": true
}
}
},
- "ResponseWorksheetToModelConversion": {
+ "SearchUserGroupsRequest": {
"type": "object",
- "required": [
- "name",
- "success_count",
- "failure_count",
- "incomplete_count",
- "post_upgrade_failed_count",
- "total_time_in_millis",
- "successful_entities",
- "failed_entities",
- "incomplete_entities",
- "post_upgrade_failed_entities"
- ],
"properties": {
- "name": {
+ "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"
},
- "success_count": {
- "type": "integer",
- "format": "int32",
- "description": "The number of worksheets successfully converted to models."
+ "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"]
},
- "failure_count": {
- "type": "integer",
- "format": "int32",
- "description": "The number of worksheets that failed to convert."
+ "user_identifiers": {
+ "description": "GUID or name of the users assigned to the group.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "incomplete_count": {
- "type": "integer",
- "format": "int32",
- "description": "The number of worksheets that were incomplete during the conversion process."
+ "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"]
},
- "post_upgrade_failed_count": {
- "type": "integer",
- "format": "int32",
- "description": "The number of worksheets that failed after an upgrade during the conversion process."
+ "role_identifiers": {
+ "description": "Filter groups with a list of Roles assigned to a group",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "total_time_in_millis": {
+ "record_offset": {
+ "description": "The starting record number from where the records should be included.",
+ "default": 0,
"type": "integer",
- "format": "int32",
- "description": "The total time taken to complete the conversion process in milliseconds."
+ "format": "int32"
},
- "successful_entities": {
- "$ref": "#/components/schemas/ResponseSuccessfulEntities",
- "description": "List of worksheets successfully converted to models."
+ "record_size": {
+ "description": "The number of records that should be included.",
+ "default": 10,
+ "type": "integer",
+ "format": "int32"
},
- "failed_entities": {
- "$ref": "#/components/schemas/ResponseFailedEntities",
- "description": "List of worksheets that failed to convert."
+ "sort_options": {
+ "description": "Sort options to filter group details.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SortOptions"
+ }
+ ]
},
- "incomplete_entities": {
- "$ref": "#/components/schemas/ResponseIncompleteEntities",
- "description": "List of worksheets that were incomplete during the conversion."
+ "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
},
- "post_upgrade_failed_entities": {
- "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntities",
- "description": "List of worksheets that failed after an upgrade during the conversion process."
+ "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
}
- },
- "description": "Name of the conversion process, which involves converting worksheets to models."
+ }
},
- "ResponseSuccessfulEntities": {
+ "UpdateUserGroupRequest": {
"type": "object",
- "required": [
- "data"
- ],
"properties": {
- "data": {
+ "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": {
- "$ref": "#/components/schemas/ResponseSuccessfulEntity"
+ "type": "string"
}
- }
- },
- "description": "Wrapper for the successful entities, as they are inside a 'data' field in the response."
- },
- "ResponseSuccessfulEntity": {
- "type": "object",
- "required": [
- "id",
- "name"
- ],
- "properties": {
- "id": {
+ },
+ "description": {
+ "description": "Description for the group.",
"type": "string"
},
- "name": {
- "type": "string",
- "description": "Name of the worksheet."
- }
- },
- "description": "Unique ID of the worksheet."
- },
- "ResponseFailedEntities": {
- "type": "object",
- "required": [
- "data"
- ],
- "properties": {
- "data": {
+ "display_name": {
+ "description": "Display name of the group.",
+ "type": "string"
+ },
+ "privileges": {
+ "description": "Privileges to assign to the group.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ResponseFailedEntity"
+ "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"
+ ]
}
- }
- },
- "description": "Wrapper for the failed entities, as they are inside a 'data' field in the response."
- },
- "ResponseFailedEntity": {
- "type": "object",
- "required": [
- "id",
- "name",
- "error"
- ],
- "properties": {
- "id": {
- "type": "string"
},
- "name": {
+ "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",
- "description": "Name of the worksheet that failed to convert."
+ "enum": ["LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP"]
},
- "error": {
+ "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",
- "description": "Error details related to the failed conversion."
- }
- },
- "description": "Unique ID of the failed worksheet."
- },
- "ResponseIncompleteEntities": {
- "type": "object",
- "required": [
- "data"
- ],
- "properties": {
- "data": {
+ "enum": ["SHARABLE", "NON_SHARABLE"]
+ },
+ "role_identifiers": {
+ "description": "Role identifiers of the Roles that should be assigned to the group.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ResponseIncompleteEntity"
+ "type": "string"
}
+ },
+ "operation": {
+ "description": "Type of update operation. Default operation type is REPLACE",
+ "default": "REPLACE",
+ "type": "string",
+ "enum": ["ADD", "REMOVE", "REPLACE"]
}
- },
- "description": "Wrapper for the incomplete entities, as they are inside a 'data' field in the response."
+ }
},
- "ResponseIncompleteEntity": {
+ "FetchLogsRequest": {
"type": "object",
- "required": [
- "id",
- "name",
- "error"
- ],
"properties": {
- "id": {
- "type": "string"
- },
- "name": {
+ "log_type": {
+ "description": "Name of the log type",
"type": "string",
- "description": "Name of the incomplete worksheet."
+ "enum": ["SECURITY_AUDIT"]
},
- "error": {
- "type": "string",
- "description": "Error details related to the incomplete conversion."
+ "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
}
},
- "description": "Unique ID of the incomplete worksheet."
+ "required": ["log_type"]
},
- "ResponsePostUpgradeFailedEntities": {
+ "ConvertWorksheetToModelRequest": {
"type": "object",
- "required": [
- "data"
- ],
"properties": {
- "data": {
+ "worksheet_ids": {
+ "description": "List of Worksheet IDs.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntity"
+ "type": "string"
}
- }
- },
- "description": "Wrapper for the post-upgrade failed entities, as they are inside a 'data' field in the response."
- },
- "ResponsePostUpgradeFailedEntity": {
- "type": "object",
- "required": [
- "id",
- "name",
- "error"
- ],
- "properties": {
- "id": {
- "type": "string"
},
- "name": {
- "type": "string",
- "description": "Name of the worksheet that failed post-upgrade."
+ "exclude_worksheet_ids": {
+ "description": "List of Worksheet IDs to be excluded.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "error": {
- "type": "string",
- "description": "Error details related to the post-upgrade failure."
+ "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
}
- },
- "description": "Unique ID of the worksheet that failed post-upgrade."
+ }
},
- "HeaderUpdateInput": {
+ "CopyObjectRequest": {
"type": "object",
- "required": [
- "attributes"
- ],
"properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID of a specified type to identify the header.",
- "nullable": true
+ "description": {
+ "description": "Description of the new object",
+ "type": "string"
},
- "obj_identifier": {
- "type": "string",
- "description": "Custom object identifier to uniquely identify header.",
- "nullable": true
+ "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": [
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "LIVEBOARD",
- "ACTION_OBJECT",
- "DATA_SOURCE",
- "USER",
- "USER_GROUP"
- ],
- "description": "Optional type of the header object.",
- "nullable": true
+ "enum": ["LIVEBOARD", "ANSWER"]
},
- "attributes": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HeaderAttributeInput"
- },
- "description": "List of attributes to update"
+ "title": {
+ "description": "Title of the new object",
+ "type": "string"
}
},
- "description": "Favorite object options."
+ "required": ["identifier"]
},
- "HeaderAttributeInput": {
+ "DeleteMetadataRequest": {
"type": "object",
- "required": [
- "name",
- "value"
- ],
"properties": {
- "name": {
- "type": "string",
- "description": "Attribute name to be updated."
+ "metadata": {
+ "description": "Metadata objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DeleteMetadataTypeInput"
+ }
},
- "value": {
- "type": "string",
- "description": "Attribute's new value."
+ "delete_disabled_objects": {
+ "description": "Indicates whether to delete disabled metadata objects.",
+ "default": false,
+ "type": "boolean",
+ "nullable": true
}
},
- "description": "Attribute to update in a header."
+ "required": ["metadata"]
},
- "UpdateObjIdInput": {
+ "ExportMetadataTMLRequest": {
"type": "object",
- "required": [
- "new_obj_id"
- ],
"properties": {
- "metadata_identifier": {
- "type": "string",
- "description": "GUID or name of the metadata object.",
+ "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
},
- "type": {
- "type": "string",
- "enum": [
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "LIVEBOARD",
- "ACTION_OBJECT",
- "DATA_SOURCE",
- "USER",
- "USER_GROUP"
- ],
- "description": "Type of metadata. Required if metadata_identifier is name of the object.",
+ "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
},
- "current_obj_id": {
+ "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",
- "description": "Current object ID value.",
- "nullable": true
+ "enum": ["JSON", "YAML"]
},
- "new_obj_id": {
+ "export_schema_version": {
+ "description": "Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.",
+ "default": "DEFAULT",
"type": "string",
- "description": "New object ID value to set."
+ "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"
+ }
+ ]
}
},
- "description": "Input for updating object ID of a metadata object."
+ "required": ["metadata"]
},
- "ExportMetadataTypeInput": {
+ "ExportMetadataTMLBatchedRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
+ "metadata_type": {
+ "description": "Type of metadata object to export, can be one of USER | ROLE | USER_GROUP",
"type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "CONNECTION",
- "CUSTOM_ACTION",
- "USER",
- "USER_GROUP",
- "ROLE",
- "FEEDBACK"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
- "nullable": true
+ "enum": ["USER", "USER_GROUP", "ROLE"]
},
- "identifier": {
+ "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",
- "description": "Unique ID or name of the metadata object."
+ "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
}
},
- "description": "MetadataType InputType used in Export MetadataType API"
+ "required": ["metadata_type"]
},
- "DeleteMetadataTypeInput": {
+ "FetchAnswerSqlQueryRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "LOGICAL_RELATIONSHIP"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
- "nullable": true
- },
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata object."
+ "metadata_identifier": {
+ "description": "ID or name of an Answer.",
+ "type": "string"
}
},
- "description": "MetadataType InputType used in Delete MetadataType API"
+ "required": ["metadata_identifier"]
},
- "PublishMetadataListItem": {
+ "FetchAsyncImportTaskStatusRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata."
+ "task_ids": {
+ "description": "List of task IDs to fetch status for.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE"
- ],
- "description": "Type of metadata. Required if identifier is name.",
+ "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
}
}
},
- "AuthorMetadataTypeInput": {
+ "FetchLiveboardSqlQueryRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
+ "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": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "CONNECTION"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "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
},
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata object."
+ "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
}
},
- "description": "MetadataType InputType used in Author API's"
+ "required": ["metadata_tmls"]
},
- "ShareMetadataTypeInput": {
+ "ImportMetadataTMLAsyncRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "type": {
+ "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": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "LOGICAL_COLUMN",
- "CONNECTION"
- ],
- "description": " Type of metadata.\n \n\nType of metadata. Required if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "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
},
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata object."
+ "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"]
},
- "SharePermissionsInput": {
+ "ParameterizeMetadataRequest": {
"type": "object",
- "required": [
- "principal",
- "share_mode"
- ],
"properties": {
- "principal": {
- "$ref": "#/components/schemas/PrincipalsInput",
- "description": "Details of users or groups."
+ "metadata_type": {
+ "description": "Type of metadata object to parameterize.",
+ "type": "string",
+ "enum": ["LOGICAL_TABLE", "CONNECTION", "CONNECTION_CONFIG"]
},
- "share_mode": {
+ "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": [
- "READ_ONLY",
- "MODIFY",
- "NO_ACCESS"
- ],
- "description": "Type of access to the shared object"
+ "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"
+ ]
},
- "MetadataObject": {
+ "SearchMetadataRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata"
+ "metadata": {
+ "description": "Metadata objects such as Liveboards, Answers, and Worksheets.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MetadataListItemInput"
+ }
},
- "type": {
+ "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": [
- "LIVEBOARD",
- "ANSWER",
- "LOGICAL_TABLE",
- "CUSTOM_ACTION"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "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
- }
- }
- },
- "CommitResponse": {
- "type": "object",
- "properties": {
- "committer": {
- "$ref": "#/components/schemas/CommiterType",
- "description": "Repository user using which changes were committed",
+ },
+ "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
},
- "author": {
- "$ref": "#/components/schemas/AuthorType",
- "description": "Thoughtspot user who commits the changes",
+ "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
},
- "comment": {
- "type": "string",
- "description": "Comments associated with the commit",
+ "include_headers": {
+ "description": "Includes headers of the metadata objects.",
+ "default": true,
+ "type": "boolean",
"nullable": true
},
- "commit_time": {
- "type": "string",
- "description": "Time at which the changes were committed.",
+ "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
},
- "commit_id": {
- "type": "string",
- "description": "SHA id associated with the commit",
+ "include_incomplete_objects": {
+ "description": "Includes objects with incomplete metadata.",
+ "default": false,
+ "type": "boolean",
"nullable": true
},
- "branch": {
- "type": "string",
- "description": "Branch where changes were committed",
+ "include_visualization_headers": {
+ "description": "Includes visualization headers of the specified Liveboard object.",
+ "default": false,
+ "type": "boolean",
"nullable": true
},
- "committed_files": {
+ "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": {
- "$ref": "#/components/schemas/CommitFileType"
- },
- "description": "Files that were pushed as part of this commit",
+ "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
}
}
},
- "CommitFileType": {
+ "UnparameterizeMetadataRequest": {
"type": "object",
- "required": [
- "file_name",
- "status_code"
- ],
"properties": {
- "file_name": {
+ "metadata_type": {
+ "description": "Type of metadata object to unparameterize.",
"type": "string",
- "description": "Name of the file deployed"
+ "enum": ["LOGICAL_TABLE", "CONNECTION", "CONNECTION_CONFIG"]
},
- "status_code": {
- "type": "string",
- "description": "Indicates the status of deployment for the file"
+ "metadata_identifier": {
+ "description": "Unique ID or name of the metadata object to unparameterize.",
+ "type": "string"
},
- "status_message": {
+ "field_type": {
+ "description": "Type of field in the metadata to unparameterize.",
"type": "string",
- "description": "Any error or warning with the deployment",
- "nullable": true
+ "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"]
},
- "RevertResponse": {
+ "UpdateMetadataHeaderRequest": {
"type": "object",
"properties": {
- "committer": {
- "$ref": "#/components/schemas/CommiterType",
- "description": "Repository user using which changes were committed",
- "nullable": true
+ "headers_update": {
+ "description": "List of header objects to update.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/HeaderUpdateInput"
+ }
},
- "author": {
- "$ref": "#/components/schemas/AuthorType",
- "description": "Thoughtspot user who commits the changes",
- "nullable": true
+ "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"
},
- "comment": {
- "type": "string",
- "description": "Comments associated with the commit",
- "nullable": true
+ "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"
},
- "commit_time": {
- "type": "string",
- "description": "Time at which the changes were committed.",
- "nullable": true
+ "description": {
+ "description": "Description of the Org",
+ "type": "string"
},
- "commit_id": {
+ "visibility": {
+ "description": "Visibility of the Org",
"type": "string",
- "description": "SHA id associated with the commit",
- "nullable": true
+ "enum": ["SHOW", "HIDDEN"]
},
- "branch": {
+ "status": {
+ "description": "Status of the Org",
"type": "string",
- "description": "Branch where changes were committed",
- "nullable": true
+ "enum": ["ACTIVE", "IN_ACTIVE"]
},
- "committed_files": {
+ "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": {
- "$ref": "#/components/schemas/CommitFileType"
- },
- "description": "Files that were pushed as part of this commit",
- "nullable": true
+ "type": "string"
+ }
},
- "reverted_metadata": {
+ "group_identifiers": {
+ "description": "Add Default Groups to an Org",
"type": "array",
"items": {
- "$ref": "#/components/schemas/RevertedMetadata"
- },
- "description": "Metadata of reverted file of this commit",
- "nullable": true
+ "type": "string"
+ }
+ },
+ "operation": {
+ "description": "Type of update operation. Default operation type is ADD",
+ "default": "ADD",
+ "type": "string",
+ "enum": ["ADD", "REMOVE", "REPLACE"]
}
}
},
- "RevertedMetadata": {
+ "ExportAnswerReportRequest": {
"type": "object",
- "required": [
- "file_name",
- "metadata_name",
- "metadata_type",
- "status_code",
- "status_message"
- ],
"properties": {
- "file_name": {
- "type": "string",
- "description": "Name of the file deployed"
+ "metadata_identifier": {
+ "description": "Unique ID or name of the metadata object.",
+ "type": "string"
},
- "metadata_name": {
- "type": "string",
- "description": "Name of the metadata object"
+ "session_identifier": {
+ "description": "Unique ID of the answer session.",
+ "type": "string"
},
- "metadata_type": {
- "type": "string",
- "description": "Type of the metadata object"
+ "generation_number": {
+ "description": "Generation number of the answer session.",
+ "type": "integer",
+ "format": "int32"
},
- "status_code": {
+ "file_format": {
+ "description": "Export file format.",
+ "default": "CSV",
"type": "string",
- "description": "Indicates the status of deployment for the file"
+ "enum": ["CSV", "PDF", "XLSX", "PNG"]
},
- "status_message": {
- "type": "string",
- "description": "Any error or warning with the deployment"
+ "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"
+ }
+ ]
}
}
},
- "DeployResponse": {
+ "ExportLiveboardReportRequest": {
"type": "object",
"properties": {
- "file_name": {
- "type": "string",
- "description": "Name of the file deployed",
- "nullable": true
+ "metadata_identifier": {
+ "description": "GUID or name of the Liveboard object.",
+ "type": "string"
},
- "metadata_name": {
- "type": "string",
- "description": "Name of the metadata object",
- "nullable": true
+ "tab_identifiers": {
+ "description": "GUID or name of the tab of the Liveboard object.\nPDF export supports this field by default. For PNG export, the field is supported only when using the new PNG V2 flow.
Version: 10.9.0.cl or later",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "metadata_type": {
- "type": "string",
- "description": "Type of the metadata object",
- "nullable": true
+ "personalised_view_identifier": {
+ "description": "GUID or name of the personalised view of the Liveboard object.
Version: 10.9.0.cl or later",
+ "type": "string"
},
- "status_code": {
- "type": "string",
- "description": "Indicates the status of deployment for the file",
- "nullable": true
+ "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"
+ }
},
- "status_message": {
+ "transient_content": {
+ "description": "Transient content of the Liveboard.",
+ "type": "string"
+ },
+ "file_format": {
+ "description": "Export file format.",
+ "default": "PDF",
"type": "string",
- "description": "Any error or warning with the deployment",
+ "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"]
},
- "CreateConnectionResponse": {
+ "SearchRolesRequest": {
"type": "object",
- "required": [
- "id",
- "name",
- "data_warehouse_type"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "ID of the connection created."
+ "role_identifiers": {
+ "description": "unique ID or name of the Roles",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "name": {
- "type": "string",
- "description": "Name of the connection."
+ "org_identifiers": {
+ "description": "Unique Id or name of the Organisation",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "data_warehouse_type": {
- "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"
- ],
- "description": "Type of data warehouse."
+ "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"
+ ]
+ }
},
- "details": {
- "type": "object",
- "description": "Details of the connection.",
+ "deprecated": {
+ "description": "Indicates whether the Role is deprecated.",
+ "type": "boolean",
+ "deprecated": true,
"nullable": true
- }
- }
- },
- "FetchConnectionDiffStatusResponse": {
- "type": "object",
- "properties": {
- "status": {
+ },
+ "external": {
+ "description": "Indicates whether the Role is external",
"type": "boolean",
- "description": "Status of the connection diff.",
+ "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
}
}
},
- "RoleResponse": {
+ "UpdateRoleRequest": {
"type": "object",
- "required": [
- "id",
- "name",
- "description",
- "privileges"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "Unique Id of the role."
- },
"name": {
- "type": "string",
- "description": "Name of the role"
+ "description": "Name of the Role.",
+ "type": "string"
},
"description": {
- "type": "string",
- "description": "Description of the role"
- },
- "groups_assigned_count": {
- "type": "integer",
- "format": "int32",
- "description": "number of groups assigned with this role",
- "nullable": true
- },
- "orgs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GenericInfo"
- },
- "description": "Orgs in which role exists.",
- "nullable": true
- },
- "groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GenericInfo"
- },
- "description": "Details of groups assigned with this role",
- "nullable": true
+ "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",
@@ -18200,1160 +21522,3068 @@
"CAN_MANAGE_VERSION_CONTROL",
"THIRDPARTY_ANALYSIS",
"CAN_CREATE_CATALOG",
- "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",
- "PREVIEW_THOUGHTSPOT_SAGE"
+ "PREVIEW_THOUGHTSPOT_SAGE",
+ "CAN_MANAGE_WEBHOOKS",
+ "CAN_DOWNLOAD_VISUALS",
+ "CAN_DOWNLOAD_DETAILED_DATA",
+ "CAN_USE_SPOTTER"
]
- },
- "description": "Privileges granted to the role."
+ }
+ }
+ },
+ "required": ["name"]
+ },
+ "CreateScheduleRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the scheduled job.",
+ "type": "string"
},
- "permission": {
+ "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": [
- "READ_ONLY",
- "MODIFY",
- "NO_ACCESS"
- ],
- "description": "Permission details of the Role",
- "nullable": true
+ "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"
+ }
},
- "author_id": {
- "type": "string",
- "description": "Unique identifier of author of the role.",
- "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"
},
- "modifier_id": {
- "type": "string",
- "description": "Unique identifier of modifier of the role.",
- "nullable": true
+ "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"
+ }
},
- "creation_time_in_millis": {
- "type": "object",
- "description": "Creation time of the role in milliseconds.",
- "nullable": true
+ "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"
+ }
},
- "modification_time_in_millis": {
- "type": "object",
- "description": "Last modified time of the role in milliseconds.",
- "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"
},
- "deleted": {
- "type": "boolean",
- "description": "Indicates whether the role is deleted.",
- "nullable": true
+ "record_size": {
+ "description": "The number of records that should be included for each metadata type.",
+ "default": -1,
+ "type": "integer",
+ "format": "int32"
},
- "deprecated": {
- "type": "boolean",
- "description": "Indicates whether the role is deprecated.",
- "nullable": true
+ "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"
+ }
},
- "external": {
- "type": "boolean",
- "description": "Indicates whether the role is external.",
- "nullable": true
+ "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"
+ }
},
- "hidden": {
+ "include_dependent_objects": {
+ "description": "Indicates whether to fetch permissions of dependent metadata objects.",
+ "default": false,
"type": "boolean",
- "description": "Indicates whether the role is hidden.",
"nullable": true
},
- "shared_via_connection": {
- "type": "boolean",
- "description": "Indicates whether the role is shared via connection",
- "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"]
},
- "LiveboardOptionsInput": {
+ "ManageObjectPrivilegeRequest": {
"type": "object",
- "required": [
- "visualization_identifiers"
- ],
"properties": {
- "visualization_identifiers": {
+ "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"
- },
- "description": "Unique ID or name of visualizations."
+ }
+ },
+ "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"
+ }
}
},
- "description": "Options to specify details of Liveboard."
+ "required": [
+ "operation",
+ "metadata_type",
+ "object_privilege_types",
+ "metadata_identifiers",
+ "principals"
+ ]
},
- "SchedulesPdfOptionsInput": {
+ "PublishMetadataRequest": {
"type": "object",
"properties": {
- "complete_liveboard": {
- "type": "boolean",
- "description": "Indicates whether to include complete Liveboard.",
- "nullable": true
+ "metadata": {
+ "description": "Metadata objects to be published.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PublishMetadataListItem"
+ }
},
- "include_cover_page": {
- "type": "boolean",
- "description": "Indicates whether to include cover page with the Liveboard title.",
- "nullable": true
+ "org_identifiers": {
+ "description": "Unique ID or name of orgs to which metadata objects should be published.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "include_custom_logo": {
+ "skip_validation": {
+ "description": "Skip validations of objects to be published.",
"type": "boolean",
- "description": "Indicates whether to include customized wide logo in the footer if available.",
"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"
+ ]
},
- "include_filter_page": {
- "type": "boolean",
- "description": "Indicates whether to include a page with all applied filters.",
- "nullable": true
+ "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"
+ }
},
- "include_page_number": {
- "type": "boolean",
- "description": "Indicates whether to include page number in the footer of each page",
- "nullable": true
+ "metadata": {
+ "description": "Metadata details for sharing objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ShareMetadataTypeInput"
+ }
},
- "page_footer_text": {
- "type": "string",
- "description": "Text to include in the footer of each page.",
- "nullable": true
+ "permissions": {
+ "description": "Permission details for sharing the objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SharePermissionsInput"
+ }
},
- "page_orientation": {
- "type": "string",
- "description": "Page orientation of the PDF.",
+ "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
},
- "page_size": {
- "type": "string",
- "enum": [
- "A4"
- ],
- "description": "Page size.",
+ "notify_on_share": {
+ "description": "Flag to notify user when any object is shared.",
+ "default": true,
+ "type": "boolean",
"nullable": true
},
- "truncate_table": {
+ "has_lenient_discoverability": {
+ "description": "Flag to make the object discoverable.",
+ "default": false,
"type": "boolean",
- "description": "Indicates whether to include only first page of the tables.",
"nullable": true
}
},
- "description": "Options for PDF export."
- },
- "FrequencyInput": {
- "type": "object",
- "required": [
- "cron_expression"
- ],
- "properties": {
- "cron_expression": {
- "$ref": "#/components/schemas/CronExpressionInput",
- "description": "Schedule selected cron expression."
- }
- },
- "description": "Configuration of schedule with cron expression"
+ "required": ["permissions", "message"]
},
- "CronExpressionInput": {
+ "UnpublishMetadataRequest": {
"type": "object",
- "required": [
- "day_of_month",
- "day_of_week",
- "hour",
- "minute",
- "month",
- "second"
- ],
"properties": {
- "day_of_month": {
- "type": "string",
- "description": "Day of month of the object."
- },
- "day_of_week": {
- "type": "string",
- "description": "Day of Week of the object."
- },
- "hour": {
- "type": "string",
- "description": "Hour of the object."
+ "force": {
+ "description": "Force unpublishes the object. This will break all the dependent objects in the unpublished orgs.",
+ "type": "boolean",
+ "nullable": true
},
- "minute": {
- "type": "string",
- "description": "Minute of the object."
+ "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"
},
- "month": {
- "type": "string",
- "description": "Month of the object."
+ "metadata": {
+ "description": "Metadata objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PublishMetadataListItem"
+ }
},
- "second": {
- "type": "string",
- "description": "Second of the object."
+ "org_identifiers": {
+ "description": "Unique ID or name of orgs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "description": "Schedule selected cron expression."
+ "required": ["include_dependencies", "metadata", "org_identifiers"]
},
- "RecipientDetailsInput": {
+ "UpdateColumnSecurityRulesRequest": {
"type": "object",
"properties": {
- "emails": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Emails of the recipients.",
+ "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
},
- "principals": {
+ "column_security_rules": {
+ "description": "Array where each object defines the security rule for a specific column",
"type": "array",
"items": {
- "$ref": "#/components/schemas/PrincipalsListItemInput"
- },
- "description": "User or groups to be set as recipients of the schedule notifications.",
- "nullable": true
+ "$ref": "#/components/schemas/ColumnSecurityRuleUpdate"
+ }
}
},
- "description": "Recipients of the scheduled job notification."
+ "required": ["column_security_rules"]
},
- "PrincipalsListItemInput": {
+ "ConfigureCommunicationChannelPreferencesRequest": {
"type": "object",
- "required": [
- "identifier",
- "type"
- ],
"properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the user or group."
+ "cluster_preferences": {
+ "description": "Cluster-level default configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventChannelConfigInput"
+ }
},
- "type": {
- "type": "string",
- "description": "Principal type."
+ "org_preferences": {
+ "description": "Org-specific configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrgChannelConfigInput"
+ }
}
}
},
- "ResponseSchedule": {
+ "ConfigureSecuritySettingsRequest": {
"type": "object",
- "required": [
- "author",
- "creation_time_in_millis",
- "file_format",
- "frequency",
- "id",
- "metadata",
- "name",
- "recipient_details",
- "time_zone"
- ],
"properties": {
- "author": {
- "$ref": "#/components/schemas/Author",
- "description": "Author of the schedule."
- },
- "creation_time_in_millis": {
- "type": "object",
- "description": "Schedule creation time in milliseconds."
- },
- "description": {
- "type": "string",
- "description": "Description of the job.",
- "nullable": true
- },
- "file_format": {
- "type": "string",
- "description": "Export file format."
- },
- "frequency": {
- "$ref": "#/components/schemas/Frequency",
- "description": "Configuration of schedule with cron expression"
- },
- "id": {
- "type": "string",
- "description": "GUID of the scheduled job."
- },
- "liveboard_options": {
- "$ref": "#/components/schemas/LiveboardOptions",
- "description": "Options to specify details of Liveboard.",
- "nullable": true
- },
- "metadata": {
- "$ref": "#/components/schemas/MetadataResponse",
- "description": "Unique ID or name of the metadata."
- },
- "name": {
- "type": "string",
- "description": "Name of the scheduled job."
- },
- "pdf_options": {
- "$ref": "#/components/schemas/PdfOptions",
- "description": "Options for PDF export.",
- "nullable": true
- },
- "recipient_details": {
- "$ref": "#/components/schemas/RecipientDetails",
- "description": "Recipient of the scheduled job notifications."
- },
- "status": {
- "type": "string",
- "description": "Status of the job",
- "nullable": true
- },
- "time_zone": {
- "type": "string",
- "description": "Time zone"
+ "cluster_preferences": {
+ "description": "Cluster-level security preferences.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SecuritySettingsClusterPreferencesInput"
+ }
+ ]
},
- "history_runs": {
+ "org_preferences": {
+ "description": "Org-level security preferences for the current org.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ResponseScheduleRun"
- },
- "description": "Schedule runs history records.",
- "nullable": true
- },
- "personalised_view_id": {
- "type": "string",
- "description": "Personalised view id of the liveboard to be scheduled.",
- "nullable": true
+ "$ref": "#/components/schemas/SecuritySettingsOrgPreferencesInput"
+ }
}
}
},
- "Author": {
+ "SearchCommunicationChannelPreferencesRequest": {
"type": "object",
- "required": [
- "id",
- "name"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "The unique identifier of the object."
+ "cluster_preferences": {
+ "description": "Event types to search for in cluster-level preferences.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["LIVEBOARD_SCHEDULE"]
+ }
},
- "name": {
- "type": "string",
- "description": "Name of the object."
- }
- },
- "description": "Author of the schedule."
- },
- "Frequency": {
- "type": "object",
- "required": [
- "cron_expression"
- ],
- "properties": {
- "cron_expression": {
- "$ref": "#/components/schemas/CronExpression",
- "description": "Schedule selected cron expression."
+ "org_preferences": {
+ "description": "Org-specific search criteria.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrgPreferenceSearchCriteriaInput"
+ }
}
- },
- "description": "Configuration of schedule with cron expression"
+ }
},
- "CronExpression": {
+ "SearchSecuritySettingsRequest": {
"type": "object",
- "required": [
- "day_of_month",
- "day_of_week",
- "hour",
- "minute",
- "month",
- "second"
- ],
"properties": {
- "day_of_month": {
- "type": "string",
- "description": "Day of month of the object."
- },
- "day_of_week": {
- "type": "string",
- "description": "Day of Week of the object."
- },
- "hour": {
- "type": "string",
- "description": "Hour of the object."
- },
- "minute": {
- "type": "string",
- "description": "Minute of the object."
- },
- "month": {
- "type": "string",
- "description": "Month of the object."
- },
- "second": {
+ "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",
- "description": "Second of the object."
+ "enum": ["CLUSTER", "ORG"]
}
- },
- "description": "Schedule selected cron expression."
+ }
},
- "LiveboardOptions": {
+ "UpdateSystemConfigRequest": {
"type": "object",
- "required": [
- "visualization_identifiers"
- ],
"properties": {
- "visualization_identifiers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Unique ID or name of visualizations."
+ "configuration": {
+ "description": "Configuration JSON with the key-value pair of configuration attributes to be updated.",
+ "type": "object"
}
},
- "description": "Options to specify details of Liveboard."
+ "required": ["configuration"]
},
- "MetadataResponse": {
+ "ValidateCommunicationChannelRequest": {
"type": "object",
- "required": [
- "id",
- "type"
- ],
"properties": {
- "name": {
+ "channel_type": {
+ "description": "Type of communication channel to validate (e.g., WEBHOOK).",
"type": "string",
- "nullable": true
+ "enum": ["WEBHOOK"]
},
- "id": {
+ "channel_identifier": {
+ "description": "Unique identifier or name for the communication channel.",
"type": "string"
},
- "type": {
+ "event_type": {
+ "description": "Event type to validate for this channel.",
"type": "string",
- "enum": [
- "LIVEBOARD"
- ]
+ "enum": ["LIVEBOARD_SCHEDULE"]
}
- }
+ },
+ "required": ["channel_type", "channel_identifier", "event_type"]
},
- "PdfOptions": {
+ "AssignTagRequest": {
"type": "object",
"properties": {
- "complete_liveboard": {
- "type": "boolean",
- "description": "Indicates whether to include complete Liveboard.",
- "nullable": true
- },
- "include_cover_page": {
- "type": "boolean",
- "description": "Indicates whether to include cover page with the Liveboard title.",
- "nullable": true
- },
- "include_custom_logo": {
- "type": "boolean",
- "description": "Indicates whether to include customized wide logo in the footer if available.",
- "nullable": true
- },
- "include_filter_page": {
- "type": "boolean",
- "description": "Indicates whether to include a page with all applied filters.",
- "nullable": true
- },
- "include_page_number": {
- "type": "boolean",
- "description": "Indicates whether to include page number in the footer of each page",
- "nullable": true
- },
- "page_footer_text": {
- "type": "string",
- "description": "Text to include in the footer of each page.",
- "nullable": true
- },
- "page_orientation": {
- "type": "string",
- "description": "Page orientation of the PDF.",
- "nullable": true
+ "metadata": {
+ "description": "Metadata objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TagMetadataTypeInput"
+ }
},
- "page_size": {
- "type": "string",
- "enum": [
- "A4"
- ],
- "description": "Page size.",
- "nullable": true
+ "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"
},
- "truncate_table": {
- "type": "boolean",
- "description": "Indicates whether to include only first page of the tables.",
- "nullable": true
+ "color": {
+ "description": "Hex color code to be assigned to the tag. For example, #ff78a9.",
+ "type": "string"
}
},
- "description": "Options for PDF export."
+ "required": ["name"]
},
- "RecipientDetails": {
+ "SearchTagsRequest": {
"type": "object",
"properties": {
- "emails": {
+ "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": {
- "type": "string"
- },
- "description": "Emails of the recipients. Specify email address if the recipient is not a ThoughtSpot user.",
- "nullable": true
+ "$ref": "#/components/schemas/TagMetadataTypeInput"
+ }
},
- "principals": {
+ "tag_identifiers": {
+ "description": "GUID or name of the tag.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/PrincipalsListItem"
- },
- "description": "List of user or groups to subscribe for the scheduled job notifications.",
- "nullable": true
+ "type": "string"
+ }
}
},
- "description": "Recipient configuration which includes email address, ID or name of the users and groups."
+ "required": ["metadata", "tag_identifiers"]
},
- "PrincipalsListItem": {
+ "UpdateTagRequest": {
"type": "object",
- "required": [
- "identifier",
- "type"
- ],
"properties": {
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the user or group."
+ "name": {
+ "description": "Name of the tag.",
+ "type": "string"
},
- "type": {
- "type": "string",
- "description": "Principal type. Valid values are"
+ "color": {
+ "description": "Hex color code to be assigned to the tag. For example, #ff78a9.",
+ "type": "string"
}
}
},
- "ResponseScheduleRun": {
+ "ActivateUserRequest": {
"type": "object",
- "required": [
- "id",
- "start_time_in_millis",
- "end_time_in_millis",
- "status"
- ],
"properties": {
- "id": {
- "type": "string",
- "description": "GUID of the scheduled job."
- },
- "start_time_in_millis": {
- "type": "integer",
- "format": "int32",
- "description": "Schedule run start time in milliseconds."
+ "user_identifier": {
+ "description": "Unique ID or name of the user.",
+ "type": "string"
},
- "end_time_in_millis": {
- "type": "integer",
- "format": "int32",
- "description": "Schedule run end time in milliseconds."
+ "auth_token": {
+ "description": "Auth token for the user.",
+ "type": "string"
},
- "status": {
- "type": "string",
- "description": "Status of the schedule run."
+ "password": {
+ "description": "New password for the user to access the account.",
+ "type": "string"
},
- "detail": {
- "type": "string",
- "description": "Message details related to the schedule run.",
- "nullable": true
+ "properties": {
+ "description": "Properties of the user.",
+ "type": "string"
}
},
- "description": "Schedule run response object"
+ "required": ["user_identifier", "auth_token", "password"]
},
- "MetadataInput": {
+ "ChangeUserPasswordRequest": {
"type": "object",
"properties": {
- "identifier": {
- "type": "string",
- "nullable": true
+ "current_password": {
+ "description": "Current password of the user.",
+ "type": "string"
},
- "type": {
- "type": "string",
- "enum": [
- "LIVEBOARD"
- ],
- "nullable": true
+ "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"]
},
- "SortingOptions": {
+ "CreateUserRequest": {
"type": "object",
"properties": {
- "field_name": {
+ "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",
- "description": "Name of the field to apply the sort on.",
- "nullable": true
+ "enum": [
+ "LOCAL_USER",
+ "LDAP_USER",
+ "SAML_USER",
+ "OIDC_USER",
+ "REMOTE_USER"
+ ]
},
- "order": {
+ "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",
- "description": "Sort order : ASC(Ascending) or DESC(Descending).",
+ "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
- }
- },
- "description": "Sort options."
- },
- "ScheduleHistoryRunsOptionsInput": {
- "type": "object",
- "properties": {
- "include_history_runs": {
+ },
+ "show_onboarding_experience": {
+ "description": "The user preference for revisiting the onboarding experience.",
+ "default": true,
"type": "boolean",
- "default": false,
- "description": "Indicates whether to fetch history runs for the scheduled notification.",
"nullable": true
},
- "record_size": {
- "type": "integer",
- "format": "int32",
- "default": 10,
- "description": "Indicates the max number of records that can be fetched as past runs of any scheduled job.",
+ "onboarding_experience_completed": {
+ "description": "flag to get the on-boarding experience is completed or not.",
+ "default": false,
+ "type": "boolean",
"nullable": true
},
- "record_offset": {
- "type": "integer",
- "format": "int32",
- "default": 0,
- "description": "Indicates the starting record number from where history runs records should be fetched.",
+ "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
- }
- }
- },
- "Action_Details_Input_Create": {
- "type": "object",
- "properties": {
- "CALLBACK": {
- "$ref": "#/components/schemas/CALLBACKInputMandatory",
- "description": "CALLBACK Custom Action Type",
+ },
+ "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
},
- "URL": {
- "$ref": "#/components/schemas/URLInputMandatory",
- "description": "URL Custom Action Type",
+ "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
}
},
- "description": "Action details includes Type and Configuration for Custom Actions, either Callback or URL is required.\nWhen both callback and url are provided, callback would be considered"
+ "required": ["name", "display_name", "email"]
},
- "CALLBACKInputMandatory": {
+ "DeactivateUserRequest": {
"type": "object",
"properties": {
- "reference": {
- "type": "string",
- "description": "Reference name. By default, the value will be set to action name.",
- "nullable": true
+ "user_identifier": {
+ "description": "Unique ID or name of the user.",
+ "type": "string"
+ },
+ "base_url": {
+ "description": "Base url of the cluster.",
+ "type": "string"
}
},
- "description": "CALLBACK Custom Action Type"
+ "required": ["user_identifier", "base_url"]
},
- "URLInputMandatory": {
+ "ForceLogoutUsersRequest": {
"type": "object",
- "required": [
- "url"
- ],
"properties": {
- "authentication": {
- "$ref": "#/components/schemas/AuthenticationInput",
- "description": "Authorization type for the custom action.",
- "nullable": true
- },
- "parameters": {
+ "user_identifiers": {
+ "description": "GUID or name of the users for force logging out their sessions.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ParametersListItemInput"
- },
- "description": "Query parameters for url.",
- "nullable": true
- },
- "url": {
- "type": "string",
- "description": "Request Url for the Custom action."
- },
- "reference": {
- "type": "string",
- "description": "Reference name. By default the value will be set to action name",
- "nullable": true
+ "type": "string"
+ }
}
- },
- "description": "URL Custom Action Type"
+ }
},
- "AuthenticationInput": {
+ "ImportUsersRequest": {
"type": "object",
"properties": {
- "API_Key": {
- "$ref": "#/components/schemas/API_KeyInput",
- "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.",
- "nullable": true
+ "users": {
+ "description": "List of users needs to be imported.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ImportUser"
+ }
},
- "Basic_Auth": {
- "$ref": "#/components/schemas/Basic_AuthInput",
- "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.",
- "nullable": true
+ "default_password": {
+ "description": "The default password to assign to users if they do not have a password assigned in ThoughtSpot.",
+ "type": "string"
},
- "Bearer_Token": {
- "type": "string",
- "description": "Bearer tokens enable requests to authenticate using an access key.",
+ "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
},
- "No_Auth": {
- "type": "string",
- "description": "No authorization. If your request doesn't require authorization.",
+ "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
}
},
- "description": "Authorization type for the custom action."
+ "required": ["users"]
},
- "API_KeyInput": {
+ "ResetUserPasswordRequest": {
"type": "object",
"properties": {
- "key": {
- "type": "string",
- "description": "Enter your key name",
- "nullable": true
+ "new_password": {
+ "description": "New password for the user.",
+ "type": "string"
},
- "value": {
- "type": "string",
- "description": "Enter you key value",
- "nullable": true
+ "user_identifier": {
+ "description": "GUID or name of the user.",
+ "type": "string"
}
},
- "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters."
+ "required": ["new_password", "user_identifier"]
},
- "Basic_AuthInput": {
+ "SearchUsersRequest": {
"type": "object",
"properties": {
- "password": {
+ "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",
- "description": "Password for the basic authentication",
- "nullable": true
+ "enum": ["SHARABLE", "NON_SHARABLE"]
},
- "username": {
+ "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",
- "description": "Username for the basic authentication",
- "nullable": true
- }
- },
- "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request."
- },
- "ParametersListItemInput": {
- "type": "object",
- "properties": {
- "key": {
+ "enum": [
+ "LOCAL_USER",
+ "LDAP_USER",
+ "SAML_USER",
+ "OIDC_USER",
+ "REMOTE_USER"
+ ]
+ },
+ "account_status": {
+ "description": "Current status of the user account.",
"type": "string",
- "description": "Key for the url query parameter",
+ "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
},
- "value": {
- "type": "string",
- "description": "Value for the url query parameter",
+ "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
}
}
},
- "Associate_Metadata_Input_Create": {
+ "UpdateUserRequest": {
"type": "object",
- "required": [
- "identifier"
- ],
"properties": {
- "action_config": {
- "$ref": "#/components/schemas/ActionConfigInputCreate",
- "description": "Specify that the association is enabled for the metadata object",
+ "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
},
- "identifier": {
+ "account_type": {
+ "description": "Type of the account.",
"type": "string",
- "description": "Unique ID or name of the metadata."
+ "enum": [
+ "LOCAL_USER",
+ "LDAP_USER",
+ "SAML_USER",
+ "OIDC_USER",
+ "REMOTE_USER"
+ ]
},
- "type": {
+ "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": [
- "VISUALIZATION",
- "ANSWER",
- "WORKSHEET"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
+ "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"
}
}
},
- "ActionConfigInputCreate": {
+ "CreateVariableRequest": {
"type": "object",
"properties": {
- "position": {
+ "type": {
+ "description": "Type of variable",
"type": "string",
"enum": [
- "MENU",
- "PRIMARY",
- "CONTEXT_MENU"
- ],
- "default": "MENU",
- "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.",
- "nullable": true
+ "CONNECTION_PROPERTY",
+ "TABLE_MAPPING",
+ "CONNECTION_PROPERTY_PER_PRINCIPAL",
+ "FORMULA_VARIABLE"
+ ]
},
- "visibility": {
- "type": "boolean",
- "default": true,
- "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled",
- "nullable": true
- }
- },
- "description": "Specify that the association is enabled for the metadata object Default"
- },
- "Default_Action_Config_Input_Create": {
- "type": "object",
- "properties": {
- "visibility": {
+ "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",
- "default": true,
- "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.\nDefault: true",
- "nullable": true
- }
- },
- "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
- },
- "Action_Details_Input": {
- "type": "object",
- "properties": {
- "CALLBACK": {
- "$ref": "#/components/schemas/CALLBACKInput",
- "description": "CALLBACK Custom Action Type",
"nullable": true
},
- "URL": {
- "$ref": "#/components/schemas/URLInput",
- "description": "URL Custom Action Type",
- "nullable": true
- }
- },
- "description": "Action details includes `Type` and configuration details of Custom Actions. Either Callback or URL is required."
- },
- "CALLBACKInput": {
- "type": "object",
- "properties": {
- "reference": {
+ "data_type": {
+ "description": "Variable Data Type, only for formula_variable type, leave empty for others
Version: 10.15.0.cl or later",
"type": "string",
- "description": "Reference name. By default, the value will be set to action name.",
- "nullable": true
+ "enum": ["VARCHAR", "INT32", "INT64", "DOUBLE", "DATE", "DATE_TIME"]
}
},
- "description": "CALLBACK Custom Action Type"
+ "required": ["type", "name"]
},
- "URLInput": {
+ "SearchVariablesRequest": {
"type": "object",
"properties": {
- "authentication": {
- "$ref": "#/components/schemas/AuthenticationInput",
- "description": "Authorization type for the custom action.",
- "nullable": true
- },
- "parameters": {
+ "variable_details": {
+ "description": "Variable details",
"type": "array",
"items": {
- "$ref": "#/components/schemas/ParametersListItemInput"
- },
- "description": "Query parameters for url.",
- "nullable": true
+ "$ref": "#/components/schemas/VariableDetailInput"
+ }
},
- "url": {
- "type": "string",
- "description": "Request Url for the Custom action.",
- "nullable": true
+ "value_scope": {
+ "description": "Array of scope filters",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ValueScopeInput"
+ }
},
- "reference": {
- "type": "string",
- "description": "Reference name. By default the value will be set to action name",
- "nullable": true
- }
- },
- "description": "URL Custom Action Type"
- },
- "Associate_Metadata_Input": {
- "type": "object",
- "properties": {
- "action_config": {
- "$ref": "#/components/schemas/ActionConfigInput",
- "description": "Specify that the association is enabled for the metadata object",
- "nullable": true
+ "record_offset": {
+ "description": "The starting record number from where the records should be included",
+ "default": 0,
+ "type": "integer",
+ "format": "int32"
},
- "identifier": {
- "type": "string",
- "description": "Unique ID or name of the metadata.",
- "nullable": true
+ "record_size": {
+ "description": "The number of records that should be included",
+ "default": 10,
+ "type": "integer",
+ "format": "int32"
},
- "type": {
+ "response_content": {
+ "description": "Format in which we want the output",
+ "default": "METADATA",
"type": "string",
- "enum": [
- "VISUALIZATION",
- "ANSWER",
- "WORKSHEET"
- ],
- "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.",
- "nullable": true
+ "enum": ["METADATA", "METADATA_AND_VALUES"]
}
}
},
- "ActionConfigInput": {
+ "UpdateVariableRequest": {
"type": "object",
"properties": {
- "position": {
- "type": "string",
- "enum": [
- "MENU",
- "PRIMARY",
- "CONTEXT_MENU"
- ],
- "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.",
- "nullable": true
- },
- "visibility": {
- "type": "boolean",
- "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled",
- "nullable": true
+ "name": {
+ "description": "New name of the variable.",
+ "type": "string"
}
},
- "description": "Specify that the association is enabled for the metadata object Default"
+ "required": ["name"]
},
- "Default_Action_Config_Input": {
+ "UpdateVariableValuesRequest": {
"type": "object",
"properties": {
- "visibility": {
- "type": "boolean",
- "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.",
- "nullable": true
+ "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"
+ }
}
},
- "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers."
+ "required": ["variable_assignment", "variable_value_scope"]
},
- "ModelTableList": {
+ "CommitBranchRequest": {
"type": "object",
- "required": [
- "model_name",
- "tables"
- ],
"properties": {
- "model_name": {
- "type": "string",
- "description": "Name of the Model."
+ "metadata": {
+ "description": "Metadata objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MetadataObject"
+ }
},
- "model_path": {
- "type": "string",
- "description": "Model directory path, this is optional param and required if there are duplicate models with the same name.",
+ "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
},
- "tables": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "List of Tables."
+ "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"]
},
- "DbtSearchResponse": {
+ "CreateConfigRequest": {
"type": "object",
"properties": {
- "dbt_connection_identifier": {
- "type": "string",
- "nullable": true
+ "repository_url": {
+ "description": "URL for connecting to remote repository",
+ "type": "string"
},
- "project_name": {
- "type": "string",
- "nullable": true
+ "username": {
+ "description": "Username to authenticate connection to remote repository",
+ "type": "string"
},
- "connection_id": {
- "type": "string",
- "nullable": true
+ "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"
},
- "connection_name": {
- "type": "string",
- "nullable": true
+ "branch_names": {
+ "description": "List the remote branches to configure. Example:[development, production]",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "cdw_database": {
- "type": "string",
- "nullable": true
+ "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"
},
- "import_type": {
- "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
},
- "author_name": {
- "type": "string",
- "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"]
},
- "Conversation": {
+ "DeleteConfigRequest": {
"type": "object",
- "required": [
- "conversation_identifier"
- ],
"properties": {
- "conversation_identifier": {
- "type": "string",
- "description": "Unique identifier of the conversation."
+ "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
}
}
},
- "ResponseMessage": {
+ "DeployCommitRequest": {
"type": "object",
- "required": [
- "message_type"
- ],
"properties": {
- "session_identifier": {
- "type": "string",
- "description": "Unique identifier of the generated response.",
- "nullable": true
+ "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"
},
- "generation_number": {
- "type": "integer",
- "format": "int32",
- "description": "Generate number of the response.",
- "nullable": true
+ "branch_name": {
+ "description": "Name of the remote branch where changes should be picked",
+ "type": "string"
},
- "message_type": {
+ "deploy_type": {
+ "description": "Indicates if all files or only modified file at specified commit point should be considered",
+ "default": "DELTA",
"type": "string",
- "enum": [
- "TSAnswer"
- ],
- "description": "Type of the generated response."
+ "enum": ["FULL", "DELTA"]
},
- "visualization_type": {
+ "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": [
- "Chart",
- "Table",
- "Undefined"
- ],
- "description": "Generated visualization type.",
- "nullable": true
+ "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"
+ }
},
- "tokens": {
- "type": "string",
- "description": "Tokens for the response.",
- "nullable": true
+ "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"
},
- "display_tokens": {
+ "revert_policy": {
+ "description": "Policy to apply when reverting a commit. Valid values: [ALL_OR_NONE, PARTIAL]",
+ "default": "ALL_OR_NONE",
"type": "string",
- "description": "User friendly tokens for the response.",
- "nullable": true
+ "enum": ["ALL_OR_NONE", "PARTIAL"]
}
}
},
- "InputVariableValue": {
+ "SearchCommitsRequest": {
"type": "object",
- "required": [
- "value",
- "org_identifier"
- ],
"properties": {
- "value": {
- "type": "string",
- "description": "The connection property value"
+ "metadata_identifier": {
+ "description": "Unique ID or name of the metadata.",
+ "type": "string"
},
- "org_identifier": {
+ "metadata_type": {
+ "description": "Type of metadata.",
"type": "string",
- "description": "The unique name of the org"
+ "enum": ["LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CUSTOM_ACTION"]
},
- "principal_type": {
- "type": "string",
- "enum": [
- "USER",
- "USER_GROUP"
- ],
- "description": "Principal type",
- "nullable": true
+ "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"
},
- "principal_identifier": {
- "type": "string",
- "description": "Unique ID or name of the principal",
- "nullable": true
+ "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"
},
- "priority": {
+ "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",
- "description": "The priority assigned to this value. If there are 2 matching values, the one with the higher priority will be picked.",
- "nullable": true
+ "format": "int32"
}
- }
+ },
+ "required": ["metadata_identifier"]
},
- "VariableValueInput": {
+ "SearchConfigRequest": {
"type": "object",
- "required": [
- "variable_identifier",
- "variable_values"
- ],
"properties": {
- "variable_identifier": {
- "type": "string",
- "description": "ID or Name of the variable"
- },
- "variable_values": {
+ "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": {
- "$ref": "#/components/schemas/InputVariableValue"
- },
- "description": "Values of the variable"
+ "type": "string"
+ }
}
- },
- "description": "Input for variable value update"
+ }
},
- "CreateEmailCustomizationResponse": {
+ "UpdateConfigRequest": {
"type": "object",
- "required": [
- "tenant_id",
- "org",
- "name",
- "template_properties"
- ],
"properties": {
- "tenant_id": {
- "type": "string",
- "description": "Tenant ID"
+ "username": {
+ "description": "Username to authenticate connection to version control system",
+ "type": "string"
},
- "org": {
- "$ref": "#/components/schemas/OrgType",
- "description": "Email customization org"
+ "access_token": {
+ "description": "Access token corresponding to the user to authenticate connection to version control system",
+ "type": "string"
},
- "name": {
- "type": "string",
- "description": "Email customization name."
+ "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"
},
- "template_properties": {
- "type": "object",
- "description": "Customization configuration for the email"
+ "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"
}
}
},
- "OrgType": {
+ "ValidateMergeRequest": {
"type": "object",
"properties": {
- "name": {
- "type": "string",
- "nullable": true
+ "source_branch_name": {
+ "description": "Name of the branch from which changes need to be picked for validation",
+ "type": "string"
},
- "id": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "target_branch_name": {
+ "description": "Name of the branch where files will be merged",
+ "type": "string"
}
- }
+ },
+ "required": ["source_branch_name", "target_branch_name"]
},
- "Runtime_Filter": {
+ "CreateWebhookConfigurationRequest": {
"type": "object",
"properties": {
- "runtime_filter": {
- "type": "object",
- "description": "Runtime filter parameter type in JWT."
+ "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"
+ }
+ ]
}
},
- "description": "List of runtime parameters need to set during the session."
+ "required": ["name", "url", "events"]
},
- "Runtime_Sort": {
+ "DeleteWebhookConfigurationsRequest": {
"type": "object",
"properties": {
- "runtime_sort": {
- "type": "object",
- "description": "Runtime sort parameter type in JWT."
+ "webhook_identifiers": {
+ "description": "List of webhook identifiers to delete.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "description": "List of runtime parameters need to set during the session."
+ "required": ["webhook_identifiers"]
},
- "Runtime_Param_Override": {
+ "SearchWebhookConfigurationsRequest": {
"type": "object",
"properties": {
- "runtime_param_override": {
- "type": "object",
- "description": "Runtime param override type in JWT."
+ "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"
+ }
+ ]
}
- },
- "description": "List of runtime parameters need to set during the session."
+ }
+ },
+ "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"
+ }
+ ]
+ }
+ }
}
},
"securitySchemes": {
@@ -19378,4 +24608,4 @@
}
}
]
-}
\ No newline at end of file
+}