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.
Versions are considered a child resource of a block model. If a block model has been deleted, then requests to get its versions as a single object or as a list will fail with HTTP status code 410 Gone.
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.
When retrieving version metadata from the API, the path parameter version_id requires the value version_uuid to be used rather than the integer version_id.
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
-
Not to be confused with the Updating block model metadata workflow. ↩
