EntityGroupExportData.md

EntityGroupExportData

org.thingsboard.client.model.EntityGroupExportData

Extends: EntityExportData

Properties

Name	Type	Description	Notes
permissions	List<GroupPermission>	Group permissions to apply to this group on import. Meaningful only for USER groups; ignored for groups of any other type. Each entry's userGroupId, roleId, and entityGroupId may use the external IDs of other entities in this payload or the IDs of entities that already exist on the target tenant; the importer resolves them against the target tenant. System-tenant roles are not allowed and will be rejected. Leave null to skip permission management for this group.	[optional]
groupOtaPackages	List<DeviceGroupOtaPackage>	OTA package assignments to apply to this group on import. Meaningful only for DEVICE groups; ignored for groups of any other type. Each entry's otaPackageId and groupId may reference external IDs of entities in this payload or IDs of entities that already exist on the target tenant. Leave null to skip OTA assignment management for this group.	[optional]
groupEntities	Boolean	Marker indicating that the group's member entities are intended to be transported alongside this payload. Used by flows that convey members through a side channel (notably the version control flow, which stores members in a separate git index). The solution import API does not consume this flag and does not require it to be set. Safe to leave false (default).	[optional]
memberIds	List<UUID>	External IDs of the entities that should be members of this group after import. Each ID is resolved against the target tenant — by other entity in this payload, by external ID, or by existing internal ID — and the matching entities are added to the group. The import fails if any listed member cannot be resolved. Must be null for the special 'All' group (whose membership is implicit and managed by the platform). Leave null to skip membership wiring; existing membership on the target tenant is left untouched.	[optional]

Referenced Types

EntityId types (AdminSettingsId, AiModelId, AlarmId, ApiKeyId, ApiUsageStateId, AssetId, AssetProfileId, BlobEntityId, CalculatedFieldId, ConverterId, CustomerId, DashboardId, DeviceId, DeviceProfileId, DomainId, EdgeId, EntityGroupId, EntityViewId, GroupPermissionId, IntegrationId, JobId, MobileAppBundleId, MobileAppId, NotificationId, NotificationRequestId, NotificationRuleId, NotificationTargetId, NotificationTemplateId, OAuth2ClientId, OtaPackageId, QueueId, QueueStatsId, ReportId, ReportTemplateId, RoleId, RpcId, RuleChainId, RuleNodeId, SchedulerEventId, SecretId, TbResourceId, TenantId, TenantProfileId, UserId, WidgetTypeId, WidgetsBundleId, etc.): {entityType: EntityType, id: UUID} — all EntityId subtypes share this structure.

EntityExportData

Name	Type	Description	Notes
entity	ExportableEntity		[optional]
relations	List		[optional]
attributes	Map<String, List>	Map of attributes where key is the scope of attributes and value is the list of attributes for that scope	[optional]
calculatedFields	List		[optional]
entityType	EntityType

GroupPermission

Name	Type	Description	Notes
id	GroupPermissionId	JSON object with the Group Permission Id. Specify this field to update the Group Permission. Referencing non-existing Group Permission Id will cause error. Omit this field to create new Group Permission.	[optional]
createdTime	Long	Timestamp of the group permission creation, in milliseconds	[optional] [readonly]
tenantId	TenantId	JSON object with the Tenant Id.	[optional] [readonly]
userGroupId	EntityGroupId	JSON object with the User Group Id. Represents the user group that will have permissions to perform operations against the corresponding entity group.
roleId	RoleId	JSON object with the Role Id. Represents the set of permissions. The role type (GENERIC or GROUP) determines whether 'entityGroupId' is required.
entityGroupId	EntityGroupId	JSON object with the Entity Group Id. Required when using a GROUP role — specifies the entity group to which the permissions apply. Must be null or omitted when using a GENERIC role.	[optional]
entityGroupType	EntityType	Type of the entities in the group: DEVICE, ASSET, CUSTOMER, etc. Auto-populated from the referenced entity group. Null for generic permissions.	[optional] [readonly]
isPublic	Boolean		[optional]
name	String	Name of the Group Permissions. Auto-generated	[optional] [readonly]
_public	Boolean		[optional]

DeviceGroupOtaPackage

Name	Type	Description	Notes
id	UUID		[optional]
groupId	EntityGroupId		[optional]
otaPackageType	OtaPackageType		[optional]
otaPackageId	OtaPackageId		[optional]
otaPackageUpdateTime	Long		[optional]

ExportableEntity

Name	Type	Description	Notes
createdTime	Long		[optional]
id	EntityId		[optional]
name	String		[optional]
tenantId	TenantId		[optional]

EntityRelation

Name	Type	Description	Notes
from	EntityId	JSON object with [from] Entity Id.
to	EntityId	JSON object with [to] Entity Id.
type	String	String value of relation type.
typeGroup	RelationTypeGroup	Represents the type group of the relation.
version	Long		[optional]
additionalInfo	com.fasterxml.jackson.databind.JsonNode	Additional parameters of the relation.	[optional]

AttributeExportData

Name	Type	Description	Notes
key	String		[optional]
lastUpdateTs	Long		[optional]
booleanValue	Boolean		[optional]
strValue	String		[optional]
longValue	Long		[optional]
doubleValue	Double		[optional]
jsonValue	String		[optional]

CalculatedField

Name	Type	Description	Notes
id	CalculatedFieldId	JSON object with the Calculated Field Id. Referencing non-existing Calculated Field Id will cause error.	[optional]
createdTime	Long	Timestamp of the calculated field creation, in milliseconds	[optional] [readonly]
tenantId	TenantId		[optional]
entityId	EntityId		[optional]
type	CalculatedFieldType		[optional]
name	String	User defined name of the calculated field.	[optional]
debugSettings	DebugSettings	Debug settings object.	[optional]
configurationVersion	Integer	Version of calculated field configuration.	[optional]
_configuration	CalculatedFieldConfiguration
version	Long		[optional]
additionalInfo	com.fasterxml.jackson.databind.JsonNode	Additional parameters of the calculated field	[optional]
debugMode	Boolean		[optional]

EntityType (enum)

TENANT | CUSTOMER | USER | DASHBOARD | ASSET | DEVICE | ALARM | ENTITY_GROUP | CONVERTER | INTEGRATION | … (46 values total)

OtaPackageType (enum)

FIRMWARE | SOFTWARE

RelationTypeGroup (enum)

COMMON | DASHBOARD | FROM_ENTITY_GROUP | RULE_CHAIN | RULE_NODE | EDGE | EDGE_AUTO_ASSIGN_RULE_CHAIN

CalculatedFieldType (enum)

SIMPLE | SCRIPT | GEOFENCING | ALARM | PROPAGATION | RELATED_ENTITIES_AGGREGATION | ENTITY_AGGREGATION

DebugSettings

Name	Type	Description	Notes
failuresEnabled	Boolean	Debug failures.	[optional]
allEnabled	Boolean	Debug All. Used as a trigger for updating debugAllUntil.	[optional]
allEnabledUntil	Long	Timestamp of the end time for the processing debug events.	[optional]

CalculatedFieldConfiguration

Name	Type	Description	Notes
output	Output		[optional]
type	String

AlarmCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=ALARM)

Name	Type	Description	Notes
arguments	Map<String, Argument>
createRules	Map<String, AlarmRule>
clearRule	AlarmRule		[optional]
propagate	Boolean		[optional]
propagateToOwner	Boolean		[optional]
propagateToOwnerHierarchy	Boolean		[optional]
propagateToTenant	Boolean		[optional]
propagateRelationTypes	List		[optional]

EntityAggregationCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=ENTITY_AGGREGATION)

Name	Type	Description	Notes
arguments	Map<String, Argument>
metrics	Map<String, AggMetric>
interval	AggInterval
watermark	Watermark		[optional]
produceIntermediateResult	Boolean		[optional]

GeofencingCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=GEOFENCING)

Name	Type	Description	Notes
entityCoordinates	EntityCoordinates
zoneGroups	Map<String, ZoneGroupConfiguration>
scheduledUpdateEnabled	Boolean		[optional]
scheduledUpdateInterval	Integer		[optional]

PropagationCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=PROPAGATION)

Name	Type	Description	Notes
arguments	Map<String, Argument>
expression	String		[optional]
relation	RelationPathLevel
applyExpressionToResolvedArguments	Boolean		[optional]

RelatedEntitiesAggregationCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=RELATED_ENTITIES_AGGREGATION)

Name	Type	Description	Notes
relation	RelationPathLevel
arguments	Map<String, Argument>
deduplicationIntervalInSec	Long		[optional]
metrics	Map<String, AggMetric>
useLatestTs	Boolean		[optional]
scheduledUpdateInterval	Integer		[optional]
scheduledUpdateEnabled	Boolean		[optional]

ScriptCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=SCRIPT)

Name	Type	Description	Notes
arguments	Map<String, Argument>
expression	String		[optional]

SimpleCalculatedFieldConfiguration (extends CalculatedFieldConfiguration, type=SIMPLE)

Name	Type	Description	Notes
arguments	Map<String, Argument>
expression	String		[optional]
useLatestTs	Boolean		[optional]

Output

Name	Type	Description	Notes
decimalsByDefault	Integer		[optional]
name	String		[optional]
scope	AttributeScope		[optional]
strategy	Object		[optional]
type	String

AttributesOutput (extends Output, type=ATTRIBUTES)

Name	Type	Description	Notes
strategy	AttributesOutputStrategy		[optional]

TimeSeriesOutput (extends Output, type=TIME_SERIES)

Name	Type	Description	Notes
strategy	TimeSeriesOutputStrategy		[optional]

AttributeScope (enum)

CLIENT_SCOPE | SERVER_SCOPE | SHARED_SCOPE

Argument

Name	Type	Description	Notes
refEntityId	EntityId		[optional]
refDynamicSourceConfiguration	CfArgumentDynamicSourceConfiguration		[optional]
refEntityKey	ReferencedEntityKey		[optional]
defaultValue	String		[optional]
limit	Integer		[optional]
timeWindow	Long		[optional]

EntityCoordinates

Name	Type	Description	Notes
latitudeKeyName	String
longitudeKeyName	String

ZoneGroupConfiguration

Name	Type	Description	Notes
refEntityId	EntityId		[optional]
refDynamicSourceConfiguration	CfArgumentDynamicSourceConfiguration		[optional]
perimeterKeyName	String
reportStrategy	GeofencingReportStrategy
createRelationsWithMatchedZones	Boolean		[optional]
relationType	String		[optional]
direction	EntitySearchDirection		[optional]

AlarmRule

Name	Type	Description	Notes
condition	AlarmCondition
alarmDetails	String		[optional]
dashboardId	DashboardId		[optional]

RelationPathLevel

Name	Type	Description	Notes
direction	EntitySearchDirection
relationType	String

AggMetric

Name	Type	Description	Notes
function	AggFunction		[optional]
filter	String		[optional]
input	AggInput		[optional]
defaultValue	Double		[optional]

AggInterval

Name	Type	Description	Notes
type	String

CustomInterval (extends AggInterval, type=CUSTOM)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]
durationSec	Long

DayInterval (extends AggInterval, type=DAY)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

HourInterval (extends AggInterval, type=HOUR)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

MonthInterval (extends AggInterval, type=MONTH)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

QuarterInterval (extends AggInterval, type=QUARTER)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

WeekInterval (extends AggInterval, type=WEEK)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

