Skip to main content

Block model versions

Introduction​

After creating a block model, user columns can be added and modified using the Updating a block model workflow1, and doing so will create a new version of the block model.

Similar to BlockModel objects, the version metadata object (called Version) can be retrieved via the API as a single object or as a list.

The Version object​

The Version object contains the metadata relevant to that particular version of the block model; this includes column metadata as well as information about the block model update that created the version.

A version is uniquely identified by its version_uuid which is automatically assigned by the server on creation. The Version object also contains a version_id, an integer denoting where on the linear sequence of versions version_uuid exists. version_id increments by one every version.

If the query parameter include_changes=true is set when using Get Version, the returned object will match the schema object VersionWithChanges. This query parameter is not supported for List Versions.

Footnotes​

  1. Not to be confused with the Updating block model metadata workflow. ↩

Was this page helpful?