Template Reference
ASL · Application Specification Language
Check your template
Find likely variable, type, and field-name mistakes before generating a document.
Generic context
These variables are available for every templatable DSL.
| Variable | Contents |
|---|---|
root | The parsed entry object (Model). |
elements | All named elements across grammar types. |
by_type | Named elements grouped by their exact grammar type. |
by_id | Lookup from an element name to its element. |
schema_version | Template-context schema version, currently 1.0. |
Uniform element aliases
Every named element keeps its raw fields and gains these aliases.
| Alias | Meaning |
|---|---|
id | The raw name value. |
title | The configured friendly title, falling back to name. |
kind | The exact Langium AST type. |
Template Profile aliases
Friendly names are resolved at render time and do not alter the grammar inventory.
This DSL does not define additional friendly aliases.
Named types
These exact names are valid keys in by_type.
ActionTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ActionTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ActiveEventTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ActiveEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ActiveFlowTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ActiveFlowTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ActiveTaskTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ActiveTaskTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Actor Link
Extends ProtectedResource
| Field | Shape |
|---|---|
descriptions |
string list optional |
name |
string |
nameAlias |
string optional |
representedStakeholders |
reference → Stakeholder list optional |
responsibilities |
string list optional |
superActors |
reference → Actor list optional |
tags |
contained → Tag list optional |
type |
contained → ActorType |
{% for item in by_type["Actor"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ActorRelation Link
| Field | Shape |
|---|---|
descriptions |
string list optional |
name |
string |
nameAlias |
string optional |
source |
reference → Actor |
tags |
contained → Tag list optional |
target |
reference → Actor |
type |
contained → ActorRelationType |
{% for item in by_type["ActorRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ActorRelationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ActorRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ActorTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ActorTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIAgent Link
Extends ProtectedResource
| Field | Shape |
|---|---|
approvals |
contained → ApprovalCheckpoint list optional |
confidence |
contained → Percentage list optional |
context |
contained → ContextPolicy list optional |
description |
string list optional |
escalatesTo |
reference → AIAgent list optional |
guardrails |
reference → AIGuardrail list optional |
instructions |
string list optional |
knowledge |
reference → AIKnowledgeBase list optional |
memory |
contained → MemoryPolicy list optional |
models |
reference → AIModel list optional |
name |
string |
nameAlias |
string optional |
objectives |
string list optional |
responsibilities |
string list optional |
role |
string list optional |
tags |
contained → Tag list optional |
tools |
reference → AIAgentTool list optional |
type |
contained → AIAgentType |
{% for item in by_type["AIAgent"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIAgentTool Link
Extends ProtectedResource
| Field | Shape |
|---|---|
approvalRequired |
contained → Boolean list optional |
authorization |
reference → SecAccessPolicy list optional |
dataScopes |
reference → DataEntityGeneric list optional |
description |
string list optional |
input |
reference → DataEntityGeneric list optional |
name |
string |
nameAlias |
string optional |
operation |
reference → AppOperation list optional |
output |
reference → DataEntityGeneric list optional |
retry |
contained → RetryPolicy list optional |
sideEffect |
string list optional |
tags |
contained → Tag list optional |
type |
contained → AIAgentToolType |
{% for item in by_type["AIAgentTool"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIAgentToolTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIAgentToolTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIAgentTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIAgentTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AICapability Link
Extends Invocable
| Field | Shape |
|---|---|
agents |
reference → AIAgent list optional |
authorizations |
reference → SecAccessPolicy list optional |
descriptions |
string list optional |
guardrails |
reference → AIGuardrail list optional |
inputs |
reference → DataResource list optional |
kind |
string |
name |
string |
nameAlias |
string optional |
orchestrations |
reference → AIOrchestration list optional |
outputs |
reference → DataResource list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AICapability"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIEvaluationScenario Link
Extends ProtectedResource
| Field | Shape |
|---|---|
agents |
reference → AIAgent list optional |
auditRequired |
contained → Boolean list optional |
capabilities |
reference → AICapability list optional |
criteria |
contained → EvaluationCriterion list optional |
datasets |
reference → Dataset list optional |
description |
string list optional |
name |
string |
nameAlias |
string optional |
orchestrations |
reference → AIOrchestration list optional |
requirements |
reference → RequirementTarget list optional |
safetyTests |
string list optional |
tags |
contained → Tag list optional |
type |
contained → AIEvaluationScenarioType |
{% for item in by_type["AIEvaluationScenario"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIEvaluationScenarioTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIEvaluationScenarioTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIGuardrail Link
Extends ProtectedResource
| Field | Shape |
|---|---|
approval |
contained → Boolean list optional |
dataRestrictions |
reference → DataEntityGeneric list optional |
description |
string list optional |
kind |
contained → AIGuardrailType |
name |
string |
nameAlias |
string optional |
prohibitedActions |
string list optional |
requirements |
reference → RequirementTarget list optional |
rules |
contained → LogicExpression list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AIGuardrail"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIGuardrailTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIGuardrailTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIKnowledgeBase Link
Extends ProtectedResource
| Field | Shape |
|---|---|
citationsRequired |
contained → Boolean list optional |
description |
string list optional |
embeddingModel |
reference → AIModel list optional |
filters |
contained → LogicExpression list optional |
freshness |
contained → Duration list optional |
indexes |
string list optional |
name |
string |
nameAlias |
string optional |
sources |
reference → DataResource list optional |
tags |
contained → Tag list optional |
topK |
number list optional |
type |
contained → AIKnowledgeBaseType |
{% for item in by_type["AIKnowledgeBase"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIKnowledgeBaseTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIKnowledgeBaseTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIModel Link
Extends ProtectedResource
| Field | Shape |
|---|---|
capabilities |
string list optional |
description |
string list optional |
fallback |
reference → AIModel list optional |
modelId |
string list optional |
name |
string |
nameAlias |
string optional |
provider |
string list optional |
secret |
reference → SecSecret list optional |
structuredOutput |
reference → DataEntityGeneric list optional |
tags |
contained → Tag list optional |
temperature |
number list optional |
type |
contained → AIModelType |
{% for item in by_type["AIModel"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIModelTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIModelTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIOrchestration Link
Extends Invocable
| Field | Shape |
|---|---|
descriptions |
string list optional |
name |
string |
nameAlias |
string optional |
starts |
reference → AIOrchestrationStep list optional |
steps |
contained → AIOrchestrationStep list optional |
tags |
contained → Tag list optional |
terminations |
contained → LogicExpression list optional |
transitions |
contained → AITransition list optional |
type |
contained → AIOrchestrationType |
{% for item in by_type["AIOrchestration"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIOrchestrationStep Link
| Field | Shape |
|---|---|
agents |
reference → AIAgent list optional |
conditions |
contained → LogicExpression list optional |
descriptions |
string list optional |
failureActions |
string list optional one of: Continue | Escalate | Retry | Stop |
kind |
string one of: Delegate | Handoff | HumanApproval | Invoke | Route |
name |
string |
targetAgents |
reference → AIAgent list optional |
{% for item in by_type["AIOrchestrationStep"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIOrchestrationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AIOrchestrationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AIRuntime Link
Extends Deployable
| Field | Shape |
|---|---|
agents |
reference → AIAgent list optional |
descriptions |
string list optional |
kind |
string |
models |
reference → AIModel list optional |
name |
string |
nameAlias |
string optional |
observability |
reference → OpsObservability list optional |
orchestrations |
reference → AIOrchestration list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AIRuntime"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AITransition Link
| Field | Shape |
|---|---|
conditions |
contained → LogicExpression list optional |
descriptions |
string list optional |
name |
string |
priorities |
number list optional |
source |
reference → AIOrchestrationStep |
target |
reference → AIOrchestrationStep |
{% for item in by_type["AITransition"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppChannel Link
Extends ProtectedResource
| Field | Shape |
|---|---|
deadLetter |
reference → AppChannel list optional |
description |
string list optional |
kind |
contained → AppChannelType |
messages |
reference → AppEvent list optional |
name |
string |
nameAlias |
string optional |
retention |
contained → Duration list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AppChannel"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppChannelTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppChannelTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppComponent Link
Extends Deployable
| Field | Shape |
|---|---|
configurations |
contained → AppConfigProperty list optional |
dependencies |
reference → AppComponent list optional |
description |
string list optional |
kind |
contained → AppComponentType |
name |
string |
nameAlias |
string optional |
services |
reference → AppService list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AppComponent"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppComponentTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppComponentTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppConfigProperty Link
| Field | Shape |
|---|---|
defaultValue |
contained → TypedLiteral list optional |
description |
string list optional |
name |
string |
required |
contained → Boolean list optional |
type |
contained → DataAttributeType |
{% for item in by_type["AppConfigProperty"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppEndpoint Link
Extends ProtectedResource
| Field | Shape |
|---|---|
authentication |
reference → SecAuthenticationScheme list optional |
description |
string list optional |
method |
contained → AppEndpointType |
name |
string |
nameAlias |
string optional |
operation |
reference → AppOperation list optional |
pagination |
contained → PaginationPolicy list optional |
parameters |
contained → Parameter list optional |
path |
string |
request |
contained → DataTypeReference list optional |
responses |
contained → ApiResponse list optional |
tags |
contained → Tag list optional |
version |
string list optional |
{% for item in by_type["AppEndpoint"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppEndpointTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppEndpointTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppEvent Link
Extends ProtectedResource
| Field | Shape |
|---|---|
delivery |
string list optional |
description |
string list optional |
name |
string |
nameAlias |
string optional |
publishers |
reference → AppService list optional |
retry |
contained → RetryPolicy list optional |
schema |
reference → DataEntityGeneric list optional |
subscribers |
reference → AppService list optional |
tags |
contained → Tag list optional |
type |
contained → AppEventType |
{% for item in by_type["AppEvent"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppEventTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppFeature Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
realizes |
reference → RequirementTarget list optional |
{% for item in by_type["AppFeature"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppIntegration Link
Extends ProtectedResource
| Field | Shape |
|---|---|
adapters |
string list optional |
credential |
reference → SecSecret list optional |
description |
string list optional |
direction |
contained → AppIntegrationType |
endpoints |
string list optional |
externalSystem |
string list optional |
mappings |
contained → DataMapping list optional |
name |
string |
nameAlias |
string optional |
protocol |
string list optional |
retry |
contained → RetryPolicy list optional |
synchronization |
string list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AppIntegration"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppIntegrationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppIntegrationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppJob Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
kind |
contained → AppJobType |
name |
string |
nameAlias |
string optional |
operation |
reference → AppOperation list optional |
retry |
contained → RetryPolicy list optional |
schedule |
string list optional |
tags |
contained → Tag list optional |
timeout |
contained → Duration list optional |
{% for item in by_type["AppJob"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppJobTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppJobTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppModule Link
Extends ProtectedResource
| Field | Shape |
|---|---|
components |
reference → AppComponent list optional |
dependencies |
reference → AppModule list optional |
description |
string list optional |
features |
contained → AppFeature list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → AppModuleType |
visibility |
string list optional |
{% for item in by_type["AppModule"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppModuleTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppModuleTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppNotification Link
Extends ProtectedResource
| Field | Shape |
|---|---|
channel |
contained → AppNotificationType |
description |
string list optional |
escalation |
contained → Duration list optional |
name |
string |
nameAlias |
string optional |
recipient |
contained → LogicExpression list optional |
tags |
contained → Tag list optional |
template |
string list optional |
triggers |
reference → AppEvent list optional |
{% for item in by_type["AppNotification"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppNotificationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppNotificationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppOperation Link
Extends Invocable
| Field | Shape |
|---|---|
authorization |
reference → SecAccessPolicy list optional |
description |
string list optional |
errors |
contained → OperationError list optional |
idempotent |
contained → Boolean list optional |
kind |
contained → AppOperationType |
name |
string |
nameAlias |
string optional |
parameters |
contained → Parameter list optional |
postconditions |
contained → LogicExpression list optional |
preconditions |
contained → LogicExpression list optional |
retry |
contained → RetryPolicy list optional |
returns |
contained → DataTypeReference list optional |
tags |
contained → Tag list optional |
timeout |
contained → Duration list optional |
transaction |
string list optional |
{% for item in by_type["AppOperation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppOperationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppOperationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ApprovalCheckpoint Link
| Field | Shape |
|---|---|
name |
string |
operation |
reference → AppOperation |
role |
reference → SecRole optional |
{% for item in by_type["ApprovalCheckpoint"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppRule Link
Extends ProtectedResource
| Field | Shape |
|---|---|
actions |
contained → ActionSequence list optional |
appliesTo |
reference → ProtectedResource list optional |
conditions |
contained → LogicExpression list optional |
description |
string list optional |
kind |
contained → AppRuleType |
name |
string |
nameAlias |
string optional |
priority |
contained → PriorityType list optional |
tags |
contained → Tag list optional |
{% for item in by_type["AppRule"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppRuleTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppRuleTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppService Link
Extends ProtectedResource
| Field | Shape |
|---|---|
authorization |
reference → SecAccessPolicy list optional |
description |
string list optional |
interfaceName |
string list optional |
kind |
contained → AppServiceType |
name |
string |
nameAlias |
string optional |
operations |
contained → Invocable list optional |
requirements |
reference → RequirementTarget list optional |
tags |
contained → Tag list optional |
transaction |
string list optional |
{% for item in by_type["AppService"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
AppServiceTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["AppServiceTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ASLNamedElement Link
| Field | Shape |
|---|---|
name |
string |
nameAlias |
string optional |
{% for item in by_type["ASLNamedElement"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Check Link
| Field | Shape |
|---|---|
checkExpression |
string |
name |
string |
{% for item in by_type["Check"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ConstraintRequirement Link
Extends RequirementTarget
| Field | Shape |
|---|---|
descriptions |
string list optional |
isAbstract |
string list optional |
isConcrete |
string list optional |
isNegative |
string list optional |
isPositive |
string list optional |
isProblem |
string list optional |
isSolution |
string list optional |
name |
string |
nameAlias |
string optional |
partOf |
contained → ConstraintRequirementPartOf list optional |
priorities |
contained → PriorityType list optional |
rationales |
string list optional |
sources |
string list optional |
stakeholders |
reference → Stakeholder list optional |
statements |
string list optional |
subType |
contained → ConstraintSubType optional |
tags |
contained → Tag list optional |
type |
contained → ConstraintType |
{% for item in by_type["ConstraintRequirement"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ConstraintSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ConstraintSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ConstraintTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ConstraintTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Data Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
table |
contained → DataTable optional |
tags |
contained → Tag list optional |
type |
reference → DataEntity |
{% for item in by_type["Data"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataAttribute Link
Extends DataSymbol
| Field | Shape |
|---|---|
constraint |
contained → DataAttributeConstraint list optional |
defaultValue |
contained → TypedLiteral list optional |
description |
string list optional |
formula |
contained → Formula list optional |
helpMessage |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → DataAttributeType |
values |
contained → TypedLiteral list optional |
visualization |
string list optional |
{% for item in by_type["DataAttribute"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataAttributeTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["DataAttributeTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEntity Link
Extends StructuredDataResource
| Field | Shape |
|---|---|
attributes |
contained → DataSymbol list optional |
constraint |
contained → DataEntityConstraint list optional |
description |
string list optional |
name |
string |
nameAlias |
string optional |
subType |
contained → DataEntitySubType optional |
super |
reference → DataEntity list optional |
tags |
contained → Tag list optional |
type |
contained → DataEntityType |
{% for item in by_type["DataEntity"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEntityCluster Link
Extends ProtectedResource
| Field | Shape |
|---|---|
children |
contained → ChildDataEntity list optional |
description |
string list optional |
main |
reference → DataEntity list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → DataEntityClusterType |
uses |
contained → RefDataEntity list optional |
{% for item in by_type["DataEntityCluster"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEntityClusterTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["DataEntityClusterTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEntitySubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["DataEntitySubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEntityTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["DataEntityTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEnumeration Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
values |
contained → DataSymbol list |
{% for item in by_type["DataEnumeration"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataEnumerationElement Link
Extends DataSymbol
| Field | Shape |
|---|---|
name |
string |
nameAlias |
string optional |
{% for item in by_type["DataEnumerationElement"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataResource Link
Extends ProtectedResource
| Field | Shape |
|---|---|
classifications |
string list optional |
descriptions |
string list optional |
formats |
string list optional |
freshness |
contained → Duration list optional |
kind |
string |
licenses |
string list optional |
locations |
string list optional |
name |
string |
nameAlias |
string optional |
purpose |
string |
sources |
reference → DataSource list optional |
splits |
contained → DatasetSplit list optional |
tags |
contained → Tag list optional |
versions |
string list optional |
{% for item in by_type["DataResource"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Dataset Link
Extends DataResource
| Field | Shape |
|---|---|
classifications |
string list optional |
descriptions |
string list optional |
licenses |
string list optional |
name |
string |
nameAlias |
string optional |
purpose |
string |
sources |
reference → DataSource list optional |
splits |
contained → DatasetSplit list optional |
tags |
contained → Tag list optional |
versions |
string list optional |
{% for item in by_type["Dataset"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DatasetSplit Link
| Field | Shape |
|---|---|
name |
string |
percentage |
contained → Percentage |
{% for item in by_type["DatasetSplit"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataSource Link
Extends DataResource
| Field | Shape |
|---|---|
classifications |
string list optional |
descriptions |
string list optional |
formats |
string list optional |
freshness |
contained → Duration list optional |
kind |
string |
locations |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
{% for item in by_type["DataSource"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
DataSymbol Link
Extends ASLNamedElement
| Field | Shape |
|---|---|
constraint |
contained → DataAttributeConstraint list optional |
defaultValue |
contained → TypedLiteral list optional |
description |
string list optional |
formula |
contained → Formula list optional |
helpMessage |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → DataAttributeType |
values |
contained → TypedLiteral list optional |
visualization |
string list optional |
{% for item in by_type["DataSymbol"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Deployable Link
Extends ProtectedResource
| Field | Shape |
|---|---|
agents |
reference → AIAgent list optional |
configurations |
contained → AppConfigProperty list optional |
dependencies |
reference → AppComponent list optional |
description |
string list optional |
descriptions |
string list optional |
kind |
string one of: Container | Embedded | ManagedAPI | Other |
models |
reference → AIModel list optional |
name |
string |
nameAlias |
string optional |
observability |
reference → OpsObservability list optional |
orchestrations |
reference → AIOrchestration list optional |
services |
reference → AppService list optional |
tags |
contained → Tag list optional |
{% for item in by_type["Deployable"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
EvaluationCriterion Link
| Field | Shape |
|---|---|
metric |
string |
name |
string |
threshold |
number |
{% for item in by_type["EvaluationCriterion"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ExternalElementReference Link
Extends ProtectedResource
| Field | Shape |
|---|---|
descriptions |
string list optional |
externalIds |
string list optional |
kind |
string |
name |
string |
nameAlias |
string optional |
sources |
string list optional |
tags |
contained → Tag list optional |
uris |
string list optional |
versions |
string list optional |
{% for item in by_type["ExternalElementReference"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ForeignKeyOnDeleteTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["ForeignKeyOnDeleteTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
FRTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["FRTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
FunctionalRequirement Link
Extends RequirementTarget
| Field | Shape |
|---|---|
descriptions |
string list optional |
isAbstract |
string list optional |
isConcrete |
string list optional |
isNegative |
string list optional |
isPositive |
string list optional |
isProblem |
string list optional |
isSolution |
string list optional |
name |
string |
nameAlias |
string optional |
partOf |
contained → FunctionalRequirementPartOf list optional |
priorities |
contained → PriorityType list optional |
rationales |
string list optional |
stakeholders |
reference → Stakeholder list optional |
statements |
string list optional |
tags |
contained → Tag list optional |
type |
contained → FRType |
{% for item in by_type["FunctionalRequirement"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Invocable Link
Extends ProtectedResource
| Field | Shape |
|---|---|
agents |
reference → AIAgent list optional |
authorization |
reference → SecAccessPolicy list optional |
authorizations |
reference → SecAccessPolicy list optional |
description |
string list optional |
descriptions |
string list optional |
errors |
contained → OperationError list optional |
guardrails |
reference → AIGuardrail list optional |
idempotent |
contained → Boolean list optional |
inputs |
reference → DataResource list optional |
kind |
string one of: Classification | Conversation | DecisionSupport | Extraction | Generation | Other |
name |
string |
nameAlias |
string optional |
orchestrations |
reference → AIOrchestration list optional |
outputs |
reference → DataResource list optional |
parameters |
contained → Parameter list optional |
postconditions |
contained → LogicExpression list optional |
preconditions |
contained → LogicExpression list optional |
retry |
contained → RetryPolicy list optional |
returns |
contained → DataTypeReference list optional |
starts |
reference → AIOrchestrationStep list optional |
steps |
contained → AIOrchestrationStep list optional |
tags |
contained → Tag list optional |
terminations |
contained → LogicExpression list optional |
timeout |
contained → Duration list optional |
transaction |
string list optional |
transitions |
contained → AITransition list optional |
type |
contained → AIOrchestrationType |
{% for item in by_type["Invocable"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
MetricTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["MetricTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OperationError Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
status |
number optional |
{% for item in by_type["OperationError"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsAlert Link
| Field | Shape |
|---|---|
condition |
contained → LogicExpression |
description |
string list optional |
name |
string |
notifications |
reference → AppNotification list optional |
severity |
string list optional one of: Critical | Error | Info | Warning |
{% for item in by_type["OpsAlert"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsBackupPolicy Link
| Field | Shape |
|---|---|
description |
string list optional |
encrypted |
contained → Boolean list optional |
kind |
string one of: Full | Incremental | Snapshot |
name |
string |
retention |
reference → OpsRetentionPolicy list optional |
schedule |
string list optional |
{% for item in by_type["OpsBackupPolicy"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsDeployment Link
Extends ProtectedResource
| Field | Shape |
|---|---|
deployables |
reference → Deployable list optional |
description |
string list optional |
environments |
reference → OpsEnvironment list optional |
healthChecks |
contained → OpsHealthCheck list optional |
name |
string |
nameAlias |
string optional |
observability |
reference → OpsObservability list optional |
replicas |
number list optional |
requirements |
reference → RequirementTarget list optional |
runtime |
contained → OpsDeploymentType |
scaling |
contained → OpsScalingPolicy list optional |
tags |
contained → Tag list optional |
{% for item in by_type["OpsDeployment"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsDeploymentTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["OpsDeploymentTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsEnvironment Link
Extends ProtectedResource
| Field | Shape |
|---|---|
bindings |
contained → OpsConfigBinding list optional |
description |
string list optional |
kind |
contained → OpsEnvironmentType |
name |
string |
nameAlias |
string optional |
secrets |
reference → SecSecret list optional |
tags |
contained → Tag list optional |
{% for item in by_type["OpsEnvironment"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsEnvironmentTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["OpsEnvironmentTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsHealthCheck Link
| Field | Shape |
|---|---|
endpoint |
string list optional |
failureThreshold |
number list optional |
interval |
contained → Duration list optional |
kind |
string one of: Liveness | Readiness | Startup |
name |
string |
timeout |
contained → Duration list optional |
{% for item in by_type["OpsHealthCheck"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsIndex Link
| Field | Shape |
|---|---|
attributes |
reference → DataAttribute list |
name |
string |
unique |
boolean optional |
{% for item in by_type["OpsIndex"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsLogging Link
| Field | Shape |
|---|---|
destination |
string list optional |
format |
string list optional |
kind |
string one of: Application | Audit | Infrastructure | Security |
name |
string |
retention |
reference → OpsRetentionPolicy list optional |
{% for item in by_type["OpsLogging"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsMetric Link
| Field | Shape |
|---|---|
description |
string list optional |
kind |
string one of: Counter | Gauge | Histogram |
name |
string |
unit |
string list optional |
{% for item in by_type["OpsMetric"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsObservability Link
Extends ProtectedResource
| Field | Shape |
|---|---|
alerts |
contained → OpsAlert list optional |
backups |
contained → OpsBackupPolicy list optional |
description |
string list optional |
logging |
contained → OpsLogging list optional |
metrics |
contained → OpsMetric list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → OpsObservabilityType |
{% for item in by_type["OpsObservability"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsObservabilityTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["OpsObservabilityTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsRetentionPolicy Link
Extends ProtectedResource
| Field | Shape |
|---|---|
action |
string list optional |
description |
string list optional |
duration |
contained → Duration list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → OpsRetentionPolicyType |
{% for item in by_type["OpsRetentionPolicy"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsRetentionPolicyTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["OpsRetentionPolicyTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsScalingPolicy Link
| Field | Shape |
|---|---|
maximum |
number list optional |
metric |
string list optional |
minimum |
number list optional |
name |
string |
target |
number list optional |
{% for item in by_type["OpsScalingPolicy"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsStore Link
Extends ProtectedResource
| Field | Shape |
|---|---|
auditing |
contained → Boolean list optional |
description |
string list optional |
entities |
reference → DataEntityGeneric list optional |
indexes |
contained → OpsIndex list optional |
kind |
contained → OpsStoreType |
name |
string |
nameAlias |
string optional |
retention |
reference → OpsRetentionPolicy list optional |
softDeletion |
contained → Boolean list optional |
tags |
contained → Tag list optional |
{% for item in by_type["OpsStore"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
OpsStoreTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["OpsStoreTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
PackageSystem Link
| Field | Shape |
|---|---|
imports |
contained → Import list optional |
name |
string one of: ExtraLarge | Large | Medium | Small |
system |
contained → ProtectedResource |
{% for item in by_type["PackageSystem"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Parameter Link
| Field | Shape |
|---|---|
defaultValue |
contained → TypedLiteral list optional |
description |
string list optional |
location |
string list optional |
name |
string |
required |
contained → Boolean list optional |
type |
contained → DataTypeReference |
{% for item in by_type["Parameter"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
PriorityTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["PriorityTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
ProtectedResource Link
Extends ASLNamedElement
| Field | Shape |
|---|---|
accessibility |
contained → UIAccessibility list optional |
action |
string list optional |
actions |
contained → ActionSequence list optional |
activationExpression |
contained → UIExpression list optional |
adapters |
string list optional |
agents |
reference → AIAgent list optional |
alerts |
contained → OpsAlert list optional |
appliesTo |
reference → ProtectedResource list optional |
approval |
contained → Boolean list optional |
approvalRequired |
contained → Boolean list optional |
approvals |
contained → ApprovalCheckpoint list optional |
auditing |
contained → Boolean list optional |
auditRequired |
contained → Boolean list optional |
authentication |
reference → SecAuthenticationScheme list optional |
authorization |
reference → SecAccessPolicy list optional |
authorizations |
reference → SecAccessPolicy list optional |
backups |
contained → OpsBackupPolicy list optional |
bindings |
contained → OpsConfigBinding list optional |
capabilities |
reference → AICapability list optional |
channel |
contained → AppNotificationType |
children |
contained → ChildDataEntity list optional |
citationsRequired |
contained → Boolean list optional |
components |
reference → AppComponent list optional |
concerns |
string list optional |
conditions |
contained → LogicExpression list optional |
confidence |
contained → Percentage list optional |
contacts |
string list optional |
contents |
contained → UIContent list optional |
context |
contained → ContextPolicy list optional |
credential |
reference → SecSecret list optional |
criteria |
contained → EvaluationCriterion list optional |
dataBindings |
contained → UIDataBinding list optional |
dataFlows |
contained → DataFlowTarget list optional |
dataRestrictions |
reference → DataEntityGeneric list optional |
dataScopes |
reference → DataEntityGeneric list optional |
datasets |
reference → Dataset list optional |
deadLetter |
reference → AppChannel list optional |
defaultRoutes |
reference → UIRoute list optional |
delivery |
string list optional |
dependencies |
reference → AppModule list optional |
deployables |
reference → Deployable list optional |
description |
string list optional |
descriptions |
string list optional |
direction |
contained → AppIntegrationType |
duration |
contained → Duration list optional |
editableWhen |
contained → LogicExpression list optional |
effect |
string list optional |
embeddingModel |
reference → AIModel list optional |
enabledWhen |
contained → LogicExpression list optional |
endpoints |
string list optional |
entities |
reference → DataEntityGeneric list optional |
environments |
reference → OpsEnvironment list optional |
escalatesTo |
reference → AIAgent list optional |
escalation |
contained → Duration list optional |
events |
contained → ProtectedResource list optional |
externalIds |
string list optional |
externalSystem |
string list optional |
fallback |
reference → AIModel list optional |
features |
contained → AppFeature list optional |
filters |
contained → LogicExpression list optional |
freshness |
contained → Duration list optional |
guardrails |
reference → AIGuardrail list optional |
guards |
reference → SecAccessPolicy list optional |
handlers |
contained → UIEventHandler list optional |
healthChecks |
contained → OpsHealthCheck list optional |
indexes |
string list optional |
inherits |
reference → SecRole list optional |
input |
reference → DataEntityGeneric list optional |
instructions |
string list optional |
interfaceName |
string list optional |
invocables |
reference → Invocable list optional |
isActive |
string list optional |
isDefault |
string list optional |
isExternal |
string list optional |
isFinal |
string list optional |
isLandmark |
string list optional |
isReusable |
string list optional |
isScrollable |
string list optional |
isSlider |
string list optional |
issuer |
string list optional |
isXOR |
string list optional |
kind |
contained → AIGuardrailType |
knowledge |
reference → AIKnowledgeBase list optional |
layouts |
contained → UILayout list optional |
localizationKeys |
string list optional |
locators |
string list optional |
logging |
contained → OpsLogging list optional |
main |
reference → DataEntity list optional |
mappings |
contained → DataMapping list optional |
memory |
contained → MemoryPolicy list optional |
message |
string list optional |
messages |
reference → AppEvent list optional |
method |
contained → AppEndpointType |
metrics |
contained → OpsMetric list optional |
modelId |
string list optional |
models |
reference → AIModel list optional |
multiFactor |
contained → Boolean list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
notFoundRoutes |
reference → UIRoute list optional |
objectives |
string list optional |
observability |
reference → OpsObservability list optional |
operation |
reference → AppOperation list optional |
operations |
contained → Invocable list optional |
orchestrations |
reference → AIOrchestration list optional |
output |
reference → DataEntityGeneric list optional |
page |
reference → UIPage list optional |
pagination |
contained → PaginationPolicy list optional |
parameters |
contained → Parameter list optional |
parents |
reference → UIRoute list optional |
partOf |
reference → System list optional |
path |
string |
paths |
string list optional |
permissions |
reference → SecPermission list optional |
priority |
contained → PriorityType list optional |
prohibitedActions |
string list optional |
protocol |
string list optional |
provider |
string list optional |
providers |
string list optional |
publishers |
reference → AppService list optional |
recipient |
contained → LogicExpression list optional |
redirects |
reference → UIRoute list optional |
replicas |
number list optional |
representedStakeholders |
reference → Stakeholder list optional |
request |
contained → DataTypeReference list optional |
requirements |
reference → RequirementTarget list optional |
resources |
reference → ProtectedResource list optional |
responses |
contained → ApiResponse list optional |
responsibilities |
string list optional |
retention |
contained → Duration list optional |
retry |
contained → RetryPolicy list optional |
role |
string list optional |
roles |
reference → SecRole list optional |
routes |
reference → UIRoute list optional |
rules |
contained → LogicExpression list optional |
runtime |
contained → OpsDeploymentType |
safetyTests |
string list optional |
scaling |
contained → OpsScalingPolicy list optional |
schedule |
string list optional |
schema |
reference → DataEntityGeneric list optional |
secret |
reference → SecSecret list optional |
secrets |
reference → SecSecret list optional |
sessionDuration |
contained → Duration list optional |
sideEffect |
string list optional |
softDeletion |
contained → Boolean list optional |
sources |
reference → DataResource list optional |
states |
contained → UIState list optional |
structuredOutput |
reference → DataEntityGeneric list optional |
subscribers |
reference → AppService list optional |
subType |
contained → StakeholderSubType optional |
superActors |
reference → Actor list optional |
synchronization |
string list optional |
systemConcepts |
contained → SystemConcept list optional |
tags |
contained → Tag list optional |
temperature |
number list optional |
template |
string list optional |
timeout |
contained → Duration list optional |
title |
string list optional |
tokens |
contained → UIStyleToken list optional |
tools |
reference → AIAgentTool list optional |
topK |
number list optional |
transaction |
string list optional |
triggers |
reference → AppEvent list optional |
type |
contained → ActorType |
uiActions |
contained → ProtectedResource list optional |
uiActivationExpression |
contained → UIExpression list optional |
uiComponentParts |
contained → UIComponentPart list optional |
uiParameters |
contained → UIParameter list optional |
uris |
string list optional |
uses |
contained → RefDataEntity list optional |
variants |
contained → UIComponentVariant list optional |
vendor |
string list optional |
version |
string list optional |
versions |
string list optional |
visibility |
string list optional |
visibleWhen |
contained → LogicExpression list optional |
{% for item in by_type["ProtectedResource"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
QRSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["QRSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
QRTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["QRTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
QualityRequirement Link
Extends RequirementTarget
| Field | Shape |
|---|---|
descriptions |
string list optional |
expressions |
contained → Expression list optional |
isAbstract |
string list optional |
isConcrete |
string list optional |
isNegative |
string list optional |
isPositive |
string list optional |
isProblem |
string list optional |
isSolution |
string list optional |
measures |
string list optional |
name |
string |
nameAlias |
string optional |
partOf |
contained → QualityRequirementPartOf list optional |
priorities |
contained → PriorityType list optional |
rationales |
string list optional |
stakeholders |
reference → Stakeholder list optional |
statements |
string list optional |
subType |
contained → QRSubType optional |
tags |
contained → Tag list optional |
targets |
string list optional |
type |
contained → QRType |
{% for item in by_type["QualityRequirement"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
RelationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["RelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
RequirementReference Link
Extends RequirementTarget
| Field | Shape |
|---|---|
descriptions |
string list optional |
externalIds |
string list optional |
name |
string |
nameAlias |
string optional |
sources |
string list optional |
tags |
contained → Tag list optional |
uris |
string list optional |
versions |
string list optional |
{% for item in by_type["RequirementReference"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
RequirementsRelationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["RequirementsRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
RequirementTarget Link
Extends ProtectedResource
| Field | Shape |
|---|---|
descriptions |
string list optional |
expressions |
contained → Expression list optional |
externalIds |
string list optional |
isAbstract |
string list optional |
isConcrete |
string list optional |
isNegative |
string list optional |
isPositive |
string list optional |
isProblem |
string list optional |
isSolution |
string list optional |
measures |
string list optional |
name |
string |
nameAlias |
string optional |
partOf |
contained → ConstraintRequirementPartOf list optional |
priorities |
contained → PriorityType list optional |
rationales |
string list optional |
sources |
string list optional |
stakeholders |
reference → Stakeholder list optional |
statements |
string list optional |
subType |
contained → ConstraintSubType optional |
tags |
contained → Tag list optional |
targets |
string list optional |
type |
contained → ConstraintType |
uris |
string list optional |
versions |
string list optional |
{% for item in by_type["RequirementTarget"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
RuleTarget Link
Extends ProtectedResource
| Field | Shape |
|---|---|
name |
string |
nameAlias |
string optional |
{% for item in by_type["RuleTarget"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecAccessPolicy Link
Extends ProtectedResource
| Field | Shape |
|---|---|
conditions |
contained → LogicExpression list optional |
description |
string list optional |
effect |
string list optional |
name |
string |
nameAlias |
string optional |
permissions |
reference → SecPermission list optional |
roles |
reference → SecRole list optional |
tags |
contained → Tag list optional |
type |
contained → SecAccessPolicyType |
{% for item in by_type["SecAccessPolicy"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecAccessPolicyTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SecAccessPolicyTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecAuthenticationScheme Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
issuer |
string list optional |
multiFactor |
contained → Boolean list optional |
name |
string |
nameAlias |
string optional |
secrets |
reference → SecSecret list optional |
sessionDuration |
contained → Duration list optional |
tags |
contained → Tag list optional |
type |
contained → SecAuthenticationSchemeType |
{% for item in by_type["SecAuthenticationScheme"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecAuthenticationSchemeTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SecAuthenticationSchemeTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecPermission Link
Extends ProtectedResource
| Field | Shape |
|---|---|
action |
contained → SecPermissionActionType |
conditions |
contained → LogicExpression list optional |
descriptions |
string list optional |
name |
string |
nameAlias |
string optional |
resources |
reference → ProtectedResource list optional |
tags |
contained → Tag list optional |
{% for item in by_type["SecPermission"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecPermissionActionTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SecPermissionActionTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecRole Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
inherits |
reference → SecRole list optional |
name |
string |
nameAlias |
string optional |
permissions |
reference → SecPermission list optional |
tags |
contained → Tag list optional |
type |
contained → SecRoleType |
{% for item in by_type["SecRole"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecRoleTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SecRoleTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecSecret Link
Extends ProtectedResource
| Field | Shape |
|---|---|
descriptions |
string list optional |
locators |
string list optional |
name |
string |
nameAlias |
string optional |
providers |
string list optional |
tags |
contained → Tag list optional |
type |
contained → SecSecretType |
{% for item in by_type["SecSecret"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SecSecretTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SecSecretTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Stakeholder Link
Extends ProtectedResource
| Field | Shape |
|---|---|
concerns |
string list optional |
contacts |
string list optional |
descriptions |
string list optional |
isExternal |
string list optional |
name |
string |
nameAlias |
string optional |
responsibilities |
string list optional |
subType |
contained → StakeholderSubType optional |
tags |
contained → Tag list optional |
type |
contained → StakeholderType |
{% for item in by_type["Stakeholder"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
StakeholderSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["StakeholderSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
StakeholderTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["StakeholderTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Stereotype Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → StereotypeType |
{% for item in by_type["Stereotype"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
StereotypeTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["StereotypeTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
StructuredDataResource Link
Extends ProtectedResource
| Field | Shape |
|---|---|
attributes |
contained → DataSymbol list optional |
constraint |
contained → DataEntityConstraint list optional |
description |
string list optional |
name |
string |
nameAlias |
string optional |
subType |
contained → DataEntitySubType optional |
super |
reference → DataEntity list optional |
tags |
contained → Tag list optional |
type |
contained → DataEntityType |
{% for item in by_type["StructuredDataResource"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
System Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
isFinal |
string list optional |
isReusable |
string list optional |
name |
string |
nameAlias |
string optional |
partOf |
reference → System list optional |
subType |
contained → SystemSubType optional |
systemConcepts |
contained → SystemConcept list optional |
tags |
contained → Tag list optional |
type |
contained → SystemType |
vendor |
string list optional |
version |
string list optional |
{% for item in by_type["System"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SystemsRelation Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
source |
reference → System |
tags |
contained → Tag list optional |
target |
reference → System |
type |
string one of: dependsOn | integratesWith | partOf |
{% for item in by_type["SystemsRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SystemsRelationCategoryExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SystemsRelationCategoryExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SystemsRelationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SystemsRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SystemSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SystemSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
SystemTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["SystemTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
TestsRelationTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["TestsRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Theme Link
| Field | Shape |
|---|---|
description |
string list optional |
elements |
contained → ReferenceElements list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → ThemeType |
{% for item in by_type["Theme"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
TraceRelation Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
source |
reference → SystemConcept |
tags |
contained → Tag list optional |
target |
reference → SystemConcept |
type |
string one of: conflictsWith | dependsOn | derivedFrom | implements | realizes | refines | satisfies | tests | … |
{% for item in by_type["TraceRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UCExtensionPoint Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
{% for item in by_type["UCExtensionPoint"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIAction Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
events |
contained → ProtectedResource list optional |
invocables |
reference → Invocable list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
tags |
contained → Tag list optional |
type |
contained → UIActionType |
uiParameters |
contained → UIParameter list optional |
{% for item in by_type["UIAction"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIActionEventTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIActionEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIActionTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIActionTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponent Link
Extends ProtectedResource
| Field | Shape |
|---|---|
dataBindings |
contained → UIDataBinding list optional |
dataFlows |
contained → DataFlowTarget list optional |
description |
string list optional |
enabledWhen |
contained → LogicExpression list optional |
events |
contained → ProtectedResource list optional |
handlers |
contained → UIEventHandler list optional |
isActive |
string list optional |
isScrollable |
string list optional |
isSlider |
string list optional |
message |
string list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
subType |
contained → UIComponentSubType optional |
tags |
contained → Tag list optional |
title |
string list optional |
type |
contained → UIComponentType |
uiActions |
contained → ProtectedResource list optional |
uiActivationExpression |
contained → UIExpression list optional |
uiComponentParts |
contained → UIComponentPart list optional |
uiParameters |
contained → UIParameter list optional |
visibleWhen |
contained → LogicExpression list optional |
{% for item in by_type["UIComponent"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponentPart Link
| Field | Shape |
|---|---|
blockIf |
contained → LogicExpression list optional |
dataAttributeBinding |
reference → DataAttribute list optional |
dataBindings |
contained → UIDataBinding list optional |
defaultValue |
string list optional |
description |
string list optional |
events |
contained → ProtectedResource list optional |
handlers |
contained → UIEventHandler list optional |
isHidden |
string list optional |
isReadOnly |
string list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
showIf |
contained → LogicExpression list optional |
subType |
contained → UIComponentPartSubType optional |
tags |
contained → Tag list optional |
type |
contained → UIComponentPartType |
uiActivationExpression |
contained → UIExpression list optional |
uiComponentParts |
contained → UIComponentPart list optional |
valueType |
contained → DataAttributeType list optional |
wireframeType |
contained → UIWireframeType optional |
{% for item in by_type["UIComponentPart"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponentPartSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIComponentPartSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponentPartTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIComponentPartTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponentSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIComponentSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponentTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIComponentTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIComponentVariant Link
| Field | Shape |
|---|---|
component |
reference → UIComponent |
description |
string list optional |
name |
string |
properties |
contained → UIVariantProperty list optional |
{% for item in by_type["UIComponentVariant"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIContainer Link
Extends ProtectedResource
| Field | Shape |
|---|---|
activationExpression |
contained → UIExpression list optional |
contents |
contained → UIContent list optional |
description |
string list optional |
enabledWhen |
contained → LogicExpression list optional |
events |
contained → ProtectedResource list optional |
handlers |
contained → UIEventHandler list optional |
isDefault |
string list optional |
isLandmark |
string list optional |
isXOR |
string list optional |
layouts |
contained → UILayout list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
subType |
contained → UIContainerSubType optional |
tags |
contained → Tag list optional |
type |
contained → UIContainerType |
uiActions |
contained → ProtectedResource list optional |
uiParameters |
contained → UIParameter list optional |
visibleWhen |
contained → LogicExpression list optional |
{% for item in by_type["UIContainer"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIContainerSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIContainerSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIContainerTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIContainerTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIDesignSystem Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
tokens |
contained → UIStyleToken list optional |
type |
contained → UIDesignSystemType |
variants |
contained → UIComponentVariant list optional |
{% for item in by_type["UIDesignSystem"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIDesignSystemTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIDesignSystemTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIElementEventSubTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIElementEventSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIElementEventTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIElementEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIEvent Link
Extends ProtectedResource
| Field | Shape |
|---|---|
conditions |
contained → LogicExpression list optional |
descriptions |
string list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
tags |
contained → Tag list optional |
type |
string |
uiParameters |
contained → UIParameter list optional |
{% for item in by_type["UIEvent"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIPage Link
Extends ProtectedResource
| Field | Shape |
|---|---|
accessibility |
contained → UIAccessibility list optional |
authorizations |
reference → SecAccessPolicy list optional |
contents |
contained → UIContent list optional |
description |
string list optional |
editableWhen |
contained → LogicExpression list optional |
enabledWhen |
contained → LogicExpression list optional |
handlers |
contained → UIEventHandler list optional |
layouts |
contained → UILayout list optional |
localizationKeys |
string list optional |
name |
string |
nameAlias |
string optional |
navigations |
contained → UINavigation list optional |
states |
contained → UIState list optional |
tags |
contained → Tag list optional |
type |
contained → UIPageType |
visibleWhen |
contained → LogicExpression list optional |
{% for item in by_type["UIPage"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIPageTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIPageTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIParameter Link
| Field | Shape |
|---|---|
name |
string |
nameAlias |
string optional |
type |
contained → DataAttributeType optional |
{% for item in by_type["UIParameter"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIPort Link
| Field | Shape |
|---|---|
description |
string list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → UIPortType |
uiParameters |
contained → UIParameter list optional |
{% for item in by_type["UIPort"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIPortTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIPortTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIResponsiveBreakpoint Link
| Field | Shape |
|---|---|
minimum |
number |
name |
string one of: ExtraLarge | Large | Medium | Small |
{% for item in by_type["UIResponsiveBreakpoint"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIRoute Link
Extends ProtectedResource
| Field | Shape |
|---|---|
description |
string list optional |
guards |
reference → SecAccessPolicy list optional |
name |
string |
nameAlias |
string optional |
page |
reference → UIPage list optional |
parameters |
contained → UIRouteParameter list optional |
parents |
reference → UIRoute list optional |
paths |
string list optional |
redirects |
reference → UIRoute list optional |
tags |
contained → Tag list optional |
type |
contained → UIRouteType |
{% for item in by_type["UIRoute"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIRouteParameter Link
| Field | Shape |
|---|---|
name |
string |
required |
contained → Boolean optional |
type |
contained → DataAttributeType |
{% for item in by_type["UIRouteParameter"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIRouteSet Link
Extends ProtectedResource
| Field | Shape |
|---|---|
authorizations |
reference → SecAccessPolicy list optional |
defaultRoutes |
reference → UIRoute list optional |
descriptions |
string list optional |
name |
string |
nameAlias |
string optional |
notFoundRoutes |
reference → UIRoute list optional |
routes |
reference → UIRoute list optional |
tags |
contained → Tag list optional |
type |
contained → UIRouteSetType |
{% for item in by_type["UIRouteSet"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIRouteSetTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIRouteSetTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIRouteTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIRouteTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIState Link
| Field | Shape |
|---|---|
kind |
string one of: Disabled | Empty | Error | Loading | Success |
message |
string list optional |
name |
string |
nameAlias |
string optional |
visibleWhen |
contained → LogicExpression list optional |
{% for item in by_type["UIState"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIStyleToken Link
| Field | Shape |
|---|---|
kind |
string one of: Color | Radius | Shadow | Spacing | Typography |
name |
string |
value |
string |
{% for item in by_type["UIStyleToken"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UISystemEventTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UISystemEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIThrowingEventTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIThrowingEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIVariantProperty Link
| Field | Shape |
|---|---|
name |
string |
type |
contained → DataAttributeType |
value |
contained → TypedLiteral optional |
{% for item in by_type["UIVariantProperty"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UIWireframeTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UIWireframeTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UseCase Link
Extends UseCaseTarget
| Field | Shape |
|---|---|
dataEntities |
reference → DataEntityGeneric list optional |
descriptions |
string list optional |
extensionPointGroups |
contained → UCExtensionPoints list optional |
extensions |
contained → UCExtends list optional |
includes |
contained → UCIncludes list optional |
name |
string |
nameAlias |
string optional |
postconditions |
string list optional |
preconditions |
string list optional |
primaryActors |
reference → Actor list optional |
priorities |
contained → PriorityType list optional |
requirements |
reference → FunctionalRequirement list optional |
stakeholders |
reference → Stakeholder list optional |
supportingActors |
reference → Actor list optional |
tags |
contained → Tag list optional |
triggers |
string list optional |
type |
contained → UseCaseType |
{% for item in by_type["UseCase"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UseCaseTarget Link
Extends RequirementTarget
| Field | Shape |
|---|---|
dataEntities |
reference → DataEntityGeneric list optional |
descriptions |
string list optional |
extensionPointGroups |
contained → UCExtensionPoints list optional |
extensions |
contained → UCExtends list optional |
includes |
contained → UCIncludes list optional |
name |
string |
nameAlias |
string optional |
postconditions |
string list optional |
preconditions |
string list optional |
primaryActors |
reference → Actor list optional |
priorities |
contained → PriorityType list optional |
requirements |
reference → FunctionalRequirement list optional |
stakeholders |
reference → Stakeholder list optional |
supportingActors |
reference → Actor list optional |
tags |
contained → Tag list optional |
triggers |
string list optional |
type |
contained → UseCaseType |
{% for item in by_type["UseCaseTarget"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
UseCaseTypeExtended Link
| Field | Shape |
|---|---|
description |
string optional |
name |
string |
nameAlias |
string optional |
{% for item in by_type["UseCaseTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
View Link
| Field | Shape |
|---|---|
description |
string list optional |
elements |
contained → ReferenceElements list optional |
name |
string |
nameAlias |
string optional |
tags |
contained → Tag list optional |
type |
contained → ViewType |
{% for item in by_type["View"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}
Embedded types 235
These types are not indexed in by_type. Reach them through fields on their parent objects.
_LogicFunction
Linkfunctionparams
ActionInvocation
Linkactionarguments
ActionSequence
Linkactions
ActionTypeExtendedRef
Linktype
ActionTypeOriginal
Linktype
ActiveEventTypeExtendedRef
Linktype
ActiveEventTypeOriginal
Linktype
ActiveFlowTypeExtendedRef
Linktype
ActiveFlowTypeOriginal
Linktype
ActiveTaskTypeExtendedRef
Linktype
ActiveTaskTypeOriginal
Linktype
ActorRelationTypeExtendedRef
Linktype
ActorRelationTypeOriginal
Linktype
ActorTypeExtendedRef
Linktype
ActorTypeOriginal
Linktype
AIAgentToolTypeExtendedRef
Linktype
AIAgentToolTypeOriginal
Linktype
AIAgentTypeExtendedRef
Linktype
AIAgentTypeOriginal
Linktype
AIEvaluationScenarioTypeExtendedRef
Linktype
AIEvaluationScenarioTypeOriginal
Linktype
AIGuardrailTypeExtendedRef
Linktype
AIGuardrailTypeOriginal
Linktype
AIKnowledgeBaseTypeExtendedRef
Linktype
AIKnowledgeBaseTypeOriginal
Linktype
AIModelTypeExtendedRef
Linktype
AIModelTypeOriginal
Linktype
AIOrchestrationTypeExtendedRef
Linktype
AIOrchestrationTypeOriginal
Linktype
ApiResponse
Linkbodydescriptionstatus
AppChannelTypeExtendedRef
Linktype
AppChannelTypeOriginal
Linktype
AppComponentTypeExtendedRef
Linktype
AppComponentTypeOriginal
Linktype
AppEndpointTypeExtendedRef
Linktype
AppEndpointTypeOriginal
Linktype
AppEventTypeExtendedRef
Linktype
AppEventTypeOriginal
Linktype
AppIntegrationTypeExtendedRef
Linktype
AppIntegrationTypeOriginal
Linktype
AppJobTypeExtendedRef
Linktype
AppJobTypeOriginal
Linktype
AppModuleTypeExtendedRef
Linktype
AppModuleTypeOriginal
Linktype
AppNotificationTypeExtendedRef
Linktype
AppNotificationTypeOriginal
Linktype
AppOperationTypeExtendedRef
Linktype
AppOperationTypeOriginal
Linktype
AppRuleTypeExtendedRef
Linktype
AppRuleTypeOriginal
Linktype
AppServiceTypeExtendedRef
Linktype
AppServiceTypeOriginal
Linktype
ArithmeticFormula
Linkexpr
ArithmeticSigned
Linkexpression
AttributeValue
LinkbooleandatedateTimedoubleOrIntpercentagestringtime
Boolean
Linkvalue
BooleanLiteral
Linkvalue
BooleanLogicExpression
Linkleftopright
BooleanNegation
Linkexpression
ChildDataEntity
LinkchildchildUses
ConstraintRequirementPartOf
Linkparentrelation
ConstraintSubTypeExtendedRef
Linktype
ConstraintSubTypeOriginal
Linktype
ConstraintTypeExtendedRef
Linktype
ConstraintTypeOriginal
Linktype
ContextPolicy
LinkincludeHistoryincludeSourcesmaximumTokens
DataAttributeConstraint
LinkchecksderivedFromforeignKeyisDerivedisEncryptedisNotNullisNotVisibleisPrimaryKeyisReadOnlyisUniquemanyToManymultiplicity
DataAttributeRefsList
LinkattributeRef
DataAttributeType
Linkdecimalsizetype
DataAttributeTypeExtendedRef
Linkdecimalsizetype
DataAttributeTypeOriginal
Linkdecimalsizetype
DataEntityClusterTypeExtendedRef
Linktype
DataEntityClusterTypeOriginal
Linktype
DataEntityConstraint
LinkchecksisEncryptedisReadOnlyshowAsAttribute
DataEntitySubTypeExtendedRef
Linktype
DataEntitySubTypeOriginal
Linktype
DataEntityTypeExtendedRef
Linktype
DataEntityTypeOriginal
Linktype
DataEnumerationRef
Linkdecimalsizetype
DataFlowTarget
Linkbindingsconditiontarget
DataMapping
Linkexpressionsourcetarget
DataTable
LinktableHeadertableRows
DataTableHeader
LinkattributeRefs
DataTableRow
LinkattributeValues
DataTypeReference
Linkentityenumerationprimitive
DateTime
Linkdayhhmmmonthssyear
DateType
Linkdaymonthyear
DecimalType
Linkprecisionscale
DetailsFormula
LinkattrdataEntitytype
Duration
Linkunitvalue
ElementsRelationType
Linktype
Expression
Linkmetricoperatorvalue
ExpressionOperator
Linkvalue
ForeignKey
LinkdefaultValueonDeleteshowAsFieldtargetEntitytoField
ForeignKeyOnDeleteTypeExtendedRef
Linktype
ForeignKeyOnDeleteTypeOriginal
Linktype
FRTypeExtendedRef
Linktype
FRTypeOriginal
Linktype
FunctionalRequirementPartOf
Linkparentrelation
Import
LinkimportedNamespace
IncludeAll
Linkdescriptionsystemtags
IncludeElement
LinkdescriptionelementsystemtagstypeupdateFields
IncludeSystemElementType
Linktype
IntegerLiteral
Linkvalue
LogicComparison
Linkleftopright
LogicEquals
Linkleftopright
LogicFunctionReference
Linkref
LogicMembership
Linkleftopright
LogicTernaryExpression
Linkexpressionfalsevaluetruevalue
LogicVariable
Linkvalue
LogicVariableReference
Linkref
ManyToMany
LinktargetEntitythroughEntitythroughSourceFieldthroughTargetField
MemoryPolicy
Linkretentionscopestore
MetricFormula
Linkmetric
MetricTypeExtendedRef
Linktype
MetricTypeOriginal
Linktype
Minus
Linkleftright
Model
Linkpackages
MultiOrDivOrMod
Linkleftopright
Multiplicity
Linkexactlegacylowerunboundedupper
NullLiteral
Linkvalue
OpsConfigBinding
Linkpropertysecretvalue
OpsDeploymentTypeExtendedRef
Linktype
OpsDeploymentTypeOriginal
Linktype
OpsEnvironmentTypeExtendedRef
Linktype
OpsEnvironmentTypeOriginal
Linktype
OpsObservabilityTypeExtendedRef
Linktype
OpsObservabilityTypeOriginal
Linktype
OpsRetentionPolicyTypeExtendedRef
Linktype
OpsRetentionPolicyTypeOriginal
Linktype
OpsStoreTypeExtendedRef
Linktype
OpsStoreTypeOriginal
Linktype
PaginationPolicy
LinkdefaultSizemaximumSizestyle
Percentage
Linkvalue
Plus
Linkleftright
PriorityTypeExtendedRef
Linktype
PriorityTypeOriginal
Linktype
QRSubTypeExtendedRef
Linktype
QRSubTypeOriginal
Linktype
QRTypeExtendedRef
Linktype
QRTypeOriginal
Linktype
QualityRequirementPartOf
Linkparentrelation
RefDataEntity
LinkrefDataEntity
ReferenceElements
Linkreferences
RefUC
Linkreferences
RequirementsRelationTypeExtendedRef
Linktype
RequirementsRelationTypeOriginal
Linktype
RetryPolicy
Linkattemptsbackoffdelay
SecAccessPolicyTypeExtendedRef
Linktype
SecAccessPolicyTypeOriginal
Linktype
SecAuthenticationSchemeTypeExtendedRef
Linktype
SecAuthenticationSchemeTypeOriginal
Linktype
SecPermissionActionTypeExtendedRef
Linktype
SecPermissionActionTypeOriginal
Linktype
SecRoleTypeExtendedRef
Linktype
SecRoleTypeOriginal
Linktype
SecSecretTypeExtendedRef
Linktype
SecSecretTypeOriginal
Linktype
SortCriterion
Linkattributedirection
SortDirection
Linkvalue
StakeholderSubTypeExtendedRef
Linktype
StakeholderSubTypeOriginal
Linktype
StakeholderTypeExtendedRef
Linktype
StakeholderTypeOriginal
Linktype
StereotypeTypeExtendedRef
Linktype
StereotypeTypeOriginal
Linktype
StringLiteral
Linkvalue
SystemsRelationCategoryExtendedRef
Linktype
SystemsRelationCategoryOriginal
Linktype
SystemsRelationTypeExtendedRef
Linktype
SystemsRelationTypeOriginal
Linktype
SystemSubTypeExtendedRef
Linktype
SystemSubTypeOriginal
Linktype
SystemTypeExtendedRef
Linktype
SystemTypeOriginal
Linktype
Tag
LinknameAliasvalue
TestsRelationTypeExtendedRef
Linktype
TestsRelationTypeOriginal
Linktype
ThemeType
Linktype
Time
Linkhhmmss
TypedLiteral
LinkbooleanValuedateTimeValuedateValuedecimalValuedurationValueintegerValuenullValuepercentageValuestringValuesymbolValuetimeValue
UCExtends
LinkextensionPointuseCase
UCExtensionPoints
LinkextensionPoints
UCIncludes
Linkreferences
UIAccessibility
LinkfocusOrderkeyboardlabelrequirementrole
UIActionEventTypeExtendedRef
Linktype
UIActionEventTypeOriginal
Linktype
UIActionTypeExtendedRef
Linktype
UIActionTypeOriginal
Linktype
UIComponentPartSubTypeExtendedRef
Linktype
UIComponentPartSubTypeOriginal
Linktype
UIComponentPartTypeExtendedRef
Linktype
UIComponentPartTypeOriginal
Linktype
UIComponentSubTypeExtendedRef
Linktype
UIComponentSubTypeOriginal
Linktype
UIComponentTypeExtendedRef
Linktype
UIComponentTypeOriginal
Linktype
UIComponentUse
Linkcomponent
UIContainerSubTypeExtendedRef
Linktype
UIContainerSubTypeOriginal
Linktype
UIContainerTypeExtendedRef
Linktype
UIContainerTypeOriginal
Linktype
UIContextExpression
Linkcondition
UIDataBinding
LinkdataEntitydisplayAttributesfilterAttributesfilterExpressionrecursionDepthsearchAttributessortAttributessortCriteria
UIDesignSystemTypeExtendedRef
Linktype
UIDesignSystemTypeOriginal
Linktype
UIDimensionValue
Linkunitvalue
UIElementEventSubTypeExtendedRef
Linktype
UIElementEventSubTypeOriginal
Linktype
UIElementEventTypeExtendedRef
Linktype
UIElementEventTypeOriginal
Linktype
UIEventHandler
LinkactionsconditionseventfailureNavigationsuccessNavigation
UILayout
Linkalignmentbreakpointscolumnsgapheightkindwidth
UIPageTypeExtendedRef
Linktype
UIPageTypeOriginal
Linktype
UIParameterBinding
Linksourcetarget
UIPortTypeExtendedRef
Linktype
UIPortTypeOriginal
Linktype
UIRouteSetTypeExtendedRef
Linktype
UIRouteSetTypeOriginal
Linktype
UIRouteTypeExtendedRef
Linktype
UIRouteTypeOriginal
Linktype
UISimpleExpression
Linkbodyexpressionlanguage
UISystemEventTypeExtendedRef
Linktype
UISystemEventTypeOriginal
Linktype
UIThrowingEventTypeExtendedRef
Linktype
UIThrowingEventTypeOriginal
Linktype
UIWireframeTypeExtendedRef
Linktype
UIWireframeTypeOriginal
Linktype
UpdateField
LinknameFieldvalueField
UpdateFields
LinkupdateFields
UseCaseTypeExtendedRef
Linktype
UseCaseTypeOriginal
Linktype
ViewType
Linktype