A Business Label is a custom tag representing any business concept.
Attributes
| Name | Type | Description |
|---|---|---|
| label_id | uuid.UUID | technical identifier. |
| name | str | display name. |
| description | str | description of the label. |
| icon | str | identifier of Wizata icon. |
| color | str | hexadecimal color code. |
| order | int | integer value used to order the labels on the side navigation. |
| createdById | uuid.UUID | unique identifier of creating user. |
| createdDate | int | timestamp of created date. |
| updatedById | uuid.UUID | unique identifier of updating user. |
| updatedDate | int | timestamp of updated date. |
Methods
api_id()
formatted id of the business label (label_id)
return: string formatted UUID.
endpoint()
endpoint name used to manipulate business label on backend.
return: endpoint name.
from_json()
convert the business label to a dictionary compatible with JSON format.
| Name | Type | Default | Description |
|---|---|---|---|
| obj |
return: dictionary representation of the business label object.
set_id()
specify the id_value neutrally
| Name | Type | Default | Description |
|---|---|---|---|
| id_value |
return:
to_json()
load the business label entity from a dictionary.
| Name | Type | Default | Description |
|---|---|---|---|
| target | str | None |