page_title	subcategory	description
epilot-schema_schema_capability Resource - terraform-provider-epilot-schema		SchemaCapability Resource

epilot-schema_schema_capability (Resource)

SchemaCapability Resource

Example Usage

resource "epilot-schema_schema_capability" "my_schemacapability" {
  feature_flag = "FF_MY_FEATURE_FLAG"
  id           = "d5839b94-ba20-4225-a78e-76951d352bd6"
  name         = "customer_messaging"
  schema       = "contact"
  title        = "Messaging"
}

Schema

Required

name (String) Unique name for the capability

Optional

attributes (Attributes List) (see below for nested schema)
feature_flag (String) This capability should only be active when the feature flag is enabled
id (String) ID for the entity capability
manifest (List of String) Manifest ID used to create/update the schema capabilility
purpose (List of String)
schema (String) Schema slug the capability belongs to
settings_flag (Attributes List) This capability should only be active when all the settings have the correct value (see below for nested schema)
title (String) Human readable title of the capability
ui_hooks (Attributes List) (see below for nested schema)

Read-Only

composite_id (String) Schema Slug and the Attribute ID

Nested Schema for `attributes`

Optional:

address_attribute (Attributes) Address attribute (see below for nested schema)
address_relation_attribute (Attributes) Reference to an address attribute of another entity (see below for nested schema)
automation_attribute (Attributes) Automation entity (see below for nested schema)
boolean_attribute (Attributes) Yes / No Toggle (see below for nested schema)
computed_attribute (Attributes) An attribute that is computed from the entity data. For more details on how to use them, check the docs here (see below for nested schema)
consent_attribute (Attributes) Consent Management (see below for nested schema)
country_attribute (Attributes) Country picker (see below for nested schema)
currency_attribute (Attributes) Currency input (see below for nested schema)
date_attribute (Attributes) Date or Datetime picker (see below for nested schema)
file_attribute (Attributes) File or Image Attachment (see below for nested schema)
internal_attribute (Attributes) No UI representation (see below for nested schema)
internal_user_attribute (Attributes) Epilot internal user info (see below for nested schema)
invitation_email_attribute (Attributes) Email address for send invitation (see below for nested schema)
link_attribute (Attributes) Link with title and href (see below for nested schema)
message_email_address_attribute (Attributes) Message emil address (see below for nested schema)
multi_select_attribute (Attributes) Multi Choice Selection (see below for nested schema)
number_attribute (Attributes) Numeric input (see below for nested schema)
ordered_list_attribute (Attributes) Type of attribute to render N number of ordered fields (see below for nested schema)
partner_organisation_attribute (Attributes) Shared Partner Organisations (see below for nested schema)
partner_status_attribute (Attributes) Partner Status (see below for nested schema)
payment_method_relation_attribute (Attributes) Reference to a payment method attribute of another entity (see below for nested schema)
purpose_attribute (Attributes) Entity Taxonomy (see below for nested schema)
relation_attribute (Attributes) Entity Relationship (see below for nested schema)
repeatable_attribute (Attributes) Repeatable (add N number of fields) (see below for nested schema)
select_attribute (Attributes) Dropdown select (see below for nested schema)
sequence_attribute (Attributes) Sequence of unique identifiers (see below for nested schema)
status_attribute (Attributes) Status select (see below for nested schema)
tags_attribute (Attributes) Tags (see below for nested schema)
text_attribute (Attributes) Textarea or text input (see below for nested schema)
user_relation_attribute (Attributes) User Relationship (see below for nested schema)

Nested Schema for `attributes.address_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_address_fields (List of String) Default fields visible on addresses
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["address"]
value_formatter (String)

Nested Schema for `attributes.address_attribute.constraints`

Nested Schema for `attributes.address_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.address_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.address_relation_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_address_fields (List of String) Default fields visible on addresses
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
has_primary (Boolean)
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["relation_address"]
value_formatter (String)

