Block model metadata

Introduction

Once block models have been created using the create block model workflow in BlockSync, its metadata can be retrieved and modified via the API.

The BlockModel object

In BlockSync, the BlockModel object stores the attributes of a block model that are set by the user during model creation, either explicitly or via path parameters, as well as information managed by the API.

bm_uuid and org_uuid are interchangeable with bm_id and org_id.

Bounding box

The BlockModel object includes a bbox attribute. The value of the bbox attribute represents the smallest possible axis-aligned box that completely contains all blocks within the block model, irrespective of whether the blocks contain data.

Example

In the example below, the bounding box (black box) surrounds the block model.

The bounding box in responses is represented as follows:

{
    ...
    "bbox": {
        "x_minmax": {
            "min": 2.0,
            "max": 9.0
        },
        "y_minmax": {
            "min": -1.0,
            "max": 5.0
        },
        "z_minmax": {
            "min": 0.0,
            "max": 4.0
        }
    }
}