Skip to content

AssetInfo.md

Latest commit

 

History

History
42 lines (29 loc) · 2.8 KB

AssetInfo.md

File metadata and controls

42 lines (29 loc) · 2.8 KB

AssetInfo

tb_ce_client.models.AssetInfo

Properties

Name Type Description Notes
id AssetId JSON object with the asset Id. Specify this field to update the asset. Referencing non-existing asset Id will cause error. Omit this field to create new asset. [optional]
created_time int Timestamp of the asset creation, in milliseconds [optional] [readonly]
additional_info object Additional parameters of the asset. May include: 'description' (string). [optional]
tenant_id TenantId JSON object with Tenant Id. [optional] [readonly]
customer_id CustomerId JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. [optional] [readonly]
name str Unique Asset Name in scope of Tenant
type str Asset type [optional]
label str Label that may be used in widgets [optional]
asset_profile_id AssetProfileId JSON object with Asset Profile Id. [optional]
version int [optional]
customer_title str Title of the Customer that owns the asset. [optional] [readonly]
customer_is_public bool Indicates special 'Public' Customer that is auto-generated to use the assets on public dashboards. [optional] [readonly]
asset_profile_name str Name of the corresponding Asset Profile. [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.

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