Nested Schema for `attributes.address_relation_attribute.constraints`

Nested Schema for `attributes.address_relation_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.address_relation_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.automation_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["automation"]
value_formatter (String)

Nested Schema for `attributes.automation_attribute.constraints`

Nested Schema for `attributes.automation_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.automation_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.boolean_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["boolean"]
value_formatter (String)

Nested Schema for `attributes.boolean_attribute.constraints`

Nested Schema for `attributes.boolean_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.boolean_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.computed_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["computed"]
value_formatter (String)

Nested Schema for `attributes.computed_attribute.constraints`

Nested Schema for `attributes.computed_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.computed_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.consent_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
identifiers (List of String)
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
topic (String) Not Null
type (String) Not Null; must be one of ["consent"]
value_formatter (String)

Nested Schema for `attributes.consent_attribute.constraints`

Nested Schema for `attributes.consent_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.consent_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.country_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["country"]
value_formatter (String)

Nested Schema for `attributes.country_attribute.constraints`

Nested Schema for `attributes.country_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.country_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.currency_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
currency (Attributes List) An array of currency configurations with a country code (ISO-4217). Not Null (see below for nested schema)
currency_selector_only (Boolean) Default: false
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) Not Null; must be one of ["currency"]
value_formatter (String)

Nested Schema for `attributes.currency_attribute.constraints`

Nested Schema for `attributes.currency_attribute.currency`

Optional:

one (Attributes) A currency configuration (see below for nested schema)

Nested Schema for `attributes.currency_attribute.currency.one`

Optional:

code (String) Not Null
description (String) Not Null
flag (String)
symbol (String) Not Null

Nested Schema for `attributes.currency_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.currency_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.date_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["date", "datetime"]
value_formatter (String)

Nested Schema for `attributes.date_attribute.constraints`

Nested Schema for `attributes.date_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.date_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.file_attribute`

Optional:

allowed_extensions (List of String) List of file extensions (without the dot suffix)
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_access_control (String) must be one of ["public-read", "private"]
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
display_images_landscaped (Boolean) Controls how the images are presented to the user during upload on the Entity Details view.
enable_description (Boolean) When set to true, an i18n description will be used alongside the attribute label. This description should be set through the platform locales in the form: file.{attribute_name}.description_text.
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
multiple (Boolean)
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) Not Null; must be one of ["image", "file"]
value_formatter (String)

Nested Schema for `attributes.file_attribute.constraints`

Nested Schema for `attributes.file_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.file_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.internal_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["internal"]
value_formatter (String)

Nested Schema for `attributes.internal_attribute.constraints`

Nested Schema for `attributes.internal_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.internal_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.internal_user_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["internal_user"]
value_formatter (String)

Nested Schema for `attributes.internal_user_attribute.constraints`

Nested Schema for `attributes.internal_user_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.internal_user_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.invitation_email_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["invitation_email"]
value_formatter (String)

Nested Schema for `attributes.invitation_email_attribute.constraints`

Nested Schema for `attributes.invitation_email_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.invitation_email_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.link_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["link"]
value_formatter (String)

Nested Schema for `attributes.link_attribute.constraints`

Nested Schema for `attributes.link_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.link_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.message_email_address_attribute`

Optional:

address (String) Not Null
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
email_type (String)
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
send_status (String)
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) Not Null; must be one of ["message_email_address"]
value_formatter (String)

Nested Schema for `attributes.message_email_address_attribute.constraints`

Nested Schema for `attributes.message_email_address_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.message_email_address_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.multi_select_attribute`

Optional:

allow_any (Boolean) Allow arbitrary input values in addition to provided options
allow_extra_options (Boolean) controls if the 360 ui will allow the user to enter a value which is not defined by the options
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
disable_case_sensitive (Boolean) controls if the matching of values against the options is case sensitive or not
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
options (Attributes List) (see below for nested schema)
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["multiselect", "checkbox"]
value_formatter (String)

Nested Schema for `attributes.multi_select_attribute.constraints`

Nested Schema for `attributes.multi_select_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.multi_select_attribute.options`

Optional:

str (String)
two (Attributes) (see below for nested schema)

Nested Schema for `attributes.multi_select_attribute.options.two`

Optional:

title (String)
value (String) Not Null

Nested Schema for `attributes.multi_select_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.number_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
format (String)
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
show_separator (Boolean) Whether or not to show a thousands separator. Default: true
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["number"]
value_formatter (String)