WeekSunSatInterval (extends AggInterval, type=WEEK_SUN_SAT)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

YearInterval (extends AggInterval, type=YEAR)

Name	Type	Description	Notes
tz	String
offsetSec	Long		[optional]

Watermark

Name	Type	Description	Notes
duration	Long		[optional]

TimeSeriesOutputStrategy

Name	Type	Description	Notes
type	String

TimeSeriesImmediateOutputStrategy (extends TimeSeriesOutputStrategy, type=IMMEDIATE)

Name	Type	Description	Notes
ttl	Long		[optional]
saveTimeSeries	Boolean		[optional]
saveLatest	Boolean		[optional]
sendWsUpdate	Boolean		[optional]
processCfs	Boolean		[optional]

TimeSeriesRuleChainOutputStrategy (extends TimeSeriesOutputStrategy, type=RULE_CHAIN)

See TimeSeriesOutputStrategy for properties.

AttributesOutputStrategy

Name	Type	Description	Notes
type	String

AttributesImmediateOutputStrategy (extends AttributesOutputStrategy, type=IMMEDIATE)

Name	Type	Description	Notes
sendAttributesUpdatedNotification	Boolean		[optional]
updateAttributesOnlyOnValueChange	Boolean		[optional]
saveAttribute	Boolean		[optional]
sendWsUpdate	Boolean		[optional]
processCfs	Boolean		[optional]

AttributesRuleChainOutputStrategy (extends AttributesOutputStrategy, type=RULE_CHAIN)

See AttributesOutputStrategy for properties.

CfArgumentDynamicSourceConfiguration

Name	Type	Description	Notes
type	String

CurrentOwnerDynamicSourceConfiguration (extends CfArgumentDynamicSourceConfiguration, type=CURRENT_OWNER)

See CfArgumentDynamicSourceConfiguration for properties.

RelationPathQueryDynamicSourceConfiguration (extends CfArgumentDynamicSourceConfiguration, type=RELATION_PATH_QUERY)

Name	Type	Description	Notes
levels	List		[optional]

ReferencedEntityKey

Name	Type	Description	Notes
key	String		[optional]
type	ArgumentType		[optional]
scope	AttributeScope		[optional]

GeofencingReportStrategy (enum)

REPORT_TRANSITION_EVENTS_ONLY | REPORT_PRESENCE_STATUS_ONLY | REPORT_TRANSITION_EVENTS_AND_PRESENCE_STATUS

EntitySearchDirection (enum)

FROM | TO

AlarmCondition

Name	Type	Description	Notes
expression	AlarmConditionExpression
schedule	AlarmConditionValueAlarmSchedule		[optional]
type	String

DurationAlarmCondition (extends AlarmCondition, type=DURATION)

Name	Type	Description	Notes
unit	TimeUnit
value	AlarmConditionValueLong

RepeatingAlarmCondition (extends AlarmCondition, type=REPEATING)

Name	Type	Description	Notes
count	AlarmConditionValueInteger

SimpleAlarmCondition (extends AlarmCondition, type=SIMPLE)

See AlarmCondition for properties.

AggFunction (enum)

MIN | MAX | SUM | AVG | COUNT | COUNT_UNIQUE

AggInput

Name	Type	Description	Notes
type	String

AggFunctionInput (extends AggInput, type=function)

Name	Type	Description	Notes
function	String		[optional]

AggKeyInput (extends AggInput, type=key)

Name	Type	Description	Notes
key	String		[optional]

ArgumentType (enum)

TS_LATEST | ATTRIBUTE | TS_ROLLING

AlarmConditionExpression

Name	Type	Description	Notes
type	String

SimpleAlarmConditionExpression (extends AlarmConditionExpression, type=SIMPLE)

Name	Type	Description	Notes
filters	List
operation	AlarmRuleComplexOperation		[optional]

TbelAlarmConditionExpression (extends AlarmConditionExpression, type=TBEL)

