One attribute definition, flattened to tokens. The same shape for the compiled-in system registry and a workspace's custom records; system says which this is.
API reference sections
Schema
AttributeDefinition
Type object
Shape
| Field | Type | Description |
|---|---|---|
| idrequired | string | Stable identity: the namespaced key itself for a system attribute, a generated UUID for a custom one. Rename never changes it. |
| keyrequired | string | The key values are stored under. |
| labelrequired | string | Display only, freely renameable. |
| value_typerequired | string |
The definition declares which temporal type the key takes. A shared key such as |
| cardinalityrequired | string |
|
| scoperequired | string |
|
| systemrequired | boolean | |
| options | array of string | The legal tokens for a select; empty otherwise, and empty for Default |
| filterablerequired | boolean | |
| sortablerequired | boolean | |
| groupablerequired | boolean |
{
"id": "string",
"key": "string",
"label": "string",
"value_type": "string",
"cardinality": "string",
"scope": "string",
"system": false,
"options": [],
"filterable": false,
"sortable": false,
"groupable": false
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .
