Skip to content

AlarmData.md

Latest commit

 

History

History
71 lines (55 loc) · 4.68 KB

AlarmData.md

File metadata and controls

71 lines (55 loc) · 4.68 KB

AlarmData

tb_ce_client.models.AlarmData

Properties

Name Type Description Notes
id AlarmId JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. [optional]
created_time int Timestamp of the alarm creation, in milliseconds [optional] [readonly]
tenant_id TenantId JSON object with Tenant Id [optional] [readonly]
customer_id CustomerId JSON object with Customer Id [optional] [readonly]
type str representing type of the Alarm
originator EntityId JSON object with alarm originator id
severity AlarmSeverity Alarm severity
acknowledged bool Acknowledged
cleared bool Cleared
assignee_id UserId Alarm assignee user id [optional]
start_ts int Timestamp of the alarm start time, in milliseconds [optional]
end_ts int Timestamp of the alarm end time(last time update), in milliseconds [optional]
ack_ts int Timestamp of the alarm acknowledgement, in milliseconds [optional]
clear_ts int Timestamp of the alarm clearing, in milliseconds [optional]
assign_ts int Timestamp of the alarm assignment, in milliseconds [optional]
details object JSON object with alarm details [optional]
propagate bool Propagation flag to specify if alarm should be propagated to parent entities of alarm originator [optional]
propagate_to_owner bool Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator [optional]
propagate_to_tenant bool Propagation flag to specify if alarm should be propagated to the tenant entity [optional]
propagate_relation_types List[str] JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. [optional]
originator_name str Alarm originator name [optional]
originator_label str Alarm originator label [optional]
originator_display_name str Originator display name [optional]
assignee AlarmAssignee Alarm assignee [optional]
entity_id EntityId [optional]
latest Dict[str, Dict[str, TsValue]] [optional]
name str representing type of the Alarm [readonly]
status AlarmStatus status of the Alarm [readonly]

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.

AlarmSeverity (enum)

CRITICAL | MAJOR | MINOR | WARNING | INDETERMINATE

AlarmAssignee

Name Type Description Notes
id UserId [optional]
first_name str [optional]
last_name str [optional]
email str [optional]

AlarmStatus (enum)

ACTIVE_UNACK | ACTIVE_ACK | CLEARED_UNACK | CLEARED_ACK

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.id, obj.name, etc.
  • Serialize: obj.model_dump() or obj.model_dump(by_alias=True) for camelCase JSON
  • Deserialize: AlarmData.model_validate(data) or AlarmData.model_validate_json(json_str)
  • None fields: Optional attributes default to None; accessing them never raises exceptions