Attributes
AggregationQueryColumn
Defines an aggregation column with its attribute path and aggregation type.
Data Type
RECORD: System-2/AggregationQueryColumn
AggregationQueryColumns
Defines a set of aggregation columns for the query, with its attribute path and aggregation type.
Data Type
Array of RECORD_ARRAY: System-2/AggregationQueryColumn
AggregationType
Type of aggregation function to apply (Count, Min, Max, Avg, Sum).
Data Type
ENUM: System-2/AggregationTypes
AttributePath
Path to an attribute, supporting nested paths with dot notation.
Data Type
STRING
AttributePaths
Array of attribute paths for multi-attribute operations.
Data Type
STRING_ARRAY
AutoIncrement.CurrentValue
The current value of the auto-increment counter.
Data Type
INT
AutoIncrement.End
The upper limit of the auto-increment sequence.
Data Type
INT
AutoIncrement.Format
Optional format string for generating formatted identifiers (e.g., 'INV-{0:D6}').
Data Type
STRING
BlueprintBackup.BlueprintName
Name of the blueprint whose pre-apply state this backup captures.
Data Type
STRING
BlueprintBackup.BlueprintVersion
Version of the blueprint at the time the backup was taken.
Data Type
STRING
BlueprintBackup.CreatedAt
Timestamp when this backup was created (before the corresponding apply).
Data Type
DATE_TIME
BlueprintBackup.SnapshotJson
Serialized snapshot of seed entities (and their attributes) that existed before the apply, used to support rollback.
Data Type
STRING
BlueprintHistory.ApplicationMode
How the blueprint was applied: Install, Update, Rollback, or Reapply.
Data Type
STRING
BlueprintHistory.AppliedAt
Timestamp when the apply operation completed.
Data Type
DATE_TIME
BlueprintHistory.BlueprintName
Name of the blueprint involved in this history entry.
Data Type
STRING
BlueprintHistory.BlueprintVersion
Version of the blueprint involved in this history entry.
Data Type
STRING
BlueprintHistory.EntitiesCreated
Number of seed entities created by this apply.
Data Type
INT
BlueprintHistory.EntitiesDeleted
Number of seed entities deleted by this apply.
Data Type
INT
BlueprintHistory.EntitiesUpdated
Number of seed entities updated by this apply.
Data Type
INT
BlueprintHistory.PreviousBlueprintName
Name of the previously installed blueprint version, if this entry represents an update or rollback.
Data Type
STRING
BlueprintHistory.PreviousVersion
Previously installed version, if this entry represents an update or rollback.
Data Type
STRING
BlueprintHistory.SeedDataChecksum
Checksum of the seed-data files applied in this operation.
Data Type
STRING
BlueprintInstallation.BlueprintName
Name of the installed blueprint (without version).
Data Type
STRING
BlueprintInstallation.BlueprintVersion
Semantic version of the installed blueprint.
Data Type
STRING
BlueprintInstallation.InstalledAt
Timestamp when the blueprint was first installed in this tenant.
Data Type
DATE_TIME
BlueprintInstallation.IsDependency
True when this blueprint was installed transitively to satisfy another blueprint's dependency, false when it was requested explicitly.
Data Type
BOOLEAN
BlueprintInstallation.LastUpdatedAt
Timestamp of the most recent apply (install, update, re-apply, or rollback).
Data Type
DATE_TIME
BlueprintInstallation.ResolvedDependencies
Full blueprint identifiers (Name-Version) of dependencies that were resolved and installed alongside this blueprint.
Data Type
STRING_ARRAY
BlueprintInstallation.SeedDataChecksum
Checksum of the seed-data files applied at the most recent apply, used to detect drift on re-apply.
Data Type
STRING
ComparisonValue
The value to compare against in filter operations.
Data Type
STRING
ConfigurationValue
Stores configuration data such as schema version or identity information.
Data Type
STRING
DatabaseName
Name of the database associated with this tenant.
Data Type
STRING
Description
Further information on the item.
Data Type
STRING
DisplayName
Human-readable display name shown in user interfaces.
Data Type
STRING
Enabled
Indicates whether the entity is active and operational.
Data Type
BOOLEAN
EnvironmentMode
Defines the operational mode of the tenant (Development, Testing, Staging, Production).
Data Type
ENUM: System-2/EnvironmentModes
Default Values
| Default Value |
|---|
| 0 |
FieldFilter.Operator
Comparison operator for field filtering (Equals, Like, GreaterThan, etc.).
Data Type
ENUM: System-2/FieldFilterOperator
From
Inclusive start of a TimeRange (UTC).
Data Type
DATE_TIME
MaintenanceLevel
Defines the maintenance state of the tenant (Off, UserApps, FullSystem).
Data Type
ENUM: System-2/MaintenanceLevels
Default Values
| Default Value |
|---|
| 0 |
MigrationHistory.BackupId
Identifier of the backup created before migration, if any.
Data Type
STRING
MigrationHistory.CkModelName
Name of the CK model that was migrated (e.g., 'System').
Data Type
STRING
MigrationHistory.DurationMs
Duration of the migration in milliseconds.
Data Type
INT
MigrationHistory.EntitiesAdded
Number of entities added during migration.
Data Type
INT
MigrationHistory.EntitiesAffected
Total number of entities affected by the migration.
Data Type
INT
MigrationHistory.EntitiesDeleted
Number of entities deleted during migration.
Data Type
INT
MigrationHistory.EntitiesUpdated
Number of entities updated during migration.
Data Type
INT
MigrationHistory.Errors
List of error messages if migration failed or had issues.
Data Type
STRING_ARRAY
MigrationHistory.ExecutedAt
Timestamp when the migration was executed.
Data Type
DATE_TIME
MigrationHistory.FromVersion
Source version of the CK model before migration.
Data Type
STRING
MigrationHistory.Success
Indicates whether the migration completed successfully.
Data Type
BOOLEAN
MigrationHistory.ToVersion
Target version of the CK model after migration.
Data Type
STRING
MigrationHistory.Warnings
List of warning messages generated during migration.
Data Type
STRING_ARRAY
Name
Unique identifier name for the entity.
Data Type
STRING
ParentTenantId
Identifier of the parent tenant for hierarchical tenant structures.
Data Type
STRING
PublishCkModelObservability
If true, the platform publishes CK model health for this tenant (library resolve failures, catalog inconsistencies). Defaults to false.
Data Type
BOOLEAN
Default Values
| Default Value |
|---|
| false |
PublishWorkloadObservability
If true, the platform publishes workload state for this tenant - deployment state, online/offline and configuration errors of adapters, pools and applications. Requires communication to be enabled; without it the tenant is skipped silently. Defaults to false.
Data Type
BOOLEAN
Default Values
| Default Value |
|---|
| false |
Query.AttributeSearchFilter
Search filter applied to specific attributes only.
Data Type
RECORD: System-2/AttributeSearchFilter
Query.CkTypeId
The Construction Kit type ID that this query targets.
Data Type
STRING
Query.Columns
Array of attribute paths to include in the query result.
Data Type
STRING_ARRAY
Query.FieldFilter
Array of field filters to apply conditions on specific attributes.
Data Type
Array of RECORD_ARRAY: System-2/FieldFilter
Query.GroupByColumns
Array of attribute paths to group results by in aggregation queries.
Data Type
STRING_ARRAY
Query.NavigationFilterMode
Controls how navigation properties affect the result set.
Data Type
ENUM: System-2/NavigationFilterModes
Default Values
| Default Value |
|---|
| 0 |
Query.Sorting
Array of sort specifications defining the order of query results.
Data Type
Array of RECORD_ARRAY: System-2/SortOrderItem
Query.TextSearchFilter
Full-text search filter applied across searchable fields.
Data Type
RECORD: System-2/TextSearchFilter
Query.Types
Legacy query type selector. Deprecated - use specific query types instead.
Data Type
ENUM: System-2/QueryTypes
Default Values
| Default Value |
|---|
| 0 |
RtBlueprintAppliedAt
Timestamp when the blueprint was applied to create or update this entity.
Data Type
DATE_TIME
RtBlueprintLocked
If true, the entity is managed by the blueprint and will be updated when the blueprint is updated. If false, user modifications are preserved.
Data Type
BOOLEAN
RtBlueprintSource
Identifies the blueprint that created this entity (format: 'BlueprintName-Version'). Null if entity was created manually.
Data Type
STRING
SortOrder
Sort direction for ordering results (Ascending, Descending, Default).
Data Type
ENUM: System-2/SortOrders
StreamDataQuery.ArchiveRtId
Runtime id of the CkArchive (concept §3) this query targets at execution time. Stored as OctoObjectId string.
Data Type
STRING
StreamDataQuery.Columns
Array of attribute paths to project from the archive table.
Data Type
STRING_ARRAY
StreamDataQuery.From
Start of the time window for the stream data query. Can be overridden at execution time.
Data Type
DATE_TIME
StreamDataQuery.Limit
Maximum number of rows to return.
Data Type
INT
StreamDataQuery.RtIds
Optional list of runtime entity IDs to scope the stream data query.
Data Type
STRING_ARRAY
StreamDataQuery.To
End of the time window for the stream data query. Can be overridden at execution time.
Data Type
DATE_TIME
TenantId
Unique identifier for the tenant in the multi-tenant system.
Data Type
STRING
TimeRange
A time range with an inclusive start and exclusive end date (UTC).
Data Type
RECORD: System-2/TimeRange
To
Exclusive end of a TimeRange (UTC).
Data Type
DATE_TIME