workspaceModelFoundation
Properties, variants, types and bounds for workspaceModelFoundation.
This reference describes the full structure of workspaceModelFoundation. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.
Structure and values
| Field | Options / expected values | Description |
|---|---|---|
views |
Array<closed object>; max length 100; optional |
Optional. Declared views presenting content within the relevant scope. |
views[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
views[].spaceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
views[].kind |
"calendar" | "cards" | "gantt" | "graph" | "kanban" | "table" | "timeline" |
Required. Selects the variant and the properties admitted in this branch. |
views[].nodeSurfaceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
views[].fieldMappings |
Array<closed object>; max length 30 |
Required. Defines field Mappings for this object. Observe the type, variants and bounds in the Options column. |
views[].fieldMappings[].semantic |
string; min length 1; max length 4000 |
Required. Defines semantic for this object. Observe the type, variants and bounds in the Options column. |
views[].fieldMappings[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
views[].schedule |
closed object; semantic validation; optional |
Optional. Defines schedule for this object. Observe the type, variants and bounds in the Options column. |
views[].schedule.durationUnit |
"millisecond" | "hour" | "day" |
Required. Defines duration Unit for this object. Observe the type, variants and bounds in the Options column. |
views[].schedule.progressScale |
"ratio" | "percent" |
Required. Defines progress Scale for this object. Observe the type, variants and bounds in the Options column. |
views[].schedule.dependencies |
Array<closed object>; min length 1; max length 100 |
Required. Defines dependencies for this object. Observe the type, variants and bounds in the Options column. |
views[].schedule.dependencies[].linkTypePath |
string; min length 1 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
views[].schedule.dependencies[].predecessor |
"source" | "target" |
Required. Defines predecessor for this object. Observe the type, variants and bounds in the Options column. |
views[].linkTypePaths |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
views[].presentationRole |
"workmap.view" | "worknode.card" | "workmap.status" | "knowledge.explorer" |
Required. Defines presentation Role for this object. Observe the type, variants and bounds in the Options column. |
composition |
closed object |
Required. Declarative organization of components, sources or Spaces for the selected variant. |
composition.workspaceDefinitionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.spaces |
Array<closed object>; min length 1; max length 20 |
Required. Content slots defining roles, associations and reuse rules. |
composition.spaces[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
composition.spaces[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
composition.spaces[].linkTypePath |
string; min length 1; max length 4000 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
composition.spaces[].profile |
"knowledge" | "data" | "work" | "product" |
Required. Semantic or presentation profile recognized by this variant. |
composition.spaces[].workspaceDefinitionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.spaces[].required |
true | false |
Required. Whether a value is required by this declaration. |
composition.spaces[].reuse |
closed object |
Required. Conditions for reusing a compatible Space without copying its data. |
composition.spaces[].reuse.allowed |
true | false |
Required. Defines allowed for this object. Observe the type, variants and bounds in the Options column. |
composition.spaces[].reuse.modelIds |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines model Ids for this object. Observe the type, variants and bounds in the Options column. |
composition.spaces[].reuse.workspaceDefinitionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.navigation |
Array<closed object>; min length 1; max length 40 |
Required. Declared destinations in presentation order. |
composition.navigation[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
composition.navigation[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
composition.navigation[].icon |
"home" | "book" | "users" | "map" | "work" | "graph" | "layers" | "settings" | "document" | "table" OR closed object |
Required. Icon from the catalog admitted for this presentation variant. |
composition.navigation[].icon.[variant 2].catalog |
Managed by Surface; supplied by the Model tools. |
Required. Defines catalog for this object. Observe the type, variants and bounds in the Options column. |
composition.navigation[].icon.[variant 2].revision |
"0.468.0" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
composition.navigation[].icon.[variant 2].name |
string; min length 1; max length 120; semantic validation |
Required. Readable name of the element in its presentation context. |
composition.navigation[].kind |
"home" | "collection" | "knowledge" | "work" | "product" | "graph" |
Required. Selects the variant and the properties admitted in this branch. |
composition.navigation[].spaceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.navigation[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
composition.navigation[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
composition.navigation[].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null; optional |
Optional. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.navigation[].formKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.navigation[].description |
string; min length 1; max length 4000; optional |
Optional. Explanation of this element’s purpose, content or effect. |
composition.navigation[].secondaryActionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 10; optional |
Optional. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
composition.navigation[].placement |
"primary" | "secondary"; optional |
Optional. Defines placement for this object. Observe the type, variants and bounds in the Options column. |
composition.defaultDestination |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Existing destination key opened when entering the app. |
composition.launchActions |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 30 |
Required. Defines launch Actions for this object. Observe the type, variants and bounds in the Options column. |
composition.homeSections |
Array<closed object>; max length 20; optional |
Optional. Defines home Sections for this object. Observe the type, variants and bounds in the Options column. |
composition.homeSections[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
composition.homeSections[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
composition.homeSections[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
composition.homeSections[].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
operatingKnowledge |
closed object |
Required. References to operating guides required by the Model and its Workspaces. |
operatingKnowledge.modelInstructionsDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 20 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
operatingKnowledge.modelIndexDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
operatingKnowledge.workspaceInstructionsDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 20 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
operatingKnowledge.platformTopicKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 30 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
publication |
closed object |
Required. Distribution terms, license, capabilities and required connections. |
publication.kind |
"workspace-application" |
Required. Selects the variant and the properties admitted in this branch. |
publication.license |
string; min length 1; max length 4000 |
Required. Declared app usage and redistribution terms. |
publication.requiredCapabilities |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines required Capabilities for this object. Observe the type, variants and bounds in the Options column. |
publication.requiredConnections |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines required Connections for this object. Observe the type, variants and bounds in the Options column. |
publication.sourceRights |
closed object; optional |
Optional. Source-rights descriptor whose attestation is checked by the lifecycle. |
publication.sourceRights.contract |
"ModelSourceRights@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
publication.sourceRights.issuer |
string; min length 1; max length 4000 |
Required. Defines issuer for this object. Observe the type, variants and bounds in the Options column. |
publication.sourceRights.readSource |
true |
Required. Defines read Source for this object. Observe the type, variants and bounds in the Options column. |
publication.sourceRights.privateAdaptation |
true |
Required. Declared private-adaptation permission under source terms. |
publication.sourceRights.publicRedistribution |
false |
Required. Declared public-redistribution permission under source terms. |
publication.sourceRights.requiredCapabilities |
Array<"flow.custom.create" | "studio.access">; length 2; semantic validation |
Required. Defines required Capabilities for this object. Observe the type, variants and bounds in the Options column. |
rules |
Array<closed object>; max length 200 |
Required. Named conditions reused by validation, transitions and operations. |
rules[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
rules[].expression |
recursive reference OR closed object OR closed object OR closed object |
Required. Declarative condition tree whose references and budgets are validated before evaluation. |
rules[].expression.[variant 1].[kind=present].kind |
"present" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=present].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=present].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=present].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 1].[kind=compare].kind |
"compare" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=compare].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=compare].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=compare].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 1].[kind=compare].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 1].[kind=compare].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 1].[kind=in].kind |
"in" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=in].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=in].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=in].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 1].[kind=in].values |
Array<string; max length 4000 OR number OR true | false OR null>; min length 1; max length 100 |
Required. Set of admitted or compared values according to the declared operation. |
rules[].expression.[variant 1].[kind=relation].kind |
"relation" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=relation].linkTypePath |
string; min length 1; max length 4000 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=relation].direction |
"incoming" | "outgoing" |
Required. Traversal or presentation direction using this contract’s closed values. |
rules[].expression.[variant 1].[kind=relation].minimum |
integer; ≥ 0 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
rules[].expression.[variant 1].[kind=relation].maximum |
integer; ≥ 0; null |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
rules[].expression.[variant 1].[kind=query].kind |
"query" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
rules[].expression.[variant 1].[kind=query].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation; optional |
Optional. Named operation or Query parameters and their associated values. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 1].[kind=query].operator |
"eq" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 1].[kind=query].value |
number |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 1].[kind=query-evaluation].kind |
"query-evaluation" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query-evaluation].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation; optional |
Optional. Named operation or Query parameters and their associated values. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=query-evaluation].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 1].[kind=all].kind |
"all" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=all].operands |
Array<recursive reference>; min length 1; max length 20 |
Required. Child expressions combined by the current boolean operator. |
rules[].expression.[variant 1].[kind=all].operands[] ↻ |
recursive reference to parent expression |
Optional. Defines operands ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=any].kind |
"any" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=any].operands |
Array<recursive reference>; min length 1; max length 20 |
Required. Child expressions combined by the current boolean operator. |
rules[].expression.[variant 1].[kind=any].operands[] ↻ |
recursive reference to parent expression |
Optional. Defines operands ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 1].[kind=not].kind |
"not" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 1].[kind=not].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
rules[].expression.[variant 1].[kind=not].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].kind |
"exact-compare" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=literal].value |
string; max length 1003 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=calculation].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].kind |
"arithmetic" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].operator |
"add" | "subtract" | "multiply" | "divide" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].left ↻ |
recursive reference to parent expression |
Optional. Defines left ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].right ↻ |
recursive reference to parent expression |
Optional. Defines right ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].unitOperation |
closed object; null |
Required. Defines unit Operation for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].unitOperation.key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=arithmetic].unitOperation.version |
string; min length 1; max length 120 |
Required. Declared content or publication version identifying the applicable interpretation. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].kind |
"round" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=round].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling" |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].kind |
"conditional" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition |
closed object |
Required. Defines condition for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition.kind |
"compare" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition.operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition.left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition.left ↻ |
recursive reference to parent expression |
Optional. Defines left ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition.right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].condition.right ↻ |
recursive reference to parent expression |
Optional. Defines right ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].whenTrue |
recursive reference |
Required. Defines when True for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].whenTrue ↻ |
recursive reference to parent expression |
Optional. Defines when True ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].whenFalse |
recursive reference |
Required. Defines when False for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].whenFalse ↻ |
recursive reference to parent expression |
Optional. Defines when False ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conditional].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].kind |
"conversion" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].conversionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].conversionVersion |
string; min length 1; max length 120 |
Required. Defines conversion Version for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=conversion].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].kind |
"query-total" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].operator |
"count" | "count-distinct" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=query-total].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].kind |
"aggregate" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].operator |
"sum" | "min" | "max" | "average" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].left.[kind=aggregate].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=literal].value |
string; max length 1003 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=calculation].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].kind |
"arithmetic" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].operator |
"add" | "subtract" | "multiply" | "divide" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].left ↻ |
recursive reference to parent expression |
Optional. Defines left ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].right ↻ |
recursive reference to parent expression |
Optional. Defines right ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].unitOperation |
closed object; null |
Required. Defines unit Operation for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].unitOperation.key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=arithmetic].unitOperation.version |
string; min length 1; max length 120 |
Required. Declared content or publication version identifying the applicable interpretation. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].kind |
"round" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=round].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling" |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].kind |
"conditional" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition |
closed object |
Required. Defines condition for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition.kind |
"compare" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition.operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition.left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition.left ↻ |
recursive reference to parent expression |
Optional. Defines left ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition.right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].condition.right ↻ |
recursive reference to parent expression |
Optional. Defines right ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].whenTrue |
recursive reference |
Required. Defines when True for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].whenTrue ↻ |
recursive reference to parent expression |
Optional. Defines when True ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].whenFalse |
recursive reference |
Required. Defines when False for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].whenFalse ↻ |
recursive reference to parent expression |
Optional. Defines when False ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conditional].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].kind |
"conversion" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].conversionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].conversionVersion |
string; min length 1; max length 120 |
Required. Defines conversion Version for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=conversion].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].kind |
"query-total" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].operator |
"count" | "count-distinct" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=query-total].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].kind |
"aggregate" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].operator |
"sum" | "min" | "max" | "average" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=exact-compare].right.[kind=aggregate].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].kind |
"integer-compare" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].schema |
closed object |
Required. Defines schema for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].schema.kind |
"integer" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].schema.minimum |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
rules[].expression.[variant 2].[kind=integer-compare].schema.maximum |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
rules[].expression.[variant 2].[kind=integer-compare].schema.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].schema.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].schema.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].schema.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=integer-compare].schema.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].schema.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=integer-compare].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=integer-compare].left |
closed object OR closed object |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].left.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].left.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].left.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=integer-compare].left.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=integer-compare].left.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].left.[kind=literal].value |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=integer-compare].right |
closed object OR closed object |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].right.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].right.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=integer-compare].right.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=integer-compare].right.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=integer-compare].right.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=integer-compare].right.[kind=literal].value |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=real-compare].kind |
"real-compare" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].schema |
closed object |
Required. Defines schema for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.kind |
"real" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].schema.representation |
"binary64" |
Required. Defines representation for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.precisionBits |
53 |
Required. Defines precision Bits for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.minimum |
number |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
rules[].expression.[variant 2].[kind=real-compare].schema.maximum |
number |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
rules[].expression.[variant 2].[kind=real-compare].schema.tolerance |
closed object |
Required. Defines tolerance for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.tolerance.absolute |
number; ≥ 0 |
Required. Defines absolute for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.tolerance.relative |
number; ≥ 0 |
Required. Defines relative for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.unit |
closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].schema.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].schema.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].schema.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
rules[].expression.[variant 2].[kind=real-compare].operator |
"approximately-equal" | "not-approximately-equal" |
Required. Variant comparison or operation; its value must match the expected type. |
rules[].expression.[variant 2].[kind=real-compare].left |
closed object OR closed object |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].left.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].left.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].left.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=real-compare].left.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=real-compare].left.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].left.[kind=literal].value |
number |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].expression.[variant 2].[kind=real-compare].right |
closed object OR closed object |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].right.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].right.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
rules[].expression.[variant 2].[kind=real-compare].right.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
rules[].expression.[variant 2].[kind=real-compare].right.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
rules[].expression.[variant 2].[kind=real-compare].right.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
rules[].expression.[variant 2].[kind=real-compare].right.[kind=literal].value |
number |
Required. Effective value interpreted according to the enclosing type and discriminant. |
rules[].contract |
"WorkspaceRule@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
forms |
Array<closed object>; max length 200 |
Required. Declared forms collecting values for an operation. |
forms[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
forms[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
forms[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
forms[].targetDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
forms[].mode |
"create" | "edit" | "action" |
Required. Defines mode for this object. Observe the type, variants and bounds in the Options column. |
forms[].fields |
Array<closed object; semantic validation>; max length 100 |
Required. Typed value definitions or selections within the enclosing context. |
forms[].fields[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
forms[].fields[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
forms[].fields[].input |
"text" | "multiline" | "number" | "boolean" | "date" | "datetime" | "choice" | "surface-reference" | "decimal" | "integer" | "real" | "object" | "list" |
Required. Control or input selected by the variant; must remain compatible with its binding. |
forms[].fields[].binding |
closed object OR closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
forms[].fields[].binding.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
forms[].fields[].binding.[kind=field].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
forms[].fields[].binding.[kind=title].kind |
"title" |
Required. Selects the variant and the properties admitted in this branch. |
forms[].fields[].binding.[kind=content].kind |
"content" |
Required. Selects the variant and the properties admitted in this branch. |
forms[].fields[].binding.[kind=anchor].kind |
"anchor" |
Required. Selects the variant and the properties admitted in this branch. |
forms[].fields[].binding.[kind=anchor].prototypeId |
string; min length 1; max length 4000 |
Required. Stable Anchor prototype identity used by its instances. |
forms[].fields[].binding.[kind=link].kind |
"link" |
Required. Selects the variant and the properties admitted in this branch. |
forms[].fields[].binding.[kind=link].linkTypePath |
string; min length 1; max length 4000 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
forms[].fields[].binding.[kind=link].direction |
"incoming" | "outgoing" |
Required. Traversal or presentation direction using this contract’s closed values. |
forms[].fields[].binding.[kind=link].appliesTo |
"single-created" | "each-created"; optional |
Optional. Defines applies To for this object. Observe the type, variants and bounds in the Options column. |
forms[].fields[].binding.[kind=action-input].kind |
"action-input" |
Required. Selects the variant and the properties admitted in this branch. |
forms[].fields[].binding.[kind=action-input].inputKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
forms[].fields[].required |
true | false |
Required. Whether a value is required by this declaration. |
forms[].fields[].ruleKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 30 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
forms[].fields[].options |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Suggested and admitted values for a declared choice. |
forms[].fields[].selector |
closed object; optional |
Optional. Defines selector for this object. Observe the type, variants and bounds in the Options column. |
forms[].fields[].selector.queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
forms[].fields[].selector.multiple |
true | false |
Required. Defines multiple for this object. Observe the type, variants and bounds in the Options column. |
forms[].fields[].selector.minimum |
integer; ≥ 0; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
forms[].fields[].selector.maximum |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
forms[].fields[].contract |
"WorkspaceFormControl@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
forms[].fields[].repeatable |
true | false |
Required. Whether multiple values or instances are admitted. |
forms[].ruleKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 30 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
forms[].contract |
"WorkspaceForm@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
lifecycles |
Array<closed object>; max length 100 |
Required. Business states, transitions and object conditions. |
lifecycles[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
lifecycles[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
lifecycles[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
lifecycles[].initialState |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Declared state used at creation or initialization. |
lifecycles[].states |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 50 |
Required. Lifecycle-recognized states referenced by stable keys. |
lifecycles[].transitions |
Array<closed object>; max length 200 |
Required. Admitted state changes with their conditions and effects. |
lifecycles[].transitions[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
lifecycles[].transitions[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
lifecycles[].transitions[].from |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 50 |
Required. Starting state or source for the transition or relation. |
lifecycles[].transitions[].to |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Target state or destination for the transition or relation. |
lifecycles[].transitions[].ruleKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 30 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
lifecycles[].transitions[].confirmation |
true | false |
Required. Requires or configures intent review before execution; does not replace permissions. |
lifecycles[].review |
closed object; optional |
Optional. Conditions and context for human content or result review. |
lifecycles[].review.contract |
"SurfaceLifecycleReview@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
lifecycles[].review.reviewerFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
lifecycles[].review.reviewedRevisionFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
queries |
Array<closed object>; max length 200 |
Required. Named reads with admitted sources, parameters and operations. |
queries[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
queries[].projection |
closed object; optional |
Optional. Defines projection for this object. Observe the type, variants and bounds in the Options column. |
queries[].projection.contract |
"WorkspaceQueryProjection@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
queries[].projection.anchors |
true | false |
Required. Document section prototypes with identity, protection and cardinality. |
queries[].projection.calculations |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u>; max length 20 |
Required. Defines calculations for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation |
closed object; semantic validation; optional |
Optional. Defines evidence Evaluation for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation.contract |
"WorkspaceQueryEvidenceEvaluation@1" | "WorkspaceQueryEvidenceEvaluation@2" | "WorkspaceQueryEvidenceEvaluation@3" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
queries[].evidenceEvaluation.sourceParameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].evidenceEvaluation.sourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
queries[].evidenceEvaluation.evidenceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
queries[].evidenceEvaluation.evidencePredicates |
Array<closed object>; max length 30 |
Required. Defines evidence Predicates for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation.evidencePredicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
queries[].evidenceEvaluation.evidencePredicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Required. Variant comparison or operation; its value must match the expected type. |
queries[].evidenceEvaluation.evidencePredicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
queries[].evidenceEvaluation.resultDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
queries[].evidenceEvaluation.resultLinkTypePath |
string; min length 1; max length 4000 |
Required. Declared relation type with sources, targets and direction compatible with this traversal. |
queries[].evidenceEvaluation.requiredSourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
queries[].evidenceEvaluation.coveredSourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100; optional |
Optional. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
queries[].evidenceEvaluation.minimumResults |
integer; ≥ 1; ≤ 1000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].evidenceEvaluation.maximumResults |
integer; ≥ 1; ≤ 1000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].evidenceEvaluation.maximumPages |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].evidenceEvaluation.maximumOutputBytes |
integer; ≥ 1000; ≤ 2000000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].evidenceEvaluation.blockingSources |
closed object; optional |
Optional. Defines blocking Sources for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation.blockingSources.definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation.blockingSources.predicates |
Array<closed object>; min length 1; max length 30 |
Required. Typed conditions restricting objects within the declared scope. |
queries[].evidenceEvaluation.blockingSources.predicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
queries[].evidenceEvaluation.blockingSources.predicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Required. Variant comparison or operation; its value must match the expected type. |
queries[].evidenceEvaluation.blockingSources.predicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
queries[].evidenceEvaluation.additionalBlockingSources |
Array<closed object>; min length 1; max length 20; optional |
Optional. Defines additional Blocking Sources for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation.additionalBlockingSources[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].evidenceEvaluation.additionalBlockingSources[].predicates |
Array<closed object>; min length 1; max length 30 |
Required. Typed conditions restricting objects within the declared scope. |
queries[].evidenceEvaluation.additionalBlockingSources[].predicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
queries[].evidenceEvaluation.additionalBlockingSources[].predicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Required. Variant comparison or operation; its value must match the expected type. |
queries[].evidenceEvaluation.additionalBlockingSources[].predicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
queries[].search |
closed object; null; optional |
Optional. Search policy or configuration according to the enclosing context. |
queries[].search.parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].search.mode |
"lexical" | "phrase" | "prefix" |
Required. Defines mode for this object. Observe the type, variants and bounds in the Options column. |
queries[].spaceKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 20 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters |
Array<closed object OR closed object OR closed object OR closed object OR closed object; semantic validation>; max length 20 |
Required. Named operation or Query parameters and their associated values. |
queries[].parameters[].[variant 1].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 1].type |
"text" | "number" | "boolean" | "node-id" |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 1].required |
true | false |
Required. Whether a value is required by this declaration. |
queries[].parameters[].[variant 2].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 2].type |
"decimal" |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 2].required |
true | false |
Required. Whether a value is required by this declaration. |
queries[].parameters[].[variant 2].format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
queries[].parameters[].[variant 2].format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 2].format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 2].unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 2].unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 2].unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 2].unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 2].unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 2].unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 1].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 1].type |
"integer" |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 1].required |
true | false |
Required. Whether a value is required by this declaration. |
queries[].parameters[].[variant 3].[variant 1].schema |
closed object |
Required. Defines schema for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 1].schema.kind |
"integer" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 1].schema.minimum |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].parameters[].[variant 3].[variant 1].schema.maximum |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].parameters[].[variant 3].[variant 1].schema.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 1].schema.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 1].schema.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 1].schema.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 1].schema.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 1].schema.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 2].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 2].type |
"real" |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].required |
true | false |
Required. Whether a value is required by this declaration. |
queries[].parameters[].[variant 3].[variant 2].schema |
closed object |
Required. Defines schema for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.kind |
"real" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 2].schema.representation |
"binary64" |
Required. Defines representation for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.precisionBits |
53 |
Required. Defines precision Bits for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.minimum |
number |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].parameters[].[variant 3].[variant 2].schema.maximum |
number |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].parameters[].[variant 3].[variant 2].schema.tolerance |
closed object |
Required. Defines tolerance for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.tolerance.absolute |
number; ≥ 0 |
Required. Defines absolute for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.tolerance.relative |
number; ≥ 0 |
Required. Defines relative for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.unit |
closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 2].schema.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 2].schema.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 2].schema.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 3].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 3].type |
"choice" |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 3].required |
true | false |
Required. Whether a value is required by this declaration. |
queries[].parameters[].[variant 3].[variant 3].schema |
closed object |
Required. Defines schema for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 3].schema.kind |
"choice" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].parameters[].[variant 3].[variant 3].schema.labelLocale |
string; min length 2; max length 100; /^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\s\S])/u |
Required. Defines label Locale for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 3].schema.choices |
Array<closed object>; min length 1; max length 1000 |
Required. Defines choices for this object. Observe the type, variants and bounds in the Options column. |
queries[].parameters[].[variant 3].[variant 3].schema.choices[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*(?![\s\S])/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
queries[].parameters[].[variant 3].[variant 3].schema.choices[].labels |
Record<string; min length 2; max length 100; /^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\s\S])/u, string; min length 1; max length 4000> |
Required. Defines labels for this object. Observe the type, variants and bounds in the Options column. |
queries[].predicates |
Array<closed object>; max length 30 |
Required. Typed conditions restricting objects within the declared scope. |
queries[].predicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
queries[].predicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Required. Variant comparison or operation; its value must match the expected type. |
queries[].predicates[].parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].predicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
queries[].relations |
Array<closed object>; max length 8 |
Required. Relation traversal restricting or expanding read results. |
queries[].relations[].linkTypePath |
string; min length 1; max length 4000 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
queries[].relations[].direction |
"incoming" | "outgoing" |
Required. Traversal or presentation direction using this contract’s closed values. |
queries[].relations[].parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].relations[].distinct |
true | false |
Required. Removes repeated identities where the operation admits this option. |
queries[].orderBy |
Array<closed object>; max length 5 |
Required. Declared sort order using keys within the authorized scope. |
queries[].orderBy[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
queries[].orderBy[].direction |
"ascending" | "descending" |
Required. Traversal or presentation direction using this contract’s closed values. |
queries[].aggregate |
"none" | "count" | "count-distinct" |
Required. Reduction across the complete Query scope, distinct from the displayed page. |
queries[].pageSize |
integer; ≥ 1; ≤ 100 |
Required. Requested items per page within Query limits. |
queries[].maximumDepth |
integer; ≥ 0; ≤ 8 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].traversal |
closed object; semantic validation; optional |
Optional. Defines traversal for this object. Observe the type, variants and bounds in the Options column. |
queries[].traversal.contract |
"WorkspaceQueryTraversal@1" | "WorkspaceQueryTraversal@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
queries[].traversal.sourceParameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].traversal.sourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
queries[].traversal.within |
closed object; optional |
Optional. Defines within for this object. Observe the type, variants and bounds in the Options column. |
queries[].traversal.within.parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].traversal.within.definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].traversal.within.maximumDepth |
integer; ≥ 1; ≤ 8 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
queries[].traversal.paths |
Array<closed object>; min length 1; max length 8 |
Required. Defines paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].traversal.paths[].steps |
Array<closed object OR closed object>; min length 1; max length 8 |
Required. Composition steps in their declared organization. |
queries[].traversal.paths[].steps[].[kind=links].kind |
"links" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].traversal.paths[].steps[].[kind=links].direction |
"incoming" | "outgoing" |
Required. Traversal or presentation direction using this contract’s closed values. |
queries[].traversal.paths[].steps[].[kind=links].linkTypePaths |
Array<string; min length 1; max length 4000>; min length 1; max length 20 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].traversal.paths[].steps[].[kind=links].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].traversal.paths[].steps[].[variant 2].kind |
"parent" | "children" |
Required. Selects the variant and the properties admitted in this branch. |
queries[].traversal.paths[].steps[].[variant 2].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
queries[].nativeReview |
closed object; optional |
Optional. Canonical review configuration with decision Fields and references. |
queries[].nativeReview.contract |
"WorkspaceQueryNativeReview@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
queries[].nativeReview.lifecycleKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].nativeReview.stateValue |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Defines state Value for this object. Observe the type, variants and bounds in the Options column. |
queries[].controls |
closed object; optional |
Optional. Search, filter and sorting controls connected to declared parameters. |
queries[].controls.contract |
"WorkspaceQueryControls@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
queries[].controls.filters |
Array<closed object OR closed object>; max length 20 |
Required. Defines filters for this object. Observe the type, variants and bounds in the Options column. |
queries[].controls.filters[].[variant 1].parameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].controls.filters[].[variant 1].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
queries[].controls.filters[].[variant 1].input |
"choice" |
Required. Control or input selected by the variant; must remain compatible with its binding. |
queries[].controls.filters[].[variant 1].options |
Array<closed object>; min length 1; max length 100 |
Required. Suggested and admitted values for a declared choice. |
queries[].controls.filters[].[variant 1].options[].value |
string; max length 4000 OR number OR true | false |
Required. Effective value interpreted according to the enclosing type and discriminant. |
queries[].controls.filters[].[variant 1].options[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
queries[].controls.filters[].[variant 2].parameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].controls.filters[].[variant 2].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
queries[].controls.filters[].[variant 2].input |
"text" | "number" | "decimal" | "integer" | "real" |
Required. Control or input selected by the variant; must remain compatible with its binding. |
queries[].controls.sort |
closed object; null |
Required. Defines sort for this object. Observe the type, variants and bounds in the Options column. |
queries[].controls.sort.parameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
queries[].controls.sort.label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
queries[].controls.sort.options |
Array<closed object>; min length 1; max length 30 |
Required. Suggested and admitted values for a declared choice. |
queries[].controls.sort.options[].value |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Required. Effective value interpreted according to the enclosing type and discriminant. |
queries[].controls.sort.options[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
queries[].controls.sort.options[].orderBy |
Array<closed object>; min length 1; max length 5 |
Required. Declared sort order using keys within the authorized scope. |
queries[].controls.sort.options[].orderBy[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
queries[].controls.sort.options[].orderBy[].direction |
"ascending" | "descending" |
Required. Traversal or presentation direction using this contract’s closed values. |
queries[].contract |
"WorkspaceQuery@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
searchProjections |
Array<closed object>; max length 100; optional |
Optional. Search projections defining searchable objects and values. |
searchProjections[].contract |
"SearchProjectionDefinition@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
searchProjections[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
searchProjections[].spaceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
searchProjections[].surfaceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
searchProjections[].textTargets |
Array<"title" | "description" | "content">; min length 1; max length 3 |
Required. Defines text Targets for this object. Observe the type, variants and bounds in the Options column. |
searchProjections[].fields |
Array<closed object>; max length 100 |
Required. Typed value definitions or selections within the enclosing context. |
searchProjections[].fields[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
searchProjections[].fields[].operators |
Array<"equals" | "contains" | "before" | "after" | "less-than" | "greater-than">; max length 6 |
Required. Defines operators for this object. Observe the type, variants and bounds in the Options column. |
searchProjections[].fields[].filterable |
true | false |
Required. Permits filtering this property within the declared scope. |
searchProjections[].fields[].sortable |
true | false |
Required. Permits sorting this column when supported by the Query. |
searchProjections[].fields[].facetable |
true | false |
Required. Defines facetable for this object. Observe the type, variants and bounds in the Options column. |
searchProjections[].defaultSort |
Array<closed object>; min length 1; max length 2 |
Required. Defines default Sort for this object. Observe the type, variants and bounds in the Options column. |
searchProjections[].defaultSort[].target |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines target for this object. Observe the type, variants and bounds in the Options column. |
searchProjections[].defaultSort[].direction |
"ascending" | "descending" |
Required. Traversal or presentation direction using this contract’s closed values. |
actions |
Array<closed object>; max length 200 |
Required. Application operations offered by views according to context and permissions. |
actions[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
actions[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
actions[].description |
string; min length 1; max length 4000; optional |
Optional. Explanation of this element’s purpose, content or effect. |
actions[].targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
actions[].launchSelection |
closed object; optional |
Optional. Defines launch Selection for this object. Observe the type, variants and bounds in the Options column. |
actions[].launchSelection.contract |
"WorkspaceActionLaunchSelection@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
actions[].launchSelection.formFieldKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
actions[].launchSelection.flowInputKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; optional |
Optional. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
actions[].kind |
"semantic-command" | "task" | "flow" | "lifecycle-transition" | "entity-revise" |
Required. Selects the variant and the properties admitted in this branch. |
actions[].operationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
actions[].formKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
actions[].ruleKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 30 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
actions[].contextPolicyKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
actions[].minimumRole |
"owner" | "member" |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
actions[].confirmation |
true | false |
Required. Requires or configures intent review before execution; does not replace permissions. |
actions[].launchContextPolicyKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; optional |
Optional. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
actions[].contextSelection |
closed object; optional |
Optional. Bounded object selection included in Action context. |
actions[].contextSelection.contract |
"WorkspaceActionContextSelection@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
actions[].contextSelection.queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
actions[].contextSelection.label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
consolidations |
Array<closed object>; max length 100; optional |
Optional. Proposal selection and governed updates to reference content. |
consolidations[].contract |
"SurfaceConsolidationProfile@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
consolidations[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
consolidations[].currentSelection |
closed object |
Required. Defines current Selection for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].currentSelection.contract |
"SurfaceWorkSelectionBinding@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
consolidations[].currentSelection.linkTypePath |
string; min length 1; max length 4000 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].workDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
consolidations[].proposalDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 20 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
consolidations[].decisionDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
consolidations[].targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
consolidations[].workTargetLinkTypePath |
string; min length 1; max length 4000 |
Required. Declared relation type with sources, targets and direction compatible with this traversal. |
consolidations[].retainedProposalLinkTypePath |
string; min length 1; max length 4000 |
Required. Declared relation type with sources, targets and direction compatible with this traversal. |
consolidations[].decisionTargetLinkTypePath |
string; min length 1; max length 4000 |
Required. Declared relation type with sources, targets and direction compatible with this traversal. |
consolidations[].decisionFields |
closed object |
Required. Defines decision Fields for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].decisionFields.stateFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
consolidations[].decisionFields.retainedState |
string; min length 1; max length 4000 |
Required. Defines retained State for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].decisionFields.appliedState |
string; min length 1; max length 4000 |
Required. Defines applied State for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].decisionFields.rationaleFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
consolidations[].decisionFields.authorFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
consolidations[].targetFormActionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
consolidations[].selectionPatch |
true | false |
Required. Defines selection Patch for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].workState |
closed object; optional |
Optional. Defines work State for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].workState.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
consolidations[].workState.openValue |
string; min length 1; max length 4000 |
Required. Defines open Value for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].workState.resolvedValue |
string; min length 1; max length 4000 |
Required. Defines resolved Value for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].maximumSourceReferences |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
consolidations[].retainedTitle |
string; min length 1; max length 4000 |
Required. Defines retained Title for this object. Observe the type, variants and bounds in the Options column. |
consolidations[].appliedTitle |
string; min length 1; max length 4000 |
Required. Defines applied Title for this object. Observe the type, variants and bounds in the Options column. |
triggers |
Array<closed object>; max length 100 |
Required. Declared reactions to identified events or deadlines. |
triggers[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
triggers[].enabledByDefault |
true | false |
Required. Defines enabled By Default for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event |
closed object OR closed object OR closed object OR closed object |
Required. Recognized event type for triggering or resuming the operation. |
triggers[].event.[kind=revision].kind |
"revision" |
Required. Selects the variant and the properties admitted in this branch. |
triggers[].event.[kind=revision].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event.[kind=revision].fieldKeys |
Array<string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u>; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].event.[kind=revision].contentComparison |
"document-text"; optional |
Optional. Defines content Comparison for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event.[kind=revision].ruleRevision |
"after" | "before-or-after"; optional |
Optional. Defines rule Revision for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event.[kind=relation].kind |
"relation" |
Required. Selects the variant and the properties admitted in this branch. |
triggers[].event.[kind=relation].linkTypePaths |
Array<string; min length 1; max length 4000>; max length 100; min length 1 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event.[kind=due].kind |
"due" |
Required. Selects the variant and the properties admitted in this branch. |
triggers[].event.[kind=due].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event.[kind=due].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
triggers[].event.[kind=due].timeZone |
string; min length 1; max length 4000 |
Required. Timezone identifier used to interpret times and daylight-saving changes. |
triggers[].event.[kind=due].missed |
"once" | "skip" |
Required. Policy for an occurrence not processed at its scheduled time. |
triggers[].event.[kind=due].ambiguousTime |
"earlier" | "later" |
Required. Resolution policy for a local time mapping to several instants. |
triggers[].event.[kind=due].nonexistentTime |
"next-valid" | "skip" |
Required. Policy for a local time missing during a daylight-saving transition. |
triggers[].event.[kind=external].kind |
"external" |
Required. Selects the variant and the properties admitted in this branch. |
triggers[].event.[kind=external].connectionCapability |
string; min length 1; max length 4000 |
Required. Defines connection Capability for this object. Observe the type, variants and bounds in the Options column. |
triggers[].event.[kind=external].eventKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].ruleKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 30 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
triggers[].mode |
"propose" | "execute" |
Required. Defines mode for this object. Observe the type, variants and bounds in the Options column. |
triggers[].executionCapability |
string; min length 1; max length 4000; null |
Required. Defines execution Capability for this object. Observe the type, variants and bounds in the Options column. |
triggers[].maximumCascadeDepth |
integer; ≥ 0; ≤ 8 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
triggers[].historicalEvents |
"explicit-backfill-only" |
Required. Defines historical Events for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention |
closed object; optional |
Optional. Defines attention for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.contract |
"SurfaceTriggerAttention@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
triggers[].attention.policyKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].attention.spaceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].attention.manifestDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
triggers[].attention.attentionDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
triggers[].attention.proposalDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
triggers[].attention.consolidationProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].attention.querySourceParameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].attention.sourceLinkTypePath |
string; min length 1; max length 4000 |
Required. Declared relation type with sources, targets and direction compatible with this traversal. |
triggers[].attention.freshnessFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
triggers[].attention.metadataFields |
closed object |
Required. Defines metadata Fields for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.metadataFields.policyKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].attention.metadataFields.triggerKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].attention.metadataFields.targetId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines target Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.metadataFields.targetRevisionId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines target Revision Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.metadataFields.sourceId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines source Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.metadataFields.sourceRevisionId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines source Revision Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.metadataFields.eventSequence |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines event Sequence for this object. Observe the type, variants and bounds in the Options column. |
triggers[].attention.title |
string; min length 1; max length 4000 |
Required. Title of the object or section in the interface. |
triggers[].attention.maximumPages |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
triggers[].attention.maximumOutputBytes |
integer; ≥ 1000; ≤ 2000000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
triggers[].deadline |
closed object; optional |
Optional. Versioned deadline policy defining time calculation and handling. |
triggers[].deadline.contract |
"SurfaceTriggerDeadline@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
triggers[].deadline.sourceQueryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].deadline.maximumScheduledNodes |
integer; ≥ 1; ≤ 10000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
triggers[].deadline.lateToleranceMs |
integer; ≥ 0; ≤ 86400000 |
Required. Defines late Tolerance Ms for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadline.localTime |
string; /^(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d$/u; optional |
Optional. Local time in the required format, interpreted in the declared timezone. |
triggers[].deadlineAttention |
closed object; optional |
Optional. Defines deadline Attention for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.contract |
"SurfaceTriggerDeadlineAttention@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
triggers[].deadlineAttention.policyKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].deadlineAttention.spaceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].deadlineAttention.manifestDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
triggers[].deadlineAttention.attentionDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
triggers[].deadlineAttention.proposalDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
triggers[].deadlineAttention.consolidationProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].deadlineAttention.sourceLinkTypePath |
string; min length 1; max length 4000 |
Required. Declared relation type with sources, targets and direction compatible with this traversal. |
triggers[].deadlineAttention.freshnessFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
triggers[].deadlineAttention.metadataFields |
closed object |
Required. Defines metadata Fields for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.metadataFields.policyKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].deadlineAttention.metadataFields.triggerKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
triggers[].deadlineAttention.metadataFields.targetId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines target Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.metadataFields.targetRevisionId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines target Revision Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.metadataFields.sourceId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines source Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.metadataFields.sourceRevisionId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines source Revision Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.metadataFields.deadlineAt |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines deadline At for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.metadataFields.occurrenceId |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Defines occurrence Id for this object. Observe the type, variants and bounds in the Options column. |
triggers[].deadlineAttention.title |
string; min length 1; max length 4000 |
Required. Title of the object or section in the interface. |
triggers[].deadlineAttention.maximumOutputBytes |
integer; ≥ 1000; ≤ 2000000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
triggers[].deadlineAttention.target |
"source" |
Required. Defines target for this object. Observe the type, variants and bounds in the Options column. |
changePolicies |
Array<closed object>; max length 100 |
Required. Policy for handling dependencies after a source changes. |
changePolicies[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
changePolicies[].sourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
changePolicies[].linkTypePaths |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
changePolicies[].mode |
"pin-revision" | "mark-needs-review" | "propose-action" | "recompute" |
Required. Defines mode for this object. Observe the type, variants and bounds in the Options column. |
changePolicies[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Reference to a declared Action; rendering does not execute it. |
changePolicies[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
changePolicies[].maximumTargets |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
changePolicies[].capture |
closed object; optional |
Optional. Defines capture for this object. Observe the type, variants and bounds in the Options column. |
changePolicies[].capture.contract |
"SurfaceReferenceCapturePolicy@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
changePolicies[].capture.actionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 20 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
changePolicies[].capture.ruleKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
changePolicies[].capture.sourceParameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
changePolicies[].capture.maximumPages |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
changePolicies[].capture.maximumSources |
integer; ≥ 1; ≤ 10000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
changePolicies[].capture.maximumOutputBytes |
integer; ≥ 1000; ≤ 2000000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies |
Array<closed object OR closed object OR closed object OR closed object>; max length 100 |
Required. Selection and budgets for business information supplied to AI context. |
contextPolicies[].[variant 1].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[variant 1].targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
contextPolicies[].[variant 1].sources |
Array<closed object>; max length 100 |
Required. Defines sources for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[variant 1].sources[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[variant 1].sources[].kind |
"target" | "relation" | "query" | "knowledge" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[variant 1].sources[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[variant 1].sources[].linkTypePaths |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[variant 1].sources[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
contextPolicies[].[variant 1].sources[].required |
true | false |
Required. Whether a value is required by this declaration. |
contextPolicies[].[variant 1].sources[].revision |
"current" | "captured" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[variant 1].sources[].priority |
integer; ≥ 0; ≤ 1000 |
Required. Defines priority for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[variant 1].sources[].maximumItems |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[variant 1].sources[].maximumCharacters |
integer; ≥ 1; ≤ 100000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[variant 1].maximumCharacters |
integer; ≥ 1; ≤ 500000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@2].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@2].targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources |
Array<closed object>; max length 100 |
Required. Defines sources for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].kind |
"target" | "relation" | "query" | "knowledge" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].linkTypePaths |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].required |
true | false |
Required. Whether a value is required by this declaration. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].revision |
"current" | "captured" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].priority |
integer; ≥ 0; ≤ 1000 |
Required. Defines priority for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].maximumItems |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].maximumCharacters |
integer; ≥ 1; ≤ 100000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object> |
Required. Named operation or Query parameters and their associated values. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@2].sources[].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
contextPolicies[].[contract=SurfaceContextPolicy@2].maximumCharacters |
integer; ≥ 1; ≤ 500000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@2].contract |
"SurfaceContextPolicy@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
contextPolicies[].[contract=SurfaceContextPolicy@2].executionBindings |
Array<closed object>; max length 100 |
Required. Defines execution Bindings for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@2].executionBindings[].taskActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@2].executionBindings[].applicationActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@2].executionBindings[].selection |
"task-parent" |
Required. Defines selection for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@3].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@3].targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources |
Array<closed object>; min length 1; max length 100 |
Required. Defines sources for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].kind |
"form-reference" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; length 0 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].linkTypePaths |
Array<string; min length 1; max length 4000>; length 0 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].queryKey |
null |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].required |
true | false |
Required. Whether a value is required by this declaration. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].revision |
"current" | "captured" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].priority |
integer; ≥ 0; ≤ 1000 |
Required. Defines priority for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].maximumItems |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].maximumCharacters |
integer; ≥ 1; ≤ 100000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@3].sources[].formFieldKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Key of a declared Field on the relevant type; its value type must be compatible with this use. |
contextPolicies[].[contract=SurfaceContextPolicy@3].maximumCharacters |
integer; ≥ 1; ≤ 500000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@3].contract |
"SurfaceContextPolicy@3" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
contextPolicies[].[contract=SurfaceContextPolicy@3].launchActionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@4].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@4].targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources |
Array<closed object OR closed object>; max length 100 |
Required. Defines sources for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].kind |
"target" | "relation" | "query" | "knowledge" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].linkTypePaths |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines link Type Paths for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].required |
true | false |
Required. Whether a value is required by this declaration. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].revision |
"current" | "captured" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].priority |
integer; ≥ 0; ≤ 1000 |
Required. Defines priority for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].maximumItems |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].maximumCharacters |
integer; ≥ 1; ≤ 100000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object> |
Required. Named operation or Query parameters and their associated values. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[variant 1].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].kind |
"flow-reference" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].source |
closed object OR closed object |
Required. Defines source for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].source.[kind=input].kind |
"input" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].source.[kind=input].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].source.[kind=step-output].kind |
"step-output" |
Required. Selects the variant and the properties admitted in this branch. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].source.[kind=step-output].stepKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].source.[kind=step-output].outputKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].required |
true | false |
Required. Whether a value is required by this declaration. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].revision |
"captured" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].priority |
integer; ≥ 0; ≤ 1000 |
Required. Defines priority for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].maximumItems |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@4].sources[].[kind=flow-reference].maximumCharacters |
integer; ≥ 1; ≤ 100000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@4].maximumCharacters |
integer; ≥ 1; ≤ 500000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contextPolicies[].[contract=SurfaceContextPolicy@4].contract |
"SurfaceContextPolicy@4" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
contextPolicies[].[contract=SurfaceContextPolicy@4].executionBindings |
Array<closed object>; max length 100 |
Required. Defines execution Bindings for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].executionBindings[].taskActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@4].executionBindings[].applicationActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@4].executionBindings[].selection |
"task-parent" |
Required. Defines selection for this object. Observe the type, variants and bounds in the Options column. |
contextPolicies[].[contract=SurfaceContextPolicy@4].executionBindings[].blueprintKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contextPolicies[].[contract=SurfaceContextPolicy@4].executionBindings[].taskStepKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contentLifecyclePolicies |
Array<closed object>; max length 100; optional |
Optional. Content archive, deletion and restoration rules. |
contentLifecyclePolicies[].contract |
"ContentLifecyclePolicy@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
contentLifecyclePolicies[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
contentLifecyclePolicies[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
contentLifecyclePolicies[].operations |
Array<"archive" | "delete" | "restore">; min length 1; max length 3 |
Required. Defines operations for this object. Observe the type, variants and bounds in the Options column. |
contentLifecyclePolicies[].minimumApplicationRole |
"owner" | "member" |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contentLifecyclePolicies[].minimumContentRole |
"owner" | "editor" |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
contentLifecyclePolicies[].requiredCapabilities |
Array<string; min length 1; max length 4000>; max length 100 |
Required. Defines required Capabilities for this object. Observe the type, variants and bounds in the Options column. |
contentLifecyclePolicies[].descendants |
"owned-hierarchy" |
Required. Defines descendants for this object. Observe the type, variants and bounds in the Options column. |
contentLifecyclePolicies[].references |
"preserve" |
Required. Defines references for this object. Observe the type, variants and bounds in the Options column. |
contentLifecyclePolicies[].maximumNodes |
integer; ≥ 1; ≤ 1000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
relationPolicies |
Array<closed object>; max length 100 |
Required. Relation compatibility, cardinality and operation constraints. |
relationPolicies[].contract |
"SurfaceRelationPolicy@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
relationPolicies[].key |
string; /^[a-z][a-z0-9-]*$/; max length 120 |
Required. Stable semantic identifier used by references; changing it changes identity. |
relationPolicies[].linkTypePath |
string; min length 1; max length 600 |
Required. Defines link Type Path for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].source |
closed object |
Required. Defines source for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].source.definitionPaths |
Array<string; min length 1; max length 600>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].source.fields |
Array<closed object>; max length 30 |
Required. Typed value definitions or selections within the enclosing context. |
relationPolicies[].source.fields[].fieldKey |
string; /^[a-z][a-zA-Z0-9-]*$/; max length 120 |
Required. Key of a Field declared on the referenced Surface definition. |
relationPolicies[].source.fields[].values |
Array<string; max length 20000 OR number OR true | false>; min length 1; max length 30 |
Required. Set of admitted or compared values according to the declared operation. |
relationPolicies[].target |
closed object |
Required. Defines target for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].target.definitionPaths |
Array<string; min length 1; max length 600>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].target.fields |
Array<closed object>; max length 30 |
Required. Typed value definitions or selections within the enclosing context. |
relationPolicies[].target.fields[].fieldKey |
string; /^[a-z][a-zA-Z0-9-]*$/; max length 120 |
Required. Key of a Field declared on the referenced Surface definition. |
relationPolicies[].target.fields[].values |
Array<string; max length 20000 OR number OR true | false>; min length 1; max length 30 |
Required. Set of admitted or compared values according to the declared operation. |
relationPolicies[].maximumOutgoing |
integer; ≥ 1; ≤ 10000; null |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
relationPolicies[].maximumIncoming |
integer; ≥ 1; ≤ 10000; null |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
relationPolicies[].acyclic |
true | false |
Required. Defines acyclic for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].deletion |
"allow" | "forbid" |
Required. Defines deletion for this object. Observe the type, variants and bounds in the Options column. |
relationPolicies[].maximumTraversalNodes |
integer; ≥ 1; ≤ 10000 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
presentation |
closed object |
Required. Defines presentation for this object. Observe the type, variants and bounds in the Options column. |
presentation.contract |
"WorkspaceRecordPresentation@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
presentation.recordProfiles |
Array<closed object>; max length 100 |
Required. Record profiles defining identity, cards, detail and settings. |
presentation.recordProfiles[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)+$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].editActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].identity |
closed object |
Required. Sources for information identifying the record to users. |
presentation.recordProfiles[].identity.title |
closed object OR closed object OR closed object |
Required. Title of the object or section in the interface. |
presentation.recordProfiles[].identity.title.[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.title.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
presentation.recordProfiles[].identity.title.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.title.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
presentation.recordProfiles[].identity.title.[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.title.[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].identity.avatar |
closed object |
Required. Visual identity presentation under the admitted variant. |
presentation.recordProfiles[].identity.avatar.kind |
"initials" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.avatar.maximumLetters |
integer; ≥ 1; ≤ 4 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
presentation.recordProfiles[].identity.subtitle |
closed object OR closed object OR closed object; null |
Required. Subtitle source or explicit absence where null is admitted. |
presentation.recordProfiles[].identity.subtitle.[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.subtitle.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
presentation.recordProfiles[].identity.subtitle.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.subtitle.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
presentation.recordProfiles[].identity.subtitle.[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].identity.subtitle.[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].valueLabels |
Array<closed object>; max length 100 |
Required. Mappings from stable values to user-facing labels. |
presentation.recordProfiles[].valueLabels[].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
presentation.recordProfiles[].valueLabels[].values |
Array<closed object>; min length 1; max length 100 |
Required. Set of admitted or compared values according to the declared operation. |
presentation.recordProfiles[].valueLabels[].values[].value |
string; max length 4000 OR number OR true | false |
Required. Effective value interpreted according to the enclosing type and discriminant. |
presentation.recordProfiles[].valueLabels[].values[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.recordProfiles[].card |
closed object |
Required. Summary record presentation within a collection. |
presentation.recordProfiles[].card.summary |
closed object OR closed object OR closed object; null |
Required. Defines summary for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].card.summary.[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].card.summary.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
presentation.recordProfiles[].card.summary.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].card.summary.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
presentation.recordProfiles[].card.summary.[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].card.summary.[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].card.tags |
closed object; null |
Required. Classification or display configuration for admitted tags. |
presentation.recordProfiles[].card.tags.namespace |
"user" |
Required. Namespace determining value vocabulary and scope. |
presentation.recordProfiles[].card.tags.maximumVisible |
integer; ≥ 0; ≤ 20 |
Required. Maximum number of items in the bounded preview; the full collection remains accessible separately. |
presentation.recordProfiles[].card.metricKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 20 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].card.openLabel |
string; min length 1; max length 4000 |
Required. Label opening the object’s detail. |
presentation.recordProfiles[].queryBindings |
Array<closed object>; max length 100 |
Required. Bindings from named Queries to parameter values supplied by context. |
presentation.recordProfiles[].queryBindings[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].queryBindings[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
presentation.recordProfiles[].queryBindings[].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].queryBindings[].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
presentation.recordProfiles[].metrics |
Array<closed object>; max length 20 |
Required. Declared metrics based on a Query and canonical aggregate. |
presentation.recordProfiles[].metrics[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].metrics[].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].metrics[].value |
"aggregate" |
Required. Effective value interpreted according to the enclosing type and discriminant. |
presentation.recordProfiles[].metrics[].singularLabel |
string; min length 1; max length 4000 |
Required. Label used for a single result unit. |
presentation.recordProfiles[].metrics[].pluralLabel |
string; min length 1; max length 4000 |
Required. Label used for multiple result units. |
presentation.recordProfiles[].metrics[].navigation |
closed object; null |
Required. Declared destinations in presentation order. |
presentation.recordProfiles[].metrics[].navigation.kind |
"record-related-group" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].metrics[].navigation.relatedGroupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail |
closed object |
Required. Sections, Actions, settings and relations of an open record. |
presentation.recordProfiles[].detail.primaryActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail.primaryActionLabel |
string; min length 1; max length 4000; null |
Required. Defines primary Action Label for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].detail.creationActionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail.actionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail.sections |
Array<closed object OR closed object OR closed object>; min length 1; max length 40 |
Required. Declared sections in reading or rendering order. |
presentation.recordProfiles[].detail.sections[].[kind=fields].kind |
"fields" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].detail.sections[].[kind=fields].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].detail.sections[].[kind=fields].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.recordProfiles[].detail.sections[].[kind=fields].fieldPaths |
Array<string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u>; min length 1; max length 100 |
Required. Defines field Paths for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].detail.sections[].[kind=content].kind |
"content" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].detail.sections[].[kind=content].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].detail.sections[].[kind=content].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.recordProfiles[].detail.sections[].[kind=query-view].kind |
"query-view" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.recordProfiles[].detail.sections[].[kind=query-view].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].detail.sections[].[kind=query-view].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.recordProfiles[].detail.sections[].[kind=query-view].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail.sections[].[kind=query-view].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail.settings |
closed object |
Required. Fields presented in the record settings form. |
presentation.recordProfiles[].detail.settings.fieldPaths |
Array<string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u>; max length 100 |
Required. Defines field Paths for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].detail.tags |
closed object; null |
Required. Classification or display configuration for admitted tags. |
presentation.recordProfiles[].detail.tags.namespace |
"user" |
Required. Namespace determining value vocabulary and scope. |
presentation.recordProfiles[].detail.tags.maximumVisible |
integer; ≥ 0; ≤ 20 |
Required. Maximum number of items in the bounded preview; the full collection remains accessible separately. |
presentation.recordProfiles[].detail.relatedGroups |
Array<closed object>; max length 40 |
Required. Relation groups with a Query and bounded preview plus access to the full collection. |
presentation.recordProfiles[].detail.relatedGroups[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.recordProfiles[].detail.relatedGroups[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.recordProfiles[].detail.relatedGroups[].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.recordProfiles[].detail.relatedGroups[].maximumVisible |
integer; ≥ 1; ≤ 100 |
Required. Maximum number of items in the bounded preview; the full collection remains accessible separately. |
presentation.recordProfiles[].detail.relatedGroups[].openAllLabel |
string; min length 1; max length 4000 |
Required. Label opening the full collection, such as View all. |
presentation.recordProfiles[].detail.relatedGroups[].rowIcon |
closed object; null |
Required. Defines row Icon for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].detail.relatedGroups[].rowIcon.catalog |
Managed by Surface; supplied by the Model tools. |
Required. Defines catalog for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].detail.relatedGroups[].rowIcon.revision |
"0.468.0" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
presentation.recordProfiles[].detail.relatedGroups[].rowIcon.name |
string; min length 1; max length 120; semantic validation |
Required. Readable name of the element in its presentation context. |
presentation.collectionBindings |
Array<closed object>; max length 100 |
Required. Defines collection Bindings for this object. Observe the type, variants and bounds in the Options column. |
presentation.collectionBindings[].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.collectionBindings[].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.collectionBindings[].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.collectionBindings[].returnLabel |
string; min length 1; max length 4000 |
Required. Defines return Label for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews |
Array<closed object>; max length 100 |
Required. Defines table Views for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews[].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].columns |
Array<closed object>; min length 1; max length 40 |
Required. Ordered columns and their authorized value sources. |
presentation.tableViews[].columns[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.tableViews[].columns[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.tableViews[].columns[].source |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Defines source for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews[].columns[].source.[variant 1].[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].columns[].source.[variant 1].[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
presentation.tableViews[].columns[].source.[variant 1].[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].columns[].source.[variant 1].[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
presentation.tableViews[].columns[].source.[variant 1].[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].columns[].source.[variant 1].[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].columns[].source.[kind=metric].kind |
"metric" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].columns[].source.[kind=metric].metricKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].columns[].source.[kind=related-records].kind |
"related-records" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].columns[].source.[kind=related-records].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].columns[].source.[kind=related-records].maximumVisible |
integer; ≥ 1; ≤ 20 |
Required. Maximum number of items in the bounded preview; the full collection remains accessible separately. |
presentation.tableViews[].openLabel |
string; min length 1; max length 4000 |
Required. Label opening the object’s detail. |
presentation.tableViews[].layout |
closed object; optional |
Optional. Arrangement algorithm or structure configured by variant properties. |
presentation.tableViews[].layout.contract |
"WorkspaceTableLayout@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
presentation.tableViews[].layout.columns |
Array<closed object>; min length 1; max length 40 |
Required. Ordered columns and their authorized value sources. |
presentation.tableViews[].layout.columns[].columnKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].layout.columns[].visible |
true | false |
Required. Defines visible for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews[].layout.columns[].width |
integer; ≥ 80; ≤ 1000; null |
Required. Element width in the enclosing contract’s unit. |
presentation.tableViews[].layout.columns[].frozen |
true | false |
Required. Keeps the column visible during horizontal scrolling. |
presentation.tableViews[].layout.columns[].format |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Presentation format compatible with the value type. |
presentation.tableViews[].layout.columns[].format.[kind=text].kind |
"text" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].layout.columns[].format.[kind=number].kind |
"number" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].layout.columns[].format.[kind=number].maximumFractionDigits |
integer; ≥ 0; ≤ 8 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
presentation.tableViews[].layout.columns[].format.[kind=boolean].kind |
"boolean" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].layout.columns[].format.[kind=boolean].trueLabel |
string; min length 1; max length 4000 |
Required. Defines true Label for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews[].layout.columns[].format.[kind=boolean].falseLabel |
string; min length 1; max length 4000 |
Required. Defines false Label for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews[].layout.columns[].format.[variant 4].kind |
"date" | "datetime" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].layout.columns[].format.[kind=badge].kind |
"badge" |
Required. Selects the variant and the properties admitted in this branch. |
presentation.tableViews[].layout.columns[].headerFilterParameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].layout.columnGroups |
Array<closed object>; max length 20 |
Required. Visual groups of declared columns. |
presentation.tableViews[].layout.columnGroups[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.tableViews[].layout.columnGroups[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.tableViews[].layout.columnGroups[].columnKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 40 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].layout.grouping |
closed object; null |
Required. Defines grouping for this object. Observe the type, variants and bounds in the Options column. |
presentation.tableViews[].layout.grouping.contract |
"WorkspaceTableGrouping@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
presentation.tableViews[].layout.grouping.options |
Array<closed object>; min length 1; max length 20 |
Required. Suggested and admitted values for a declared choice. |
presentation.tableViews[].layout.grouping.options[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
presentation.tableViews[].layout.grouping.options[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
presentation.tableViews[].layout.grouping.options[].columnKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].layout.grouping.initialOptionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
presentation.tableViews[].layout.grouping.maximumGroups |
integer; ≥ 1; ≤ 100 |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
homePresentation |
closed object |
Required. Defines home Presentation for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.contract |
"WorkspaceHomePresentation@2" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
homePresentation.header |
closed object |
Required. Defines header for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.header.intro |
string; min length 1; max length 4000; null |
Required. Defines intro for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.header.primaryNavigation |
closed object; null |
Required. Defines primary Navigation for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.header.primaryNavigation.destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
homePresentation.header.primaryNavigation.label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
homePresentation.launchers |
closed object |
Required. Defines launchers for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.launchers.title |
string; min length 1; max length 4000 |
Required. Title of the object or section in the interface. |
homePresentation.launchers.description |
string; min length 1; max length 4000; null |
Required. Explanation of this element’s purpose, content or effect. |
homePresentation.launchers.icons |
Array<closed object>; max length 30 |
Required. Defines icons for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.launchers.icons[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
homePresentation.launchers.icons[].icon |
"activity" | "alert" | "arrow-right" | "bot" | "briefcase" | "check" | "document" | "inbox" | "knowledge" | "marketplace" | "overview" | "portfolio" | "profile" | "search" | "users" | "map" | "graph" | "layers" | "settings" OR closed object |
Required. Icon from the catalog admitted for this presentation variant. |
homePresentation.launchers.icons[].icon.[variant 2].catalog |
Managed by Surface; supplied by the Model tools. |
Required. Defines catalog for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.launchers.icons[].icon.[variant 2].revision |
"0.468.0" |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.launchers.icons[].icon.[variant 2].name |
string; min length 1; max length 120; semantic validation |
Required. Readable name of the element in its presentation context. |
homePresentation.blocks |
Array<closed object OR closed object>; max length 20 |
Required. Defines blocks for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.blocks[].[kind=section].kind |
"section" |
Required. Selects the variant and the properties admitted in this branch. |
homePresentation.blocks[].[kind=section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
homePresentation.blocks[].[kind=section].variant |
"collection" | "work-resume" |
Required. Defines variant for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.blocks[].[kind=section].placement |
"main" | "aside" |
Required. Defines placement for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.blocks[].[kind=section].maximumVisible |
integer; ≥ 1; ≤ 24 |
Required. Maximum number of items in the bounded preview; the full collection remains accessible separately. |
homePresentation.blocks[].[kind=section].viewAll |
closed object; null |
Required. Defines view All for this object. Observe the type, variants and bounds in the Options column. |
homePresentation.blocks[].[kind=section].viewAll.destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
homePresentation.blocks[].[kind=section].viewAll.label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
homePresentation.blocks[].[kind=activity].kind |
"activity" |
Required. Selects the variant and the properties admitted in this branch. |
homePresentation.blocks[].[kind=activity].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
homePresentation.blocks[].[kind=activity].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
homePresentation.blocks[].[kind=activity].spaceKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 20 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
homePresentation.blocks[].[kind=activity].maximumVisible |
integer; ≥ 1; ≤ 50 |
Required. Maximum number of items in the bounded preview; the full collection remains accessible separately. |
homePresentation.blocks[].[kind=activity].placement |
"main" | "aside" |
Required. Defines placement for this object. Observe the type, variants and bounds in the Options column. |
contentActions |
Array<closed object>; max length 4000; optional |
Optional. Defines content Actions for this object. Observe the type, variants and bounds in the Options column. |
contentActions[].contract |
"ContentSpaceActionPolicy@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
contentActions[].spaceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contentActions[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
contentActions[].minimumRole |
"owner" | "editor" |
Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |
graphPresentations |
Array<closed object>; max length 100 |
Required. Defines graph Presentations for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
graphPresentations[].presentation |
closed object; semantic validation |
Required. Defines presentation for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.contract |
"WorkspaceGraphPresentation@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
graphPresentations[].presentation.initialProfileKey |
string; min length 1; max length 120 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
graphPresentations[].presentation.profiles |
Array<closed object>; min length 1; max length 20 |
Required. Defines profiles for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
graphPresentations[].presentation.profiles[].label |
string; min length 1; max length 200 |
Required. Human-readable label displayed in the interface. |
graphPresentations[].presentation.profiles[].edgeRouting |
Managed by Surface; supplied by the Model tools. |
Required. Defines edge Routing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout |
closed object OR closed object OR closed object OR closed object OR closed object OR closed object OR closed object |
Required. Arrangement algorithm or structure configured by variant properties. |
graphPresentations[].presentation.profiles[].layout.[algorithm=box].algorithm |
"box" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=box].nodeSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=box].aspectRatio |
number; ≥ 0.1; ≤ 10 |
Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=disco].algorithm |
"disco" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=disco].componentSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines component Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=disco].aspectRatio |
number; ≥ 0.1; ≤ 10 |
Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=disco].componentLayout |
"force" | "stress" | "layered" |
Required. Defines component Layout for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=force].algorithm |
"force" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=force].nodeSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=force].aspectRatio |
number; ≥ 0.1; ≤ 10 |
Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=force].seed |
integer; ≥ 1; ≤ 2147483647 |
Required. Provisions initial content rather than only declaring an instance type. |
graphPresentations[].presentation.profiles[].layout.[algorithm=layered].algorithm |
"layered" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=layered].nodeSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=layered].componentSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines component Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=layered].layerSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines layer Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=layered].direction |
"UP" | "DOWN" | "LEFT" | "RIGHT" |
Required. Traversal or presentation direction using this contract’s closed values. |
graphPresentations[].presentation.profiles[].layout.[algorithm=layered].seed |
integer; ≥ 1; ≤ 2147483647 |
Required. Provisions initial content rather than only declaring an instance type. |
graphPresentations[].presentation.profiles[].layout.[algorithm=mrtree].algorithm |
"mrtree" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=mrtree].nodeSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=mrtree].direction |
"UP" | "DOWN" | "LEFT" | "RIGHT" |
Required. Traversal or presentation direction using this contract’s closed values. |
graphPresentations[].presentation.profiles[].layout.[algorithm=mrtree].aspectRatio |
number; ≥ 0.1; ≤ 10 |
Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=random].algorithm |
"random" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=random].nodeSpacing |
number; ≥ 1; ≤ 1000 |
Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=random].aspectRatio |
number; ≥ 0.1; ≤ 10 |
Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=random].seed |
integer; ≥ 1; ≤ 2147483647 |
Required. Provisions initial content rather than only declaring an instance type. |
graphPresentations[].presentation.profiles[].layout.[algorithm=stress].algorithm |
"stress" |
Required. Graph layout algorithm; its parameters depend on this value. |
graphPresentations[].presentation.profiles[].layout.[algorithm=stress].desiredEdgeLength |
number; ≥ 1; ≤ 1000 |
Required. Defines desired Edge Length for this object. Observe the type, variants and bounds in the Options column. |
graphPresentations[].presentation.profiles[].layout.[algorithm=stress].iterationLimit |
integer; ≥ 1; ≤ 1000 |
Required. Defines iteration Limit for this object. Observe the type, variants and bounds in the Options column. |
uiComposition |
closed object |
Required. Defines ui Composition for this object. Observe the type, variants and bounds in the Options column. |
uiComposition.contract |
"WorkspaceCompositionPresentation@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
uiComposition.catalogue |
Surface-admitted value; canonical semantic validation |
Required. Defines catalogue for this object. Observe the type, variants and bounds in the Options column. |
uiComposition.screens |
Array<closed object OR closed object OR closed object OR closed object>; min length 1; max length 241 |
Required. Defines screens for this object. Observe the type, variants and bounds in the Options column. |
uiComposition.screens[].[kind=home].kind |
"home" |
Required. Selects the variant and the properties admitted in this branch. |
uiComposition.screens[].[kind=home].composition |
Surface-admitted value; canonical semantic validation |
Required. Declarative organization of components, sources or Spaces for the selected variant. |
uiComposition.screens[].[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
uiComposition.screens[].[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
uiComposition.screens[].[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
uiComposition.screens[].[kind=collection].composition |
Surface-admitted value; canonical semantic validation |
Required. Declarative organization of components, sources or Spaces for the selected variant. |
uiComposition.screens[].[kind=record].kind |
"record" |
Required. Selects the variant and the properties admitted in this branch. |
uiComposition.screens[].[kind=record].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
uiComposition.screens[].[kind=record].composition |
Surface-admitted value; canonical semantic validation |
Required. Declarative organization of components, sources or Spaces for the selected variant. |
uiComposition.screens[].[kind=work].kind |
"work" |
Required. Selects the variant and the properties admitted in this branch. |
uiComposition.screens[].[kind=work].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
uiComposition.screens[].[kind=work].composition |
Surface-admitted value; canonical semantic validation |
Required. Declarative organization of components, sources or Spaces for the selected variant. |
navigationMetrics |
closed object |
Required. Defines navigation Metrics for this object. Observe the type, variants and bounds in the Options column. |
navigationMetrics.contract |
"WorkspaceNavigationMetrics@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
navigationMetrics.items |
Array<closed object>; max length 40 |
Required. Defines items for this object. Observe the type, variants and bounds in the Options column. |
navigationMetrics.items[].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
navigationMetrics.items[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
navigationMetrics.items[].kind |
"query-total" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences |
Array<closed object>; max length 100 |
Required. Defines work Experiences for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].contract |
"SurfaceWorkExperience@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
workExperiences[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].workDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)+$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
workExperiences[].header |
closed object |
Required. Defines header for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.purpose |
closed object; null |
Required. Defines purpose for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.purpose.scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.purpose.source |
closed object OR closed object |
Required. Defines source for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.purpose.source.[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].header.purpose.source.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
workExperiences[].header.purpose.source.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].header.purpose.source.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
workExperiences[].header.purpose.valueLabels |
Array<closed object>; max length 100 |
Required. Mappings from stable values to user-facing labels. |
workExperiences[].header.purpose.valueLabels[].value |
string; max length 4000 OR number OR true | false |
Required. Effective value interpreted according to the enclosing type and discriminant. |
workExperiences[].header.purpose.valueLabels[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
workExperiences[].header.status |
closed object; null |
Required. Defines status for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.status.scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.status.source |
closed object OR closed object |
Required. Defines source for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.status.source.[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].header.status.source.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
workExperiences[].header.status.source.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].header.status.source.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
workExperiences[].header.status.valueLabels |
Array<closed object>; max length 100 |
Required. Mappings from stable values to user-facing labels. |
workExperiences[].header.status.valueLabels[].value |
string; max length 4000 OR number OR true | false |
Required. Effective value interpreted according to the enclosing type and discriminant. |
workExperiences[].header.status.valueLabels[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
workExperiences[].header.facts |
Array<closed object>; max length 20 |
Required. Defines facts for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.facts[].scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.facts[].source |
closed object OR closed object |
Required. Defines source for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.facts[].source.[kind=native].kind |
"native" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].header.facts[].source.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Required. Recognized native property name; this selector does not allow arbitrary access. |
workExperiences[].header.facts[].source.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].header.facts[].source.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Semantic Field selector, using the fields/ prefix. |
workExperiences[].header.facts[].valueLabels |
Array<closed object>; max length 100 |
Required. Mappings from stable values to user-facing labels. |
workExperiences[].header.facts[].valueLabels[].value |
string; max length 4000 OR number OR true | false |
Required. Effective value interpreted according to the enclosing type and discriminant. |
workExperiences[].header.facts[].valueLabels[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
workExperiences[].header.facts[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].header.facts[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
workExperiences[].header.criteria |
closed object; null |
Required. Defines criteria for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].header.criteria.sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].header.criteria.bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].stageDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)+$/u>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
workExperiences[].stageSource |
closed object OR closed object |
Required. Defines stage Source for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].stageSource.[kind=flow].kind |
"flow" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].stageSource.[kind=flow].blueprintKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].stageSource.[kind=query].kind |
"query" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].stageSource.[kind=query].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].retainedTargetQueryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].queryBindings |
Array<closed object>; min length 1; max length 100 |
Required. Bindings from named Queries to parameter values supplied by context. |
workExperiences[].queryBindings[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].queryBindings[].scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].queryBindings[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
workExperiences[].queryBindings[].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
workExperiences[].queryBindings[].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].queryBindings[].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
workExperiences[].queryBindings[].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].queryBindings[].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].queryBindings[].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
workExperiences[].queryBindings[].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
workExperiences[].queryBindings[].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].queryBindings[].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
workExperiences[].bindings |
Array<closed object OR closed object OR closed object OR closed object OR closed object OR closed object OR closed object>; min length 1; max length 100 |
Required. Defines bindings for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=query-view].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=query-view].kind |
"query-view" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=query-view].scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=query-view].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].bindings[].[kind=query-view].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].bindings[].[kind=native-document].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=native-document].kind |
"native-document" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=native-document].scope |
"retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=sources].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=sources].kind |
"sources" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=sources].scope |
"retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=sources].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].bindings[].[kind=flow-inspection].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=flow-inspection].kind |
"flow-inspection" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=flow-inspection].scope |
"rootWork" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=consolidation].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=consolidation].kind |
"consolidation" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=consolidation].scope |
"selectedStage" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=consolidation].profileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].bindings[].[kind=action].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=action].kind |
"action" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=action].scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=action].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
workExperiences[].bindings[].[kind=criteria].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].bindings[].[kind=criteria].kind |
"criteria" |
Required. Selects the variant and the properties admitted in this branch. |
workExperiences[].bindings[].[kind=criteria].scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].bindings[].[kind=criteria].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].bindings[].[kind=criteria].lifecycleKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].bindings[].[kind=criteria].stateValue |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Defines state Value for this object. Observe the type, variants and bounds in the Options column. |
workExperiences[].sections |
Array<closed object>; min length 1; max length 20 |
Required. Declared sections in reading or rendering order. |
workExperiences[].sections[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
workExperiences[].sections[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
workExperiences[].sections[].bindingKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 100 |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
workExperiences[].defaultSectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contract |
"WorkspaceModelFoundation@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
exactData |
closed object |
Required. Defines exact Data for this object. Observe the type, variants and bounds in the Options column. |
exactData.contract |
"WorkspaceExactData@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
exactData.units |
Array<closed object>; max length 100 |
Required. Defines units for this object. Observe the type, variants and bounds in the Options column. |
exactData.units[].kind |
"unit" | "currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.units[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.units[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
exactData.unitOperations |
Array<closed object>; max length 200 |
Required. Defines unit Operations for this object. Observe the type, variants and bounds in the Options column. |
exactData.unitOperations[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.unitOperations[].version |
string; min length 1; max length 120 |
Required. Declared content or publication version identifying the applicable interpretation. |
exactData.unitOperations[].operator |
"multiply" | "divide" |
Required. Variant comparison or operation; its value must match the expected type. |
exactData.unitOperations[].left |
closed object OR closed object OR closed object |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
exactData.unitOperations[].left.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].left.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].left.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.unitOperations[].left.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].left.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.unitOperations[].right |
closed object OR closed object OR closed object |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
exactData.unitOperations[].right.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].right.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].right.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.unitOperations[].right.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].right.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.unitOperations[].result |
closed object OR closed object OR closed object |
Required. Defines result for this object. Observe the type, variants and bounds in the Options column. |
exactData.unitOperations[].result.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].result.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].result.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.unitOperations[].result.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.unitOperations[].result.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions |
Array<closed object>; max length 200 |
Required. Defines conversions for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].version |
string; min length 1; max length 120 |
Required. Declared content or publication version identifying the applicable interpretation. |
exactData.conversions[].from |
closed object OR closed object OR closed object |
Required. Starting state or source for the transition or relation. |
exactData.conversions[].from.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].from.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].from.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].from.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].from.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].to |
closed object OR closed object OR closed object |
Required. Target state or destination for the transition or relation. |
exactData.conversions[].to.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].to.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].to.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].to.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].to.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].factor |
closed object OR closed object |
Required. Defines factor for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].factor.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].factor.[kind=literal].format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.conversions[].factor.[kind=literal].format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].factor.[kind=literal].format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].factor.[kind=literal].value |
string; max length 1003 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
exactData.conversions[].factor.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].factor.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].factor.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.conversions[].factor.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
exactData.conversions[].output |
closed object |
Required. Defines output for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].output.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.conversions[].output.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].output.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].output.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.conversions[].output.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].output.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].output.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].output.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.conversions[].output.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.conversions[].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations |
Array<closed object>; max length 200 |
Required. Defines calculations for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Required. Defines definition Paths for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression |
recursive reference |
Required. Declarative condition tree whose references and budgets are validated before evaluation. |
exactData.calculations[].expression.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=literal].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=literal].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=literal].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=literal].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=literal].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=literal].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=literal].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=literal].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=literal].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=literal].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=literal].value |
string; max length 1003 |
Required. Effective value interpreted according to the enclosing type and discriminant. |
exactData.calculations[].expression.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=field].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=field].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=field].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=field].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=field].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=field].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=field].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=field].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=field].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=field].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.calculations[].expression.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
exactData.calculations[].expression.[kind=calculation].kind |
"calculation" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=calculation].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=calculation].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=calculation].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=calculation].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=calculation].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=calculation].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=calculation].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=calculation].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=calculation].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=calculation].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=calculation].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=arithmetic].kind |
"arithmetic" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=arithmetic].operator |
"add" | "subtract" | "multiply" | "divide" |
Required. Variant comparison or operation; its value must match the expected type. |
exactData.calculations[].expression.[kind=arithmetic].left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].left ↻ |
recursive reference to parent expression |
Optional. Defines left ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].right ↻ |
recursive reference to parent expression |
Optional. Defines right ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=arithmetic].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=arithmetic].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=arithmetic].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=arithmetic].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=arithmetic].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=arithmetic].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].unitOperation |
closed object; null |
Required. Defines unit Operation for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=arithmetic].unitOperation.key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=arithmetic].unitOperation.version |
string; min length 1; max length 120 |
Required. Declared content or publication version identifying the applicable interpretation. |
exactData.calculations[].expression.[kind=round].kind |
"round" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=round].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
exactData.calculations[].expression.[kind=round].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=round].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=round].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=round].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=round].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=round].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=round].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=round].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=round].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=round].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=round].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=round].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling" |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].kind |
"conditional" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conditional].condition |
closed object |
Required. Defines condition for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].condition.kind |
"compare" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conditional].condition.operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" |
Required. Variant comparison or operation; its value must match the expected type. |
exactData.calculations[].expression.[kind=conditional].condition.left |
recursive reference |
Required. Defines left for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].condition.left ↻ |
recursive reference to parent expression |
Optional. Defines left ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].condition.right |
recursive reference |
Required. Defines right for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].condition.right ↻ |
recursive reference to parent expression |
Optional. Defines right ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].whenTrue |
recursive reference |
Required. Defines when True for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].whenTrue ↻ |
recursive reference to parent expression |
Optional. Defines when True ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].whenFalse |
recursive reference |
Required. Defines when False for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].whenFalse ↻ |
recursive reference to parent expression |
Optional. Defines when False ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=conditional].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conditional].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conditional].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conditional].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=conditional].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conditional].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=conversion].kind |
"conversion" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conversion].conversionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
exactData.calculations[].expression.[kind=conversion].conversionVersion |
string; min length 1; max length 120 |
Required. Defines conversion Version for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conversion].operand |
recursive reference |
Required. Child expression evaluated by the current operator. |
exactData.calculations[].expression.[kind=conversion].operand ↻ |
recursive reference to parent expression |
Optional. Defines operand ↻ for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conversion].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conversion].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=conversion].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conversion].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conversion].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=conversion].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conversion].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conversion].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=conversion].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=conversion].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=query-total].kind |
"query-total" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
exactData.calculations[].expression.[kind=query-total].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
exactData.calculations[].expression.[kind=query-total].operator |
"count" | "count-distinct" |
Required. Variant comparison or operation; its value must match the expected type. |
exactData.calculations[].expression.[kind=query-total].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=query-total].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=query-total].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=query-total].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=query-total].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=query-total].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=query-total].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=query-total].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=aggregate].kind |
"aggregate" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Query; scope and authorization remain enforced by the data engine. |
exactData.calculations[].expression.[kind=aggregate].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Required. Named operation or Query parameters and their associated values. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=field].kind |
"field" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=field].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=field].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=literal].kind |
"literal" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Required. Effective value interpreted according to the enclosing type and discriminant. |
exactData.calculations[].expression.[kind=aggregate].field |
closed object |
Required. Defines field for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=aggregate].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Required. Exact path of a definition in the Model; this is not a record instance ID. |
exactData.calculations[].expression.[kind=aggregate].field.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Required. Key of a Field declared on the referenced Surface definition. |
exactData.calculations[].expression.[kind=aggregate].operator |
"sum" | "min" | "max" | "average" |
Required. Variant comparison or operation; its value must match the expected type. |
exactData.calculations[].expression.[kind=aggregate].type |
closed object |
Required. Defines type for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=aggregate].type.format |
closed object; semantic validation |
Required. Presentation format compatible with the value type. |
exactData.calculations[].expression.[kind=aggregate].type.format.precision |
integer; ≥ 1; ≤ 1000 |
Required. Defines precision for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=aggregate].type.format.scale |
integer; ≥ 0; ≤ 1000 |
Required. Defines scale for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=aggregate].type.unit |
closed object OR closed object OR closed object |
Required. Defines unit for this object. Observe the type, variants and bounds in the Options column. |
exactData.calculations[].expression.[kind=aggregate].type.unit.[kind=dimensionless].kind |
"dimensionless" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].type.unit.[kind=unit].kind |
"unit" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].type.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=aggregate].type.unit.[kind=currency].kind |
"currency" |
Required. Selects the variant and the properties admitted in this branch. |
exactData.calculations[].expression.[kind=aggregate].type.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
exactData.calculations[].expression.[kind=aggregate].rounding |
"half-even" | "half-up" | "toward-zero" | "away-from-zero" | "floor" | "ceiling"; null |
Required. Defines rounding for this object. Observe the type, variants and bounds in the Options column. |
knowledgeCurationProfiles |
Array<closed object; semantic validation>; max length 100; optional |
Optional. Defines knowledge Curation Profiles for this object. Observe the type, variants and bounds in the Options column. |
knowledgeCurationProfiles[].contract |
"KnowledgeCurationReviewProfile@1" |
Required. Exact discriminant of this contract variant. Match the literal value shown. |
knowledgeCurationProfiles[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
knowledgeCurationProfiles[].workspaceDefinitionPath |
string; min length 1; max length 1000 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
knowledgeCurationProfiles[].entryDefinitionPaths |
Array<string; min length 1; max length 1000>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
knowledgeCurationProfiles[].categoryDefinitionPaths |
Array<string; min length 1; max length 1000>; min length 1; max length 100 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
knowledgeCurationProfiles[].indexDefinitionPath |
string; min length 1; max length 1000 |
Required. Exact path of the relevant definition type; each reference must exist in the Model and respect declared scope. |
knowledgeCurationProfiles[].bindings |
Array<closed object OR closed object>; min length 1; max length 10 |
Required. Defines bindings for this object. Observe the type, variants and bounds in the Options column. |
knowledgeCurationProfiles[].bindings[].[variant 1].kind |
"duplicate_semantic" | "link_related" | "move_entry" | "create_category" | "add_alias" | "refresh_index_summary" | "flag_stale" | "flag_conflict" | "flag_orphan" |
Required. Selects the variant and the properties admitted in this branch. |
knowledgeCurationProfiles[].bindings[].[variant 1].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
knowledgeCurationProfiles[].bindings[].[kind=merge_entries].kind |
"merge_entries" |
Required. Selects the variant and the properties admitted in this branch. |
knowledgeCurationProfiles[].bindings[].[kind=merge_entries].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
knowledgeCurationProfiles[].bindings[].[kind=merge_entries].provenanceControlKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
knowledgeCurationProfiles[].bindings[].[kind=merge_entries].sourceArchivePolicyKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Reading the contract
A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.
An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.
Surface manages this structure’s implementation parameters. Use Model tools to produce them; they are not values to enter in a record.
Related references
Complete Model index · Build a Model
Applied examples : Assemble a coherent definition
The Form and record profile reference the same company, status and notes Fields.
Configuration
Fragment placed in forms[]. Properties and accepted values.
{
"contract": "WorkspaceForm@2",
"key": "new-client",
"label": "New client",
"actionKey": "create-client",
"targetDefinitionPath": "workspace/clients/surface/client",
"mode": "create",
"fields": [
{
"contract": "WorkspaceFormControl@2",
"repeatable": false,
"key": "company",
"label": "Company",
"input": "text",
"binding": {
"kind": "field",
"fieldKey": "company"
},
"required": true,
"ruleKeys": [],
"options": []
},
{
"contract": "WorkspaceFormControl@2",
"repeatable": false,
"key": "status",
"label": "Status",
"input": "choice",
"binding": {
"kind": "field",
"fieldKey": "status"
},
"required": true,
"ruleKeys": [],
"options": [
"prospect",
"active"
]
}
],
"ruleKeys": []
}
Variation and connection
Fragment placed in presentation.recordProfiles[]. Properties and accepted values.
{
"key": "client",
"definitionPaths": [
"workspace/clients/surface/client"
],
"editActionKey": "edit-client",
"identity": {
"title": {
"kind": "field",
"fieldPath": "fields/company"
},
"avatar": {
"kind": "initials",
"maximumLetters": 2
},
"subtitle": {
"kind": "field",
"fieldPath": "fields/status"
}
},
"valueLabels": [
{
"fieldPath": "fields/status",
"values": [
{
"value": "prospect",
"label": "Prospect"
},
{
"value": "active",
"label": "Active"
}
]
}
],
"card": {
"summary": {
"kind": "field",
"fieldPath": "fields/notes"
},
"tags": {
"namespace": "user",
"maximumVisible": 3
},
"metricKeys": [],
"openLabel": "Open client"
},
"queryBindings": [],
"metrics": [],
"detail": {
"primaryActionKey": null,
"creationActionKeys": [],
"actionKeys": [],
"sections": [
{
"kind": "fields",
"key": "follow-up",
"label": "Client follow-up",
"fieldPaths": [
"fields/notes",
"fields/status"
]
}
],
"settings": {
"fieldPaths": [
"fields/email"
]
},
"tags": {
"namespace": "user",
"maximumVisible": 3
},
"relatedGroups": [],
"primaryActionLabel": null
}
}
UI layout example
The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.
- Clients · Data
- References · Knowledge
- Preparation · Work
- Quotes · Product
key- new-client
label- New client
actionKey- create-client
targetDefinitionPath- workspace/clients/surface/client
mode- create
Values above follow the configuration fragment; references resolve in the complete Model.