VersionWithChanges

base_version_idinteger | null

Example: 4

Version the update was applied to. This will be the same as parent_version_id, except for updates made by Leapfrog, where it is the current local version when the block model is published. This is null if this is the first version.

bboxobject | null

Bounding box of data updated between this version and last version. Will be None for the initial version, and updates that only delete and rename columns.

bm_uuiduuid

Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the block model

changesVersionChanges

blocks_uploadedinteger | null

columnsVersionColumnChanges

Required

deletedstring[]

Default: []

metadata_updatedarray | null

Default: []

newstring[]

Default: []

renamedobject[]

Default: []

new_titlestring

old_titlestring

updatedstring[]

Default: []

total_blocksinteger

Required

update_typestring | null

Behaviour of the update, for blocks that are omitted from the update file.

• If set to replace, the values for blocks that are omitted will be set to null, for the selected columns. If geometry_change is true, the geometry of any parent block that has no blocks in the update file will be reset to an un-subdivided state.
• If set to merge, blocks that are omitted will be left unchanged, the values within those blocks will be the same as within the previous version.

This is null if there were no columns updated and geometry_change was not set to false.

commentstring

User-supplied comment

created_atdate-time

When the version was created

created_byUserInfo

User who performed the action that created the version

emailstring | null

Example: "kim@example.test"

The primary email address of the user. Can be null if an error occurred while retrieving this information.

iduuid

Required

Example: "59b73891-5538-4e45-ae67-f8c5b00d7405"

The ID of the user

namestring | null

Example: "Kim Kim"

The full name of the user. Can be null if an error occurred while retrieving this information.

geoscience_version_idstring | null

Example: "1234567890"

ID of the Geoscience Object Service object version associated with this block model version

mappingMapping

Columns within this version

columnsobject[]

Required

col_idstring

Example: "618d6339-2fa7-4dfd-9c7f-c0b12016639e"

The ID of the column, a UUID for non-system columns

data_type"Boolean" | "Int8" | "Int16" | "Int32" | "Int64" | "UInt8" | "UInt16" | "UInt32" | "UInt64" | "Float16" | "Float32" | "Float64" | "Utf8" | "Date32" | "Timestamp"

Capitalized list of supported PyArrow datatypes outlined in https://arrow.apache.org/docs/python/api/datatypes.html.

Timestamp datatype is expected to be used with unit measured in "us" and timezone set to "UTC" inside of parquet column header schema or it won't be accepted; an example for PyArrow binding would look like this: pa.timestamp("us", tz="UTC")

titlestring

The human-readable label used to identify the column

unit_idstring | null

The ID of the column's unit

parent_version_idinteger | null

Example: 4

Previous version. 0 if this is the first version.

version_idinteger

Example: 5

Identifier for the version within a block model as a monotonically increasing integer, where 1 is the version_id for the version created upon creation of the block model.

version_uuiduuid

Example: "3e9ce8de-f6ba-4920-8c6e-0882e90f0ed7"

A universally unique identifier for the version