Skip to main content

Version

API output

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.

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.

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

ID of the block model

User-supplied comment

When the version was created

User who performed the action that created the version

Example: "kim@example.test"

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

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

The ID of the user

Example: "Kim Kim"

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

Example: "1234567890"

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

Columns within this version

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

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

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")

Publisher-supplied free-form metadata for the column, as a JSON object. Keys must be non-empty strings (≤ 256 chars) with no leading whitespace or dot and none of the characters / \ : > < | ? " *; keys are unique case-insensitively. Values may be any JSON-compatible type. A single tags object serialised as UTF-8 JSON must be at most 10 KiB.

The human-readable label used to identify the column

The ID of the column's unit

Default: []

Column groups within this version.

Default: []

Column UUIDs that are direct members of this group.

Example: "00633b08-165b-4dcb-bbae-0d3befa74c7e"

Unique identifier for the group.

When true, the group's direct member columns are excluded from wildcard queries unless include_hidden is set.

Policy for columns in this group's zone that are absent from an update.

UUID of the parent group within the same block model. Null means root.

Publisher-supplied free-form metadata for the group, as a JSON object. Keys must be non-empty strings (≤ 256 chars) with no leading whitespace or dot and none of the characters / \ : > < | ? " *; keys are unique case-insensitively. Values may be any JSON-compatible type. A single tags object serialised as UTF-8 JSON must be at most 10 KiB.

Human-readable label for the group, unique across the block model.

Example: 4

Previous version. 0 if this is the first version.

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.

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

A universally unique identifier for the version

Was this page helpful?