Name	Type	Description	Notes
expression	String

AlarmConditionValueAlarmSchedule

Name	Type	Description	Notes
staticValue	AlarmSchedule		[optional]
dynamicValueArgument	String		[optional]

AlarmSchedule

Name	Type	Description	Notes
type	String

AnyTimeSchedule (extends AlarmSchedule, type=ANY_TIME)

See AlarmSchedule for properties.

CustomTimeSchedule (extends AlarmSchedule, type=CUSTOM)

Name	Type	Description	Notes
timezone	String		[optional]
items	List		[optional]

SpecificTimeSchedule (extends AlarmSchedule, type=SPECIFIC_TIME)

Name	Type	Description	Notes
timezone	String		[optional]
daysOfWeek	Set		[optional]
startsOn	Long		[optional]
endsOn	Long		[optional]

TimeUnit (enum)

NANOSECONDS | MICROSECONDS | MILLISECONDS | SECONDS | MINUTES | HOURS | DAYS

AlarmConditionValueLong

Name	Type	Description	Notes
staticValue	Long		[optional]
dynamicValueArgument	String		[optional]

AlarmConditionValueInteger

Name	Type	Description	Notes
staticValue	Integer		[optional]
dynamicValueArgument	String		[optional]

AlarmConditionFilter

Name	Type	Description	Notes
argument	String
valueType	EntityKeyValueType
operation	AlarmRuleComplexOperation		[optional]
predicates	List

AlarmRuleComplexOperation (enum)

AND | OR

EntityKeyValueType (enum)

STRING | NUMERIC | BOOLEAN | DATE_TIME

AlarmRuleKeyFilterPredicate

Name	Type	Description	Notes
type	String

AlarmRuleBooleanFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=BOOLEAN)

Name	Type	Description	Notes
operation	AlarmRuleBooleanOperation
value	AlarmConditionValueBoolean

AlarmRuleComplexFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=COMPLEX)

Name	Type	Description	Notes
operation	AlarmRuleComplexOperation		[optional]
predicates	List		[optional]

NoDataFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=NO_DATA)

Name	Type	Description	Notes
unit	TimeUnit
duration	AlarmConditionValueLong

AlarmRuleNumericFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=NUMERIC)

Name	Type	Description	Notes
operation	AlarmRuleNumericOperation
value	AlarmConditionValueDouble

AlarmRuleStringFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=STRING)

Name	Type	Description	Notes
operation	AlarmRuleStringOperation
value	AlarmConditionValueString
ignoreCase	Boolean		[optional]

CustomTimeScheduleItem

Name	Type	Description	Notes
enabled	Boolean		[optional]
dayOfWeek	Integer		[optional]
startsOn	Long		[optional]
endsOn	Long		[optional]

AlarmRuleStringOperation (enum)

EQUAL | NOT_EQUAL | STARTS_WITH | ENDS_WITH | CONTAINS | NOT_CONTAINS | IN | NOT_IN

AlarmConditionValueString

Name	Type	Description	Notes
staticValue	String		[optional]
dynamicValueArgument	String		[optional]

AlarmRuleNumericOperation (enum)

EQUAL | NOT_EQUAL | GREATER | LESS | GREATER_OR_EQUAL | LESS_OR_EQUAL

AlarmConditionValueDouble

Name	Type	Description	Notes
staticValue	Double		[optional]
dynamicValueArgument	String		[optional]

AlarmRuleBooleanOperation (enum)

EQUAL | NOT_EQUAL

AlarmConditionValueBoolean

Name	Type	Description	Notes
staticValue	Boolean		[optional]
dynamicValueArgument	String		[optional]

---

Conventions

• Package: org.thingsboard.client.model
• Getter pattern: get<PropertyName>() — e.g., getId(), getName()
• Setter pattern: set<PropertyName>(value) — e.g., setId(value), setName(value)
• Null fields: Getters return null for unset optional fields; they do not throw exceptions