Nested Schema for `attributes.number_attribute.constraints`

Nested Schema for `attributes.number_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.number_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.ordered_list_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["ordered_list"]
value_formatter (String)

Nested Schema for `attributes.ordered_list_attribute.constraints`

Nested Schema for `attributes.ordered_list_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.ordered_list_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.partner_organisation_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["partner_organisation"]
value_formatter (String)

Nested Schema for `attributes.partner_organisation_attribute.constraints`

Nested Schema for `attributes.partner_organisation_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.partner_organisation_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.partner_status_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["partner_status"]
value_formatter (String)

Nested Schema for `attributes.partner_status_attribute.constraints`

Nested Schema for `attributes.partner_status_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.partner_status_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.payment_method_relation_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
has_primary (Boolean)
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["relation_payment_method"]
value_formatter (String)

Nested Schema for `attributes.payment_method_relation_attribute.constraints`

Nested Schema for `attributes.payment_method_relation_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.payment_method_relation_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.purpose_attribute`

Optional:

archived (Boolean) Archived classification are not visible in the UI. Default: false
color (String) Color of the classification
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
created_at (String)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String)
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the taxonomy classification
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
parents (List of String)
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
slug (String) URL-friendly identifier for the classification
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["purpose"]
updated_at (String)
value_formatter (String)

Nested Schema for `attributes.purpose_attribute.constraints`

Nested Schema for `attributes.purpose_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.purpose_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.relation_attribute`

Optional:

actions (Attributes List) (see below for nested schema)
add_button_label (String) Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.
allowed_schemas (List of String)
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
details_view_mode_enabled (Boolean) Enables the preview, edition, and creation of relation items on a Master-Details view mode. Default: false
drawer_size (String) must be one of ["small", "medium", "large"]
edit_mode (String) must be one of ["list-view"]
enable_relation_picker (Boolean) When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. Default: true
enable_relation_tags (Boolean) When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item. Default: true
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
has_primary (Boolean)
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String)
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
relation_affinity_mode (String) Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. must be one of ["weak", "strong"]
relation_type (String) must be one of ["has_many", "has_one"]
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
reverse_attributes (Map of String) Map of schema slug to target relation attribute
search_placeholder (String) Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
summary_fields (Attributes List) (see below for nested schema)
type (String) must be one of ["relation"]
value_formatter (String)

Nested Schema for `attributes.relation_attribute.actions`

Optional:

action_type (String) The action type. Currently supported actions:

action	description
add_existing	Enables the user to pick an existing entity to link as relation
create_new	Enables the user to create a new entity using the first/main `allowed_schemas` schema
create_from_existing	Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation

must be one of ["add_existing", "create_new", "create_from_existing"]

default (Boolean) Sets the action as the default action, visible as the main action button.
feature_flag (String) Name of the feature flag that enables this action
label (String) The action label or action translation key (i18n)
new_entity_item (Attributes) (see below for nested schema)
settings_flag (Attributes List) This action should only be active when all the settings have the correct value (see below for nested schema)

Nested Schema for `attributes.relation_attribute.actions.new_entity_item`

Optional:

acl (Attributes) Access control list (ACL) for an entity. Defines sharing access to external orgs or users. (see below for nested schema)
additional_properties (String) Parsed as JSON.
id (String) Not Null
manifest (List of String) Manifest ID used to create/update the entity
purpose (List of String)
schema (String) URL-friendly identifier for the entity schema. Not Null
tags (List of String)
title (String) Title of entity. Not Null

