Skip to content

Obj id in sdlc #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bryanthowell-ts wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Obj id in sdlc #406

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d696b1f
Update intro-thoughtspot-objects.adoc
bryanthowell-ts Jan 12, 2026
75fc9a5
Merge pull request #405 from thoughtspot/main
bryanthowell-ts Feb 4, 2026
f0d8f00
Added obj_id to property list
bryanthowell-ts Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion modules/ROOT/pages/intro-thoughtspot-objects.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,19 @@ Before you look at the rest of the developer documentation, please review this p

== Object model hierarchy

The following figure illustrates the object model hierarchy in ThoughtSpot.
The following figure illustrates the object model hierarchy in ThoughtSpot within a single xref:orgs.adoc[Org]:

image::./images/object_model_hierarchy.png[Object Model Hierarchy]

== Object identifiers
Every object on a ThoughtSpot has a globally unique ID (GUID), visible in URLs and in REST API responses as the `id` or `metadata_id` property. GUIDs are unique within a ThoughtSpot instance and thus cannot repeat in different Orgs.

Objects have an additional `obj_id` property that is *user-settable* and *unique per Org*. It appears as `metadata_obj_id` in responses from the `/metadata/search` REST API.

Each Org can have one object with a particular `obj_id`. The combination of `org_id` + `obj_id` is completely unique per instance, so it is equivalent to the object's GUID.

`obj_id` allows exporting TML that can be imported into any Org on any instance, letting ThoughtSpot determine the GUIDs of the object automatically without requiring any additional effort on your part.

== Data modeling
You must create a data model comprising at least one link:https://docs.thoughtspot.com/cloud/latest/connections[connection, window=_blank] with one link:https://docs.thoughtspot.com/cloud/latest/connect-data[Table, window=_blank] to begin using link:https://docs.thoughtspot.com/cloud/latest/search-data[Search data, window=_blank] to create content.
Most often, there will be multiple *Tables*, with a variety of link:https://docs.thoughtspot.com/cloud/latest/tables-join[joins, window=_blank] defined in ThoughtSpot, with a link:https://docs.thoughtspot.com/cloud/latest/models[Model, window=_blank] bringing those tables together into a presentable analytic data model for the end-users.
Expand Down Expand Up @@ -89,6 +98,8 @@ The object representations in ThoughtSpot REST API include the following propert

* `id` +
GUID of the object. Unique within a given ThoughtSpot instance
* `obj_id` +
User-defined string identifer of the object. Unique within a given Org
* `author` +
GUID of the user who created / uploaded the object, or had the object transferred to them.
* `owner` +
Expand Down
Loading