Skip to main content

Types

Version: 2.5.0

AggregationRtQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/AggregationRtQuery-1

Query type for performing aggregation operations (Count, Min, Max, Avg, Sum) on entity data without grouping.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/AggregationQueryColumnsFalse
System-2/Query.FieldFilterTrue
System-2/Query.TextSearchFilterTrue
System-2/Query.AttributeSearchFilterTrue

AggregationSdQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/StreamDataQuery-1 ➔ System-2.5.0/AggregationSdQuery-1

Persistent stream-data query that performs aggregation operations (Count, Min, Max, Avg, Sum) on time-series data without grouping.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/AggregationQueryColumnsFalse

AutoIncrement​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/AutoIncrement-1

Manages auto-incrementing sequences for generating unique identifiers with configurable format and range.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/AutoIncrement.EndFalse
System-2/AutoIncrement.FormatTrue
System-2/AutoIncrement.CurrentValueFalse

BlueprintBackup​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/BlueprintBackup-1

Snapshot of seed entities captured immediately before a blueprint apply, used to support rollback.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/BlueprintBackup.BlueprintNameFalse
System-2/BlueprintBackup.BlueprintVersionFalse
System-2/BlueprintBackup.CreatedAtFalse
System-2/BlueprintBackup.SnapshotJsonFalse

BlueprintHistory​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/BlueprintHistory-1

Append-only audit log of blueprint apply operations in the tenant. One entity per apply (install, update, rollback, re-apply).

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/BlueprintHistory.BlueprintNameFalse
System-2/BlueprintHistory.BlueprintVersionFalse
System-2/BlueprintHistory.AppliedAtFalse
System-2/BlueprintHistory.ApplicationModeFalse
System-2/BlueprintHistory.PreviousBlueprintNameTrue
System-2/BlueprintHistory.PreviousVersionTrue
System-2/BlueprintHistory.EntitiesCreatedFalse
System-2/BlueprintHistory.EntitiesUpdatedFalse
System-2/BlueprintHistory.EntitiesDeletedFalse
System-2/BlueprintHistory.SeedDataChecksumTrue

BlueprintInstallation​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/BlueprintInstallation-1

Records a blueprint that is currently installed in the tenant. One entity per installed blueprint; replaced on update or re-apply, removed on uninstall.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/BlueprintInstallation.BlueprintNameFalse
System-2/BlueprintInstallation.BlueprintVersionFalse
System-2/BlueprintInstallation.InstalledAtFalse
System-2/BlueprintInstallation.LastUpdatedAtFalse
System-2/BlueprintInstallation.SeedDataChecksumTrue
System-2/BlueprintInstallation.IsDependencyFalse
System-2/BlueprintInstallation.ResolvedDependenciesTrue

Configuration​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1

Base type for all configuration types

DownsamplingSdQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/StreamDataQuery-1 ➔ System-2.5.0/DownsamplingSdQuery-1

Persistent stream-data query that downsamples time-series data using DATE_BIN bucketing with per-column aggregation (AVG, MIN, MAX). From, To, and Limit (bucket count) are required at the API level even though the schema marks them optional on the base.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/AggregationQueryColumnsFalse

Entity​

Inheritance: System-2.5.0/Entity-1

Abstract base type for all entities in the system. Provides common indexing and association capabilities.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/RtBlueprintSourceTrue
System-2/RtBlueprintLockedTrue
System-2/RtBlueprintAppliedAtTrue

Outbound Associations​

Outbound NameOutbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
RelatesToNSystem-2/RelatedSystem-2/Entity

Inbound Associations​

Inbound NameInbound MultiplicityCkRoleIdTargetCKTypeIdTarget Attributes
RelatesFromNSystem-2/RelatedSystem-2/Entity

GroupingAggregationRtQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/GroupingAggregationRtQuery-1

Query type for performing grouped aggregation operations with GROUP BY functionality on entity data.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/Query.GroupByColumnsFalse
System-2/AggregationQueryColumnsFalse
System-2/Query.FieldFilterTrue
System-2/Query.TextSearchFilterTrue
System-2/Query.AttributeSearchFilterTrue

GroupingAggregationSdQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/StreamDataQuery-1 ➔ System-2.5.0/GroupingAggregationSdQuery-1

Persistent stream-data query that performs grouped aggregation with GROUP BY functionality on time-series data.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/Query.GroupByColumnsFalse
System-2/AggregationQueryColumnsFalse

MigrationHistory​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/MigrationHistory-1

Records executed CK model migrations per tenant. Each instance represents one migration execution from a source version to a target version.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/MigrationHistory.CkModelNameFalse
System-2/MigrationHistory.FromVersionFalse
System-2/MigrationHistory.ToVersionFalse
System-2/MigrationHistory.ExecutedAtFalse
System-2/MigrationHistory.SuccessFalse
System-2/MigrationHistory.EntitiesAffectedTrue
System-2/MigrationHistory.EntitiesAddedTrue
System-2/MigrationHistory.EntitiesUpdatedTrue
System-2/MigrationHistory.EntitiesDeletedTrue
System-2/MigrationHistory.DurationMsTrue
System-2/MigrationHistory.ErrorsTrue
System-2/MigrationHistory.WarningsTrue
System-2/MigrationHistory.BackupIdTrue

PersistentQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1

Abstract base type for all query types. Defines common query properties like name, description, and target type.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/NameFalse
System-2/DescriptionTrue
System-2/Query.CkTypeIdFalse
System-2/Query.NavigationFilterModeTrue

SimpleRtQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/SimpleRtQuery-1

Query type for retrieving rows/tuples from entities with support for column selection, sorting, and filtering.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/Query.ColumnsFalse
System-2/Query.SortingTrue
System-2/Query.FieldFilterTrue
System-2/Query.TextSearchFilterTrue
System-2/Query.AttributeSearchFilterTrue

SimpleSdQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/StreamDataQuery-1 ➔ System-2.5.0/SimpleSdQuery-1

Persistent stream-data query that retrieves time-series rows for a given CK type with optional column projection, sorting, and field filters.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/StreamDataQuery.ColumnsFalse
System-2/Query.SortingTrue

StreamDataQuery​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/PersistentQuery-1 ➔ System-2.5.0/StreamDataQuery-1

Abstract base for stream-data query types. Carries the common time-range, limit, rtId scope, archive reference, and field-filter attributes shared by all concrete SdQuery subtypes.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/StreamDataQuery.ArchiveRtIdTrue
System-2/StreamDataQuery.RtIdsTrue
System-2/StreamDataQuery.FromTrue
System-2/StreamDataQuery.ToTrue
System-2/StreamDataQuery.LimitTrue
System-2/Query.FieldFilterTrue

Tenant​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Tenant-1

Represents a tenant in the multi-tenant system with its unique identifier, parent relationship, and database mapping.

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/TenantIdFalse
System-2/ParentTenantIdTrue
System-2/DatabaseNameFalse

TenantConfiguration​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System-2.5.0/TenantConfiguration-1

Configuration for a tenant regarding data version of schema or identity data

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/ConfigurationValueTrue

TenantModeConfiguration​

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System-2.5.0/TenantModeConfiguration-1

Configuration for a tenant if the tenant is in a specific mode, e.g. test mode or maintenance mode

IDAuto Complete ValuesAuto Increment ReferenceIs Optional
System-2/EnvironmentModeFalse
System-2/MaintenanceLevelFalse
System-2/PublishCkModelObservabilityTrue
System-2/PublishWorkloadObservabilityTrue