Skip to content

AlarmDataPageLink.md

Latest commit

 

History

History
66 lines (47 loc) · 2.84 KB

AlarmDataPageLink.md

File metadata and controls

66 lines (47 loc) · 2.84 KB

AlarmDataPageLink

tb_ce_client.models.AlarmDataPageLink

Properties

Name Type Description Notes
page_size int [optional]
page int [optional]
text_search str [optional]
sort_order EntityDataSortOrder [optional]
dynamic bool [optional]
start_ts int [optional]
end_ts int [optional]
time_window int [optional]
type_list List[str] [optional]
status_list List[AlarmSearchStatus] [optional]
severity_list List[AlarmSeverity] [optional]
search_propagated_alarms bool [optional]
assignee_id UserId [optional]

Referenced Types

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

EntityDataSortOrder

Name Type Description Notes
key EntityKey [optional]
direction Direction [optional]

AlarmSearchStatus (enum)

ANY | ACTIVE | CLEARED | ACK | UNACK

AlarmSeverity (enum)

CRITICAL | MAJOR | MINOR | WARNING | INDETERMINATE

EntityKey

Name Type Description Notes
type EntityKeyType [optional]
key str [optional]

Direction (enum)

ASC | DESC

EntityKeyType (enum)

ATTRIBUTE | CLIENT_ATTRIBUTE | SHARED_ATTRIBUTE | SERVER_ATTRIBUTE | TIME_SERIES | ENTITY_FIELD | ALARM_FIELD

EntityType (enum)

TENANT | CUSTOMER | USER | DASHBOARD | ASSET | DEVICE | ALARM | RULE_CHAIN | RULE_NODE | ENTITY_VIEW | … (36 values total)

Conventions

  • Package: tb_ce_client.models
  • Attribute access: obj.page_size, obj.name, etc.
  • Serialize: obj.model_dump() or obj.model_dump(by_alias=True) for camelCase JSON
  • Deserialize: AlarmDataPageLink.model_validate(data) or AlarmDataPageLink.model_validate_json(json_str)
  • None fields: Optional attributes default to None; accessing them never raises exceptions