ContextType

trendminer_interface.objects.ContextType

Configuration of a context type

Attributes:

Name	Type	Description
name	str	Name that is visible to the users in the appliance
description	(str, optional)	Description of the context type
workflow	(ContextWorkflow, optional)	Workflow associated with the context type. When None, the context type can only have a single associated timestamp.
fields	list of ContextField	List of fields that are associated with the context type.
color	str	Color of the context type in hex format (e.g. "#FF0000")
icon	ContextTypeIcon	Icon of the context type. See ContextTypeIcon for the allowed values.
approvals_enabled	bool	Whether context items of this type can be approved.
audit_trail_enabled	bool	Whether context item edit history will be saved as metadata to the item.

name class-attribute instance-attribute

name: str = name

workflow class-attribute instance-attribute

workflow: ContextWorkflow | None = workflow

fields class-attribute instance-attribute

fields: list[ContextField] = fields

color class-attribute instance-attribute

color: str = color

icon class-attribute instance-attribute

icon: ContextTypeIcon = icon

description class-attribute instance-attribute

description: str | None = description

approvals_enabled class-attribute instance-attribute

approvals_enabled: bool = approvals_enabled

audit_trail_enabled class-attribute instance-attribute

audit_trail_enabled: bool = audit_trail_enabled

key property

key: str

Unique key that is used as the identifier of the context type

update

update() -> ContextType

Update the appliance context type to the current instance configuration

Returns:

Type	Description
ContextType	Updated context type

delete

delete() -> None

Permanently delete the context type