ObjectTemplateAttribute
class flow_api.object_template_attribute.ObjectTemplateAttribute
(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, datatype=[class 'flow_api.system.NotSet'], description=[class 'flow_api.system.NotSet'], is_hidden=[class 'flow_api.system.NotSet'], is_nullable=[class 'flow_api.system.NotSet'], is_unique=[class 'flow_api.system.NotSet'], name=[class 'flow_api.system.NotSet'], object_template_id=[class 'flow_api.system.NotSet'], reference_object_template_id=[class 'flow_api.system.NotSet'], reference_record_type=[class 'flow_api.system.NotSet'], silent_update=[class 'flow_api.system.NotSet'], debug=False
)
Base class: Row
A definition of an attribute of an object_template.
Behaves similarly to database column with properties like datatype, nullability, uniqueness.
Parameters
Name | Type | Description |
---|---|---|
allow_deleted | bool | |
allow_normal | bool | |
by | str | |
cls | typing.Union[ type, NoneType ] | |
datatype | typing.Union[ flow_api.system.NotSet, str ] | The datatype of the attribute. |
debug | bool | if set, the content of the data being written will be logged. |
description | typing.Union[ flow_api.system.NotSet, str ] | A description of attribute. |
init | typing.Union[ dict, NoneType ] | |
is_hidden | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if attribute should be hidden in the "more" section of the form. |
is_nullable | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if the attribute can be NULL. Attributes which cannot be set to NULL are required. |
is_unique | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if attribute values must be unique. |
name | typing.Union[ flow_api.system.NotSet, str ] | The name of the attribute. |
object_template_id | typing.Union[ flow_api.system.NotSet, str ] | Reference to the object_template this object_template_attribute is associated with. |
reference_object_template_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The object template the attribute is referencing. Only valid when datatype is OBJECT_TEMPLATE_REFERENCE . |
reference_record_type | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The record type the attribute is referencing. Only valid when datatype is RECORD_REFERENCE . |
select | typing.Union[ str, NoneType ] | |
silent_update | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if a change to this attribute should trigger the on-update provisioning execution. |