Version
A version is a historical record of an object’s state. Each successful set assigns a new version number. Listing versions returns the timeline—timestamps and version numbers—so you can fetch a specific past snapshot without guessing ids.
How many past states BigState keeps is controlled by the object’s versionDeep. If history looks empty or short, inspect the object definition and raise versionDeep when you need a longer trail.
What each row contains#
The list response is a JSON array (not a wrapper object). Each row includes:
version
Numeric state version—pass this to get state for that snapshot.
rec
Server record timestamp for that state row.
at
Logical timestamp associated with the state.
Typical flow: list versions → pick a version → Get state with that version. Omit version on get when you only need the latest.
When to use this endpoint#
- Audit or debug what changed over time for one object
- Restore a past view by reading a specific version after listing
- Confirm history depth after changing
versionDeepon the object