Read-Only:

created_at (String)
deleted_at (String)
org (String) Organization Id the entity belongs to
owners (Attributes List) (see below for nested schema)
updated_at (String)

Nested Schema for `attributes.relation_attribute.actions.new_entity_item.acl`

Optional:

additional_properties (String) Parsed as JSON.
delete (List of String)
edit (List of String)
view (List of String)

Nested Schema for `attributes.relation_attribute.actions.new_entity_item.owners`

Read-Only:

org_id (String)
user_id (String)

Nested Schema for `attributes.relation_attribute.actions.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.relation_attribute.constraints`

Nested Schema for `attributes.relation_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.relation_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.relation_attribute.summary_fields`

Optional:

str (String)
summary_field (Attributes) Summary Fields are displayed inside list view as a resume of the relation entity. (see below for nested schema)

Nested Schema for `attributes.relation_attribute.summary_fields.summary_field`

Optional:

display_as (String) An hint on how to display the summary field
field (String) The field from the entity attributes to display

Nested Schema for `attributes.repeatable_attribute`

Optional:

add_button_label (String) Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.
allowed_schemas (List of String)
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
enable_relation_picker (Boolean) when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. Default: true
enable_relation_tags (Boolean) When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item. Default: true
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
has_primary (Boolean)
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
relation_affinity_mode (String) Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. must be one of ["weak", "strong"]
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
repeatable (Boolean)
required (Boolean) Default: false
reverse_attributes (Map of String) Map of schema slug to target relation attribute
search_placeholder (String) Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["string", "phone", "email", "address", "relation", "payment", "price_component", "date", "message_email_address"]
value_formatter (String)

Nested Schema for `attributes.repeatable_attribute.constraints`

Nested Schema for `attributes.repeatable_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.repeatable_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.select_attribute`

Optional:

allow_any (Boolean) Allow arbitrary input values in addition to provided options
constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
options (String) Parsed as JSON.
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["select", "radio"]
value_formatter (String)

Nested Schema for `attributes.select_attribute.constraints`

Nested Schema for `attributes.select_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.select_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.sequence_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
prefix (String) Prefix added before the sequence number
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
start_number (Number)
type (String) must be one of ["sequence"]
value_formatter (String)

Nested Schema for `attributes.sequence_attribute.constraints`

Nested Schema for `attributes.sequence_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.sequence_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.status_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
options (Attributes List) (see below for nested schema)
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["status"]
value_formatter (String)

Nested Schema for `attributes.status_attribute.constraints`

Nested Schema for `attributes.status_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.status_attribute.options`

Optional:

str (String)
two (Attributes) (see below for nested schema)

Nested Schema for `attributes.status_attribute.options.two`

Optional:

title (String) The displayed title of the option
value (String) The stored value of the option. Not Null

Nested Schema for `attributes.status_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.tags_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
name (String) Not Null
options (List of String)
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
suggestions (List of String)
type (String) must be one of ["tags"]
value_formatter (String)

Nested Schema for `attributes.tags_attribute.constraints`

Nested Schema for `attributes.tags_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.tags_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.text_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
multiline (Boolean)
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
rich_text (Boolean)
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["string"]
value_formatter (String)

Nested Schema for `attributes.text_attribute.constraints`

