Skip to content

AlarmComment.md

Latest commit

 

History

History
44 lines (29 loc) · 2.46 KB

AlarmComment.md

File metadata and controls

44 lines (29 loc) · 2.46 KB

AlarmComment

tb_ce_client.models.AlarmComment

Properties

Name Type Description Notes
id AlarmCommentId JSON object with the alarm comment Id. Specify this field to update the alarm comment. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. [optional]
created_time int Timestamp of the alarm comment creation, in milliseconds [optional] [readonly]
alarm_id AlarmId JSON object with Alarm id. [optional] [readonly]
user_id UserId JSON object with User id. [optional] [readonly]
type AlarmCommentType Defines origination of comment. System type means comment was created by TB. OTHER type means comment was created by user. [optional]
comment object JSON object with text of comment. [optional]
name str representing comment text [optional] [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.

AlarmCommentId

Name Type Description Notes
id UUID string

AlarmCommentType (enum)

SYSTEM | OTHER

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: AlarmComment.model_validate(data) or AlarmComment.model_validate_json(json_str)
  • None fields: Optional attributes default to None; accessing them never raises exceptions