REST API v2.0 changelog
This changelog lists the features and enhancements introduced in REST API v2.0. For a complete list of ThoughtSpot Everywhere features and enhancements, see Whatβs New.
Version 9.7.0, November 2023π
Version Control APIsπ
This release introduces the following enhancements to the Version Control API endpoints:
Git connection creation and update APIsπ
The POST /api/rest/2.0/vcs/git/config/create
and POST /api/rest/2.0/vcs/git/config/update
API endpoints include the following enhancements:
- New parameters
-
-
commit_branch_name
Allows configuring a commit branch for Git connections on your ThoughtSpot instance. ThoughtSpot recommends usingcommit_branch_name
instead ofdefault_branch_name
in the API calls to prevent users from committing changes to the default deployment branch. -
configuration_branch_name
Allows configuring a separate Git branch for storing and maintaining configuration files, such as GUID mapping and commit tracking files. If theconfiguration_branch_name
property is defined, theguid_mapping_branch_name
parameter is not required.
-
- Modified parameters
-
The
enable_guid_mapping
parameter is enabled by default. - Separate branches for Orgs
-
If you are using Orgs and want to move content between these Orgs using version control APIs, ensure that you set a separate Git branch for each Org. If two Orgs are connected to the same Git
repository_url
, thePOST /api/rest/2.0/vcs/git/config/create
andPOST /api/rest/2.0/vcs/git/config/update
API endpoints do not support configuring the same branch name for these Orgs. - Deprecation notice
-
The
default_branch_name
andguid_mapping_branch_name
parameters will be deprecated from version 10.0.0.cl and later releases.
For more information, see Connect your ThoughtSpot environment to the Git repository.
Commit APIπ
The POST /api/rest/2.0/vcs/git/branches/commit
API endpoint allows the following new attribute in the request body:
-
delete_aware
When set to true, the system runs a check between the objects and files in the Git branch and destination environment or Org. If an object exists in the Git branch, but not the destination environment or Org, it will be deleted from the Git branch during the commit operation.
For more information, see Commit files.
Deploy APIπ
Note the following changes:
-
The
branch_name
attribute is now mandatory in thePOST /api/rest/2.0/vcs/git/commits/deploy
API requests. Ensure that you specify the name of the Git branch from which the commits can be picked and deployed on the destination environment or Org. -
After a successful deployment, a tracking file is generated with the
commit_id
and saved in the Git branch that is used for storing configuration files. Thecommit_id
recorded in the tracking file is used for comparing changes when new commits are pushed in the subsequent API calls.
For more information, see Deploy commits.
User APIπ
The following new API endpoints are introduced for user account management:
-
POST /api/rest/2.0/users/activate
Activates an inactive user account. -
POST /api/rest/2.0/users/deactivate
Deactivates a user account.
Support for sorting of columns at runtimeπ
The following data API endpoints now support runtime sorting of columns:
-
POST /api/rest/2.0/searchdata
-
POST /api/rest/2.0/metadata/liveboard/data
-
POST /api/rest/2.0/metadata/answer/data
For more information, see Runtime sorting of columns.
Version 9.6.0.cl, October 2023π
New API endpointsπ
-
POST /api/rest/2.0/customization/custom-actions/search
Gets custom action objects -
POST /api/rest/2.0/customization/custom-actions
Creates a custom action -
POST /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update
Updates the properties of a custom action object. -
POST /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete
Deletes a custom action
Version 9.5.0.cl, September 2023π
New API endpoints for Role-Based Access Control Betaπ
-
POST /api/rest/2.0/roles/search
Gets details of role objects available in the ThoughtSpot system. -
POST /api/rest/2.0/roles/create
Creates a role and assigns privileges -
POST /api/rest/2.0/roles/{role_identifier}/update
Updates the properties of a given role -
POST /api/rest/2.0/roles/{role_identifier}/delete
Removes a role object from the ThoughtSpot system
For more information, see Role-based access control.
Note
|
The roles APIs work only if the Role-Based Access Control (RBAC) Beta feature is enabled on your instance. The RBAC feature is turned off by default. To enable this feature, contact ThoughtSpot Support. |
Enhancements and API modificationsπ
- Support for runtime parameter overrides
-
The following data and report API endpoints support applying runtime parameter overrides:
-
POST /api/rest/2.0/searchdata
-
POST /api/rest/2.0/metadata/liveboard/data
-
POST /api/rest/2.0/metadata/answer/data
-
POST /api/rest/2.0/report/liveboard
-
POST /api/rest/2.0/report/answer
-
- Git integration support for Orgs
-
The Version Control API endpoints support using Orgs as disparate deployment environments. You can create separate Orgs for
dev
,staging
, andprod
and integrate these environments with a GitHub repo.For more information, see Git integration and version control.
Response code change BREAKING CHANGEπ
The following endpoints now return the 204 response code instead of 200. The 204 code doesnβt return a response body. This change may affect your current implementation, so we recommend that you update your code to avoid issues.
-
POST /api/rest/2.0/connection/delete
-
POST /api/rest/2.0/connection/update
-
POST /api/rest/2.0/users/{user_identifier}/update
-
POST /api/rest/2.0/users/{user_identifier}/delete
-
POST /api/rest/2.0/users/change-password
-
POST /api/rest/2.0/users/reset-password
-
POST /api/rest/2.0/users/force-logout
-
POST /api/rest/2.0/groups/{group_identifier}/update
-
POST /api/rest/2.0/groups/{group_identifier}/delete
-
POST /api/rest/2.0/metadata/delete
-
POST /api/rest/2.0/orgs/{org_identifier}/update
-
POST /api/rest/2.0/orgs/{org_identifier}/delete
-
POST /api/rest/2.0/schedules/{schedule_identifier}/delete
-
POST /api/rest/2.0/schedules/{schedule_identifier}/update
-
POST /api/rest/2.0/security/metadata/assign
-
POST /api/rest/2.0/security/metadata/share
-
POST /api/rest/2.0/system/config-update
-
POST /api/rest/2.0/tags/{tag_identifier}/update
-
POST /api/rest/2.0/tags/{tag_identifier}/delete
-
POST /api/rest/2.0/tags/assign
-
POST /api/rest/2.0/tags/unassign
-
POST /api/rest/2.0/vcs/git/config/delete
-
POST /api/rest/2.0/auth/session/login
-
POST /api/rest/2.0/auth/session/logout
-
POST /api/rest/2.0/auth/token/revoke
Version 9.4.0.cl, August 2023π
API endpoints to schedule and manage Liveboard jobsπ
-
POST /api/rest/2.0/schedules/create
Creates a scheduled job for a Liveboard -
POST /api/rest/2.0/schedules/{schedule_identifier}/update
Updates a scheduled job -
POST /api/rest/2.0/schedules/search
Gets a list of Liveboard jobs configured on a ThoughtSpot instance -
POST /api/rest/2.0/schedules/{schedule_identifier}/delete
Deletes a scheduled job.
For more information, see REST API v2.0 Reference.
API to fetch authentication tokenπ
The GET /api/rest/2.0/auth/session/token
API endpoint fetches the current authentication token used by the currently logged-in user.
Version Control API enhancementsπ
-
The following Version Control API endpoints support generating and maintaining a GUID mapping file on a Git branch connected to a ThoughtSpot instance:
-
POST /api/rest/2.0/vcs/git/config/create
-
POST /api/rest/2.0/vcs/git/config/update
-
User and group API enhancementsπ
-
The
POST /api/rest/2.0/users/{user_identifier}/update
andPOST /api/rest/2.0/groups/{group_identifier}/update
support specifying the type of operation API request. For example, if you are removing a property of a user or group object, you can specify theoperation
type asREMOVE
in the API request. -
The
POST /api/rest/2.0/users/{user_identifier}/update
allows you to define locale settings, preferences, and other properties for a user object.
Version 9.3.0.cl, June 2023π
The following Version Control Beta API endpoints are now available for the lifecycle management of content on your deployment environments:
-
POST /api/rest/2.0/vcs/git/config/search
-
POST /api/rest/2.0/vcs/git/commits/search
-
POST /api/rest/2.0/vcs/git/config/create
-
POST /api/rest/2.0/vcs/git/config/update
-
POST /api/rest/2.0/vcs/git/config/delete
-
POST /api/rest/2.0/vcs/git/branches/commit
-
POST /api/rest/2.0/vcs/git/commits/{commit_id}/revert
-
POST /api/rest/2.0/vcs/git/branches/validate
-
POST /api/rest/2.0/vcs/git/commits/deploy
For more information, see Version control and Git integration.
Version 9.2.0.cl, May 2023π
- New endpoints
-
-
System
-
POST /api/rest/2.0/system/config-update
Updates system configuration -
GET /api/rest/2.0/system/config-overrides
Gets system configuration overrides
-
-
Connections
-
POST /api/rest/2.0/connection/create
Creates a data connection -
POST /api/rest/2.0/connection/search
Gets a list of data connections -
POST /api/rest/2.0/connection/update
Updates a data connection -
POST /api/rest/2.0/connection/delete
Deletes a data connection
-
-
- Enhancements
-
-
Support for runtime filters and runtime sorting of columns
The following REST API v2.0 endpoints support applying runtime filters and sorting column data:-
POST /api/rest/2.0/report/liveboard
-
POST /api/rest/2.0/report/answer
-
-
Search users by their favorites
The
/api/rest/2.0/users/search
API endpoint allows searching users by their favorite objects and home Liveboard setting. -
Ability to log in to a specific Org
The
/api/rest/2.0/auth/session/login
API endpoint now allows ThoughtSpot users to log in to a specific Org context.
-
Version 9.0.0.cl, February 2023π
The ThoughtSpot Cloud 9.0.0.cl release introduces the REST API v2.0 endpoints and Playground. For information about REST API v2.0 endpoints and Playground, see the following articles: