block-model-attribute
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).
As of 1.3.0 an attribute may also declare membership of an attribute group through the optional
block_model_group_uuid, which references the group_uuid of a
block-model-attribute-group declared on the block-model object. An attribute
without block_model_group_uuid is ungrouped.
Used by: block-model.
See also: block-model-attribute-group (grouping metadata for these attributes), block-model-category-attribute (separate categorical attribute used by block-model 1.1.0 and earlier).
Properties
block-model-attribute (v1.3.0)
A block model attribute stored by the Block Model Service. Covers both continuous and categorical attributes.
| Property | Type | Description | Flags |
|---|---|---|---|
| name | String | The name of the attribute | ⬆️ ✅ |
| key | String | An 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_type | String | Type of the attribute. | ⬆️ ✅ |
| attribute_description | attribute-description | The attribute description record. | ⬆️ |
| attribute_type | String | The data type of the attribute as stored in the Block Model Service. | ✅ |
| block_model_column_uuid | String | The unique ID of the attribute on the block model. | ✅ |
| block_model_group_uuid | String | The unique ID of the attribute group (column group) that the attribute belongs to. |
Legend
| Flag | Description |
|---|---|
| ⬆️ | Inherited property |
| ✅ | Required property |
