Skip to main content

block-model-attribute

schema/components/block-model-attribute/1.2.0/block-model-attribute.schema.json

A block model attribute extends the standard attribute system for use with block model data. Block model attributes accommodate the variable-length sub-block structure of block models.

This component composes base-continuous-attribute and adds block-model-specific value storage. As of 1.2.0 it is the single attribute type used by the block-model object, covering both continuous and categorical attributes via its attribute_type (Boolean and Utf8 alongside the numeric, date, and timestamp types).

Used by: block-model.

See also: block-model-category-attribute (separate categorical attribute used by block-model 1.1.0 and earlier).

Properties

block-model-attribute (v1.2.0)

A block model attribute stored by the Block Model Service. Covers both continuous and categorical attributes.

PropertyTypeDescriptionFlags
nameStringThe name of the attribute⬆️
keyStringAn identifier of the attribute, used to keep track of the attribute when it is renamed.
The identifier must be unique within an attribute list.
⬆️
attribute_typeStringType of the attribute.⬆️
attribute_descriptionattribute-descriptionThe attribute description record.⬆️
attribute_typeStringThe data type of the attribute as stored in the Block Model Service.
block_model_column_uuidStringThe unique ID of the attribute on the block model.

Legend

FlagDescription
⬆️Inherited property
Required property

Was this page helpful?