Nested Schema for `attributes.text_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.text_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `attributes.user_relation_attribute`

Optional:

constraints (Attributes) A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. (see below for nested schema)
default_value (String) Parsed as JSON.
deprecated (Boolean) Default: false
entity_builder_disable_edit (Boolean) Setting to true disables editing the attribute on the entity builder UI. Default: false
feature_flag (String) This attribute should only be active when the feature flag is enabled
group (String) Which group the attribute should appear in. Accepts group ID or group name
hidden (Boolean) Do not render attribute in entity views. Default: false
hide_label (Boolean) When set to true, will hide the label of the field.
icon (String) Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name
id (String) ID for the entity attribute
info_helpers (Attributes) A set of configurations meant to document and assist the user in filling the attribute. (see below for nested schema)
label (String) Not Null
layout (String)
manifest (List of String) Manifest ID used to create/update the schema attribute
multiple (Boolean) Default: false
name (String) Not Null
order (Number) Attribute sort order (ascending) in group
placeholder (String)
preview_value_formatter (String)
protected (Boolean) Setting to true prevents the attribute from being modified / deleted
purpose (List of String)
readonly (Boolean) Default: false
render_condition (String) Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility.
required (Boolean) Default: false
settings_flag (Attributes List) This attribute should only be active when one of the provided settings have the correct value (see below for nested schema)
show_in_table (Boolean) Render as a column in table views. When defined, overrides hidden
sortable (Boolean) Allow sorting by this attribute in table views if show_in_table is true. Default: true
type (String) must be one of ["relation_user"]
value_formatter (String)

Nested Schema for `attributes.user_relation_attribute.constraints`

Nested Schema for `attributes.user_relation_attribute.info_helpers`

Optional:

hint_custom_component (String) The name of the custom component to be used as the hint helper. The component should be registered in the @epilot360/entity-ui on the index of the components directory. When specified it overrides the hint_text or hint_text_key configuration.
hint_text (String) The text to be displayed in the attribute hint helper. When specified it overrides the hint_text_key configuration.
hint_text_key (String) The key of the hint text to be displayed in the attribute hint helper. The key should be a valid i18n key.
hint_tooltip_placement (String) The placement of the hint tooltip. The value should be a valid @mui/core tooltip placement.

Nested Schema for `attributes.user_relation_attribute.settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `settings_flag`

Optional:

enabled (Boolean) Whether the setting should be enabled or not
name (String) The name of the organization setting to check

Nested Schema for `ui_hooks`

Optional:

additional_properties (String) Parsed as JSON.
component (String) the component to be dynamically loaded
disabled (Boolean) Whether capability should be disabled
group_expanded (Boolean) Sets the group expand/collapse default state
header (Boolean) Specific to Activity pilot
hook (String) name of the hook to use. Not Null
icon (String) Preview icon name(As in Base elements) for the capability
import (String) package to be imported
order (Number) render order (ascending)
render_condition (String)
required_permission (Attributes) Require a permission to display UI hook (see below for nested schema)
route (String) route for specified capability
title (String)

Nested Schema for `ui_hooks.required_permission`

Optional:

action (String) Not Null
resource (String)

Import

Import is supported using the following syntax:

terraform import epilot-schema_schema_capability.my_epilot-schema_schema_capability "contact:97644baa-083f-4e49-9188-fcff2ecaad7d"

Files

schema_capability.md

Latest commit

History

schema_capability.md

File metadata and controls

