Skip to content

DeviceCustomProperty

armis_sdk.entities.device_custom_property.DeviceCustomProperty

Bases: BaseEntity

Attributes:

Name Type Description
id int | None

The id of the property.

name str

The name of the property.

description str | None

The description of the property.

type Literal['boolean', 'enum', 'externalLink', 'integer', 'string', 'timestamp']

The type of the property.

allowed_values list[str] | None

The allowed values of the property when the 'type' is 'enum'.

created_by str | None

Who / what created the property.

creation_time datetime | None

The creation time of the property.

id = None class-attribute instance-attribute

The id of the property.

name = Field(max_length=40, pattern='^[\\w_]*$') class-attribute instance-attribute

The name of the property.

Example: Size

description = Field(max_length=250, default=None) class-attribute instance-attribute

The description of the property.

Example: The size of the device

type instance-attribute

The type of the property.

Example: enum

allowed_values = None class-attribute instance-attribute

The allowed values of the property when the 'type' is 'enum'.

Example: ["s", "m", "l"]

created_by = Field(max_length=50, default=None) class-attribute instance-attribute

Who / what created the property.

creation_time = Field(strict=False, default=None) class-attribute instance-attribute

The creation time of the property.