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
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
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
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.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
TenantId
Unique identifier for the tenant in the multi-tenant system.
Data Type
STRING