epilot-schema_schema_capability (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for attributes

Nested Schema for attributes.address_attribute

Nested Schema for attributes.address_attribute.constraints

Nested Schema for attributes.address_attribute.info_helpers

Nested Schema for attributes.address_attribute.settings_flag

Nested Schema for attributes.address_relation_attribute

Nested Schema for attributes.address_relation_attribute.constraints

Nested Schema for attributes.address_relation_attribute.info_helpers

Nested Schema for attributes.address_relation_attribute.settings_flag

Nested Schema for attributes.automation_attribute

Nested Schema for attributes.automation_attribute.constraints

Nested Schema for attributes.automation_attribute.info_helpers

Nested Schema for attributes.automation_attribute.settings_flag

Nested Schema for attributes.boolean_attribute

Nested Schema for attributes.boolean_attribute.constraints

Nested Schema for attributes.boolean_attribute.info_helpers

Nested Schema for attributes.boolean_attribute.settings_flag

Nested Schema for attributes.computed_attribute

Nested Schema for attributes.computed_attribute.constraints

Nested Schema for attributes.computed_attribute.info_helpers

Nested Schema for attributes.computed_attribute.settings_flag

Nested Schema for attributes.consent_attribute

Nested Schema for attributes.consent_attribute.constraints

Nested Schema for attributes.consent_attribute.info_helpers

Nested Schema for attributes.consent_attribute.settings_flag

Nested Schema for attributes.country_attribute

Nested Schema for attributes.country_attribute.constraints

Nested Schema for attributes.country_attribute.info_helpers

Nested Schema for attributes.country_attribute.settings_flag

Nested Schema for attributes.currency_attribute

Nested Schema for attributes.currency_attribute.constraints

Nested Schema for attributes.currency_attribute.currency

Nested Schema for attributes.currency_attribute.currency.one

Nested Schema for attributes.currency_attribute.info_helpers

Nested Schema for attributes.currency_attribute.settings_flag

Nested Schema for attributes.date_attribute

Nested Schema for attributes.date_attribute.constraints

Nested Schema for attributes.date_attribute.info_helpers

Nested Schema for attributes.date_attribute.settings_flag

Nested Schema for attributes.file_attribute

Nested Schema for attributes.file_attribute.constraints

Nested Schema for attributes.file_attribute.info_helpers

Nested Schema for attributes.file_attribute.settings_flag

Nested Schema for attributes.internal_attribute

Nested Schema for attributes.internal_attribute.constraints

Nested Schema for attributes.internal_attribute.info_helpers

Nested Schema for attributes.internal_attribute.settings_flag

Nested Schema for attributes.internal_user_attribute

Nested Schema for attributes.internal_user_attribute.constraints

Nested Schema for attributes.internal_user_attribute.info_helpers

Nested Schema for attributes.internal_user_attribute.settings_flag

Nested Schema for attributes.invitation_email_attribute

Nested Schema for attributes.invitation_email_attribute.constraints

Nested Schema for attributes.invitation_email_attribute.info_helpers

Nested Schema for attributes.invitation_email_attribute.settings_flag

Nested Schema for attributes.link_attribute

Nested Schema for attributes.link_attribute.constraints

Nested Schema for attributes.link_attribute.info_helpers

Nested Schema for attributes.link_attribute.settings_flag

Nested Schema for attributes.message_email_address_attribute

Nested Schema for attributes.message_email_address_attribute.constraints

Nested Schema for attributes.message_email_address_attribute.info_helpers

Nested Schema for attributes.message_email_address_attribute.settings_flag

Nested Schema for attributes.multi_select_attribute

Nested Schema for attributes.multi_select_attribute.constraints

Nested Schema for attributes.multi_select_attribute.info_helpers

Nested Schema for attributes.multi_select_attribute.options

Nested Schema for attributes.multi_select_attribute.options.two

Nested Schema for `attributes`

Nested Schema for `attributes.address_attribute`

Nested Schema for `attributes.address_attribute.constraints`

Nested Schema for `attributes.address_attribute.info_helpers`

Nested Schema for `attributes.address_attribute.settings_flag`

Nested Schema for `attributes.address_relation_attribute`

Nested Schema for `attributes.address_relation_attribute.constraints`

Nested Schema for `attributes.address_relation_attribute.info_helpers`

Nested Schema for `attributes.address_relation_attribute.settings_flag`

Nested Schema for `attributes.automation_attribute`

Nested Schema for `attributes.automation_attribute.constraints`

Nested Schema for `attributes.automation_attribute.info_helpers`

Nested Schema for `attributes.automation_attribute.settings_flag`

Nested Schema for `attributes.boolean_attribute`

Nested Schema for `attributes.boolean_attribute.constraints`

Nested Schema for `attributes.boolean_attribute.info_helpers`

Nested Schema for `attributes.boolean_attribute.settings_flag`

Nested Schema for `attributes.computed_attribute`

Nested Schema for `attributes.computed_attribute.constraints`

Nested Schema for `attributes.computed_attribute.info_helpers`

Nested Schema for `attributes.computed_attribute.settings_flag`

Nested Schema for `attributes.consent_attribute`

Nested Schema for `attributes.consent_attribute.constraints`

Nested Schema for `attributes.consent_attribute.info_helpers`

Nested Schema for `attributes.consent_attribute.settings_flag`

Nested Schema for `attributes.country_attribute`

Nested Schema for `attributes.country_attribute.constraints`

Nested Schema for `attributes.country_attribute.info_helpers`

Nested Schema for `attributes.country_attribute.settings_flag`

Nested Schema for `attributes.currency_attribute`

Nested Schema for `attributes.currency_attribute.constraints`

Nested Schema for `attributes.currency_attribute.currency`

Nested Schema for `attributes.currency_attribute.currency.one`

Nested Schema for `attributes.currency_attribute.info_helpers`

Nested Schema for `attributes.currency_attribute.settings_flag`

Nested Schema for `attributes.date_attribute`

Nested Schema for `attributes.date_attribute.constraints`

Nested Schema for `attributes.date_attribute.info_helpers`

Nested Schema for `attributes.date_attribute.settings_flag`

Nested Schema for `attributes.file_attribute`

Nested Schema for `attributes.file_attribute.constraints`

Nested Schema for `attributes.file_attribute.info_helpers`

Nested Schema for `attributes.file_attribute.settings_flag`

Nested Schema for `attributes.internal_attribute`

Nested Schema for `attributes.internal_attribute.constraints`

Nested Schema for `attributes.internal_attribute.info_helpers`

Nested Schema for `attributes.internal_attribute.settings_flag`

Nested Schema for `attributes.internal_user_attribute`

Nested Schema for `attributes.internal_user_attribute.constraints`

Nested Schema for `attributes.internal_user_attribute.info_helpers`

Nested Schema for `attributes.internal_user_attribute.settings_flag`

Nested Schema for `attributes.invitation_email_attribute`

Nested Schema for `attributes.invitation_email_attribute.constraints`

Nested Schema for `attributes.invitation_email_attribute.info_helpers`

Nested Schema for `attributes.invitation_email_attribute.settings_flag`

Nested Schema for `attributes.link_attribute`

Nested Schema for `attributes.link_attribute.constraints`

Nested Schema for `attributes.link_attribute.info_helpers`

Nested Schema for `attributes.link_attribute.settings_flag`

Nested Schema for `attributes.message_email_address_attribute`

Nested Schema for `attributes.message_email_address_attribute.constraints`

Nested Schema for `attributes.message_email_address_attribute.info_helpers`

Nested Schema for `attributes.message_email_address_attribute.settings_flag`

Nested Schema for `attributes.multi_select_attribute`

Nested Schema for `attributes.multi_select_attribute.constraints`

Nested Schema for `attributes.multi_select_attribute.info_helpers`

Nested Schema for `attributes.multi_select_attribute.options`

Nested Schema for `attributes.multi_select_attribute.options.two`

Nested Schema for `attributes.multi_select_attribute.settings_flag`

Nested Schema for `attributes.number_attribute`

Nested Schema for `attributes.number_attribute.constraints`

Nested Schema for `attributes.number_attribute.info_helpers`

Nested Schema for `attributes.number_attribute.settings_flag`

Nested Schema for `attributes.ordered_list_attribute`

Nested Schema for `attributes.ordered_list_attribute.constraints`

Nested Schema for `attributes.ordered_list_attribute.info_helpers`

Nested Schema for `attributes.ordered_list_attribute.settings_flag`

Nested Schema for `attributes.partner_organisation_attribute`

Nested Schema for `attributes.partner_organisation_attribute.constraints`

Nested Schema for `attributes.partner_organisation_attribute.info_helpers`