openapi: 3.0.3 info: title: Baserow API spec Admin Builder elements API version: 2.2.2 description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api). For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).' contact: url: https://baserow.io/contact license: name: MIT url: https://github.com/baserow/baserow/blob/develop/LICENSE tags: - name: Builder elements paths: /api/builder/domains/published/page/{page_id}/elements/: get: operationId: list_public_builder_page_elements description: Lists all the elements of the page related to the provided parameter. If the user is Anonymous, the page must belong to a published builder instance to being accessible. parameters: - in: path name: page_id schema: type: integer description: Returns the elements of the page related to the provided Id. required: true tags: - Builder elements security: - UserSource JWT: [] - JWT: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Element_TypePublicElement' description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_PAGE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/builder/element/{element_id}/: patch: operationId: update_builder_page_element description: Updates an existing builder element. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: path name: element_id schema: type: integer description: The id of the element required: true tags: - Builder elements requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedElement_TypeUpdateElement' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedElement_TypeUpdateElement' multipart/form-data: schema: $ref: '#/components/schemas/PatchedElement_TypeUpdateElement' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Element_TypeElement' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_ELEMENT_INVALID_FORMULA - ERROR_REQUEST_BODY_VALIDATION detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_ELEMENT_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' delete: operationId: delete_builder_page_element description: Deletes the element related by the given id. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: path name: element_id schema: type: integer description: The id of the element required: true tags: - Builder elements security: - UserSource JWT: [] - JWT: [] responses: '204': description: No response body '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_REQUEST_BODY_VALIDATION detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_ELEMENT_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/builder/element/{element_id}/duplicate/: post: operationId: duplicate_builder_page_element description: Duplicates an element and all of the elements children and the associated workflow actions as well. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: path name: element_id schema: type: integer description: The id of the element to duplicate required: true tags: - Builder elements security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DuplicateElement' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_REQUEST_BODY_VALIDATION detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_ELEMENT_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/builder/element/{element_id}/move/: patch: operationId: move_builder_page_element description: Moves the element in the page before another element or at the end of the page if no before element is given. The elements must belong to the same page. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: path name: element_id schema: type: integer description: The id of the element to move required: true tags: - Builder elements requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMoveElement' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedMoveElement' multipart/form-data: schema: $ref: '#/components/schemas/PatchedMoveElement' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Element_TypeElement' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_REQUEST_BODY_VALIDATION - ERROR_ELEMENT_NOT_IN_SAME_PAGE detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_ELEMENT_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/builder/page/{page_id}/elements/: get: operationId: list_builder_page_elements description: Lists all the elements of the page related to the provided parameter if the user has access to the related builder's workspace. If the workspace is related to a template, then this endpoint will be publicly accessible. parameters: - in: path name: page_id schema: type: integer description: Returns only the elements of the page related to the provided Id. required: true tags: - Builder elements security: - UserSource JWT: [] - JWT: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Element_TypeElement' description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_PAGE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' post: operationId: create_builder_page_element description: Creates a new builder element parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: path name: page_id schema: type: integer description: Creates an element for the builder page related to the provided value. required: true tags: - Builder elements requestBody: content: application/json: schema: $ref: '#/components/schemas/Element_TypeCreateElement' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Element_TypeCreateElement' multipart/form-data: schema: $ref: '#/components/schemas/Element_TypeCreateElement' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Element_TypeElement' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_ELEMENT_INVALID_FORMULA - ERROR_REQUEST_BODY_VALIDATION detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_PAGE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' components: schemas: CheckboxElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The input's default value. required: type: boolean default: false description: Whether this form element is a required field. required: - order - type HeaderElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer required: - order - type ButtonTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' RatingElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple ButtonInputConfigBlock: type: object description: Style overrides for this element. properties: login_button: $ref: '#/components/schemas/button_active_border_color' input: $ref: '#/components/schemas/input_horizontal_padding' HeaderElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer MenuElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonAndLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. orientation: $ref: '#/components/schemas/OrientationEnum' alignment: $ref: '#/components/schemas/AlignmentD61Enum' menu_items: allOf: - $ref: '#/components/schemas/MenuItem' readOnly: true description: Menu items of the MenuElement. required: - id - menu_items - order - page_id - parent_element_id - type SimpleContainerElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. ButtonWidthEnum: enum: - auto - full type: string description: '* `auto` - Auto * `full` - Full' Heading6FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' FooterElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer required: - id - order - page_id - parent_element_id - type FileInputElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputAndTypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input multiple: type: boolean description: Whether this file input allows users to choose multiple files required: type: boolean description: Whether this form element is a required field. default_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file name. default_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file url. help_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The help text which should be visible on the element. max_filesize: type: integer maximum: 100 minimum: 1 default: 5 description: Whether to show a preview of image files. allowed_filetypes: description: Allowed file types for this input. preview: type: boolean description: Whether to show a preview of image files. required: - id - order - page_id - parent_element_id - type IFrameElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. source_type: allOf: - $ref: '#/components/schemas/SourceTypeEnum' default: url url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the page to embed embed: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Inline HTML to embed height: type: integer maximum: 2000 minimum: 1 default: 300 description: Height in pixels of the iframe required: - id - order - page_id - parent_element_id - type RecordSelectorElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: false description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: false description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this record selector default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This record selector default value. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. multiple: type: boolean default: false description: Whether this record selector allows users to choose multiple values. option_name_suffix: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The formula to generate the displayed option name suffix required: - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable BuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 required: - element_id - event - id - order - type SourceTypeEnum: enum: - url - embed type: string description: '* `url` - Url * `embed` - Embed' ChoiceElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this choice default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This choice's input default value. required: type: boolean default: false description: Whether this form element is a required field. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. options: type: array items: $ref: '#/components/schemas/ChoiceOption' multiple: type: boolean default: false description: Whether this choice allows users to choose multiple values. show_as_dropdown: type: boolean default: true description: Whether to show the choices as a dropdown. option_type: allOf: - $ref: '#/components/schemas/OptionTypeEnum' default: manual formula_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the option if it is a formula formula_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The display name of the option if it is a formula InputTextElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This text input's default value. required: type: boolean default: false description: Whether this form element is a required field. validation_type: allOf: - $ref: '#/components/schemas/ValidationTypeEnum' description: 'Optionally set the validation type to use when applying form data. * `any` - Any * `email` - Email * `integer` - Integer' placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. is_multiline: type: boolean default: false description: Whether this text input is multiline. rows: type: integer maximum: 100 minimum: 1 default: 3 description: Number of rows displayed by the rendered input element input_type: allOf: - $ref: '#/components/schemas/InputTypeEnum' default: text description: 'The type of the input, not applicable for multiline inputs. * `text` - Text * `password` - Password' required: - id - order - page_id - parent_element_id - type ImageElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ImageConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. image_source_type: $ref: '#/components/schemas/ImageSourceTypeEnum' image_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The image file image_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the image file alt_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Text that is displayed when the image can't load InputTextElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This text input's default value. required: type: boolean default: false description: Whether this form element is a required field. validation_type: allOf: - $ref: '#/components/schemas/ValidationTypeEnum' description: 'Optionally set the validation type to use when applying form data. * `any` - Any * `email` - Email * `integer` - Integer' placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. is_multiline: type: boolean default: false description: Whether this text input is multiline. rows: type: integer maximum: 100 minimum: 1 default: 3 description: Number of rows displayed by the rendered input element input_type: allOf: - $ref: '#/components/schemas/InputTypeEnum' default: text description: 'The type of the input, not applicable for multiline inputs. * `text` - Text * `password` - Password' LinkElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. variant: allOf: - $ref: '#/components/schemas/VariantEnum' description: 'The variant of the link. * `link` - Link * `button` - Button' required: - id - order - page_id - parent_element_id - type Heading5TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' MenuElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonAndLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' orientation: $ref: '#/components/schemas/OrientationEnum' alignment: $ref: '#/components/schemas/AlignmentD61Enum' menu_items: type: array items: $ref: '#/components/schemas/MenuItem' required: - order - type input_horizontal_padding: type: object properties: label_font_family: type: string description: The font family of the label maxLength: 250 label_text_color: type: string description: The text color of the label maxLength: 255 label_font_size: type: integer maximum: 32767 minimum: -32768 description: The font size of the label label_font_weight: $ref: '#/components/schemas/LabelFontWeightEnum' input_font_family: type: string description: The font family of the input maxLength: 250 input_font_size: type: integer maximum: 32767 minimum: -32768 input_font_weight: $ref: '#/components/schemas/InputFontWeightEnum' input_text_color: type: string description: The text color of the input maxLength: 255 input_background_color: type: string description: The background color of the input maxLength: 255 input_border_color: type: string description: The color of the input border maxLength: 255 input_border_size: type: integer maximum: 32767 minimum: -32768 description: Input border size input_border_radius: type: integer maximum: 32767 minimum: -32768 description: Input border radius input_vertical_padding: type: integer maximum: 32767 minimum: -32768 description: Input vertical padding input_horizontal_padding: type: integer maximum: 32767 minimum: -32768 description: Input horizontal padding link_active_text_decoration: type: object properties: link_default_text_decoration: type: array items: type: boolean description: 'Default text decoration: [underline, stroke, uppercase, italic]' link_hover_text_decoration: type: array items: type: boolean description: 'Hover text decoration: [underline, stroke, uppercase, italic]' link_active_text_decoration: type: array items: type: boolean description: 'Active text decoration: [underline, stroke, uppercase, italic]' link_font_family: type: string maxLength: 250 link_font_size: type: integer maximum: 32767 minimum: -32768 link_font_weight: $ref: '#/components/schemas/LinkFontWeightEnum' link_text_alignment: $ref: '#/components/schemas/LinkTextAlignmentEnum' link_text_color: type: string description: The text color of links maxLength: 255 link_hover_text_color: type: string description: The hover color of links when hovered maxLength: 255 link_active_text_color: type: string description: The hover color of links when active maxLength: 255 ChoiceElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this choice default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This choice's input default value. required: type: boolean default: false description: Whether this form element is a required field. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. options: type: array items: $ref: '#/components/schemas/ChoiceOption' multiple: type: boolean default: false description: Whether this choice allows users to choose multiple values. show_as_dropdown: type: boolean default: true description: Whether to show the choices as a dropdown. option_type: allOf: - $ref: '#/components/schemas/OptionTypeEnum' default: manual formula_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the option if it is a formula formula_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The display name of the option if it is a formula required: - id - order - page_id - parent_element_id - type RatingInputElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this field required: - id - order - page_id - parent_element_id - type AuthFormElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonInputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. user_source_id: type: integer nullable: true description: Display the auth form for the selected user source login_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the login button MenuElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonAndLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. orientation: $ref: '#/components/schemas/OrientationEnum' alignment: $ref: '#/components/schemas/AlignmentD61Enum' menu_items: allOf: - $ref: '#/components/schemas/MenuItem' readOnly: true description: Menu items of the MenuElement. required: - id - menu_items - order - page_id - parent_element_id - type ButtonLinkConfigBlock: type: object description: Style overrides for this element. properties: button: $ref: '#/components/schemas/button_active_border_color' link: $ref: '#/components/schemas/link_active_text_decoration' DateTimePickerElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this date time picker required: type: boolean default: false description: Whether this form element is a required field. default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This date time picker input's default value. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' default: EU description: 'EU (25/04/2024), US (04/25/2024) or ISO (2024-04-25) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' include_time: type: boolean default: false description: Whether to include time in the representation of the date time_format: allOf: - $ref: '#/components/schemas/TimeFormatEnum' default: '24' description: '24 (14:00) or 12 (02:30) PM * `24` - 24 hour * `12` - 12 hour' required: - id - order - page_id - parent_element_id - type TableElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonTableAndTypographyButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. fields: type: array items: $ref: '#/components/schemas/CollectionField' orientation: description: The table orientation (horizontal or vertical) for each device type required: - id - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - page_id - parent_element_id - type CheckboxElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The input's default value. required: type: boolean default: false description: Whether this form element is a required field. Heading6TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' FooterElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer ButtonElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The caption of the button. required: - id - order - page_id - parent_element_id - type AuthFormElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonInputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' user_source_id: type: integer nullable: true description: Display the auth form for the selected user source login_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the login button required: - order - type RecordSelectorElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: false description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: false description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this record selector default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This record selector default value. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. multiple: type: boolean default: false description: Whether this record selector allows users to choose multiple values. option_name_suffix: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The formula to generate the displayed option name suffix required: - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - type ImageElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ImageConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. image_source_type: $ref: '#/components/schemas/ImageSourceTypeEnum' image_file: $ref: '#/components/schemas/UserFile' image_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the image file alt_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Text that is displayed when the image can't load required: - id - order - page_id - parent_element_id - type ColumnElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. column_amount: type: integer maximum: 6 minimum: 1 description: The amount of columns inside this column element. column_gap: type: integer maximum: 2000 minimum: 0 description: The amount of space between the columns. alignment: $ref: '#/components/schemas/Alignment6d7Enum' TableElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonTableAndTypographyButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. fields: type: array items: $ref: '#/components/schemas/CollectionField' orientation: description: The table orientation (horizontal or vertical) for each device type required: - id - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - page_id - parent_element_id - type Heading3FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' SimpleContainerElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. required: - id - order - page_id - parent_element_id - type LinkElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. variant: allOf: - $ref: '#/components/schemas/VariantEnum' description: 'The variant of the link. * `link` - Link * `button` - Button' AlignmentD61Enum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' ColumnElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. column_amount: type: integer maximum: 6 minimum: 1 description: The amount of columns inside this column element. column_gap: type: integer maximum: 2000 minimum: 0 description: The amount of space between the columns. alignment: $ref: '#/components/schemas/Alignment6d7Enum' required: - id - order - page_id - parent_element_id - type HeadingElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. level: type: integer maximum: 6 minimum: 1 default: 1 description: The level of the heading from 1 to 6. required: - id - order - page_id - parent_element_id - type ButtonAndLinkConfigBlock: type: object description: Style overrides for this element. properties: menu: $ref: '#/components/schemas/link_active_text_decoration' ImageAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' ImageConstraintEnum: enum: - cover - contain - full-width type: string description: '* `cover` - Cover * `contain` - Contain * `full-width` - Full Width' FormatEnum: enum: - plain - markdown type: string description: '* `plain` - Plain * `markdown` - Markdown' ButtonFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' ColumnElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' column_amount: type: integer maximum: 6 minimum: 1 description: The amount of columns inside this column element. column_gap: type: integer maximum: 2000 minimum: 0 description: The amount of space between the columns. alignment: $ref: '#/components/schemas/Alignment6d7Enum' required: - order - type LinkTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' DateTimePickerElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this date time picker required: type: boolean default: false description: Whether this form element is a required field. default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This date time picker input's default value. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' default: EU description: 'EU (25/04/2024), US (04/25/2024) or ISO (2024-04-25) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' include_time: type: boolean default: false description: Whether to include time in the representation of the date time_format: allOf: - $ref: '#/components/schemas/TimeFormatEnum' default: '24' description: '24 (14:00) or 12 (02:30) PM * `24` - 24 hour * `12` - 12 hour' required: - order - type ImageSourceTypeEnum: enum: - upload - url type: string description: '* `upload` - Upload * `url` - Url' StyleBackgroundModeEnum: enum: - tile - fill - fit type: string description: '* `tile` - Tile * `fill` - Fill * `fit` - Fit' InputTypeEnum: enum: - text - password type: string description: '* `text` - Text * `password` - Password' FormContainerElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. submit_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple reset_initial_values_post_submission: type: boolean description: Whether to reset the form to using its initial values after a successful form submission. required: - id - order - page_id - parent_element_id - type ChoiceElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this choice default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This choice's input default value. required: type: boolean default: false description: Whether this form element is a required field. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. options: type: array items: $ref: '#/components/schemas/ChoiceOption' multiple: type: boolean default: false description: Whether this choice allows users to choose multiple values. show_as_dropdown: type: boolean default: true description: Whether to show the choices as a dropdown. option_type: allOf: - $ref: '#/components/schemas/OptionTypeEnum' default: manual formula_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the option if it is a formula formula_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The display name of the option if it is a formula required: - order - type FormContainerElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. submit_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple reset_initial_values_post_submission: type: boolean description: Whether to reset the form to using its initial values after a successful form submission. required: - id - order - page_id - parent_element_id - type ChoiceOption: type: object properties: id: type: integer readOnly: true value: type: string nullable: true description: The value of the option. An empty string is a valid value. When the value field is null, the frontend will auto-populate the value using the name field. name: type: string description: The display name of the option required: - id TextElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be a formula. format: allOf: - $ref: '#/components/schemas/FormatEnum' default: plain description: 'The format of the text * `plain` - Plain * `markdown` - Markdown' HeadingElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. level: type: integer maximum: 6 minimum: 1 default: 1 description: The level of the heading from 1 to 6. StyleWidthEnum: enum: - full - full-width - normal - medium - small type: string description: '* `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' FileInputElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputAndTypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input multiple: type: boolean description: Whether this file input allows users to choose multiple files required: type: boolean description: Whether this form element is a required field. default_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file name. default_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file url. help_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The help text which should be visible on the element. max_filesize: type: integer maximum: 100 minimum: 1 default: 5 description: Whether to show a preview of image files. allowed_filetypes: description: Allowed file types for this input. preview: type: boolean description: Whether to show a preview of image files. Heading5FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' InputAndTypographyConfigBlock: type: object description: Style overrides for this element. properties: input: $ref: '#/components/schemas/heading_6_text_decoration' AuthFormElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonInputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. user_source_id: type: integer nullable: true description: Display the auth form for the selected user source login_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the login button required: - id - order - page_id - parent_element_id - type HeaderElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer required: - id - order - page_id - parent_element_id - type ChoiceElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this choice default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This choice's input default value. required: type: boolean default: false description: Whether this form element is a required field. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. options: type: array items: $ref: '#/components/schemas/ChoiceOption' multiple: type: boolean default: false description: Whether this choice allows users to choose multiple values. show_as_dropdown: type: boolean default: true description: Whether to show the choices as a dropdown. option_type: allOf: - $ref: '#/components/schemas/OptionTypeEnum' default: manual formula_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the option if it is a formula formula_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The display name of the option if it is a formula required: - id - order - page_id - parent_element_id - type Heading3TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' ButtonElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The caption of the button. DateTimePickerElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this date time picker required: type: boolean default: false description: Whether this form element is a required field. default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This date time picker input's default value. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' default: EU description: 'EU (25/04/2024), US (04/25/2024) or ISO (2024-04-25) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' include_time: type: boolean default: false description: Whether to include time in the representation of the date time_format: allOf: - $ref: '#/components/schemas/TimeFormatEnum' default: '24' description: '24 (14:00) or 12 (02:30) PM * `24` - 24 hour * `12` - 12 hour' PageParameterValue: type: object properties: name: type: string value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - name heading_6_text_decoration: type: object properties: heading_1_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_2_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_3_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_4_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_5_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_6_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' body_font_family: type: string maxLength: 250 body_font_size: type: integer maximum: 32767 minimum: -32768 body_font_weight: $ref: '#/components/schemas/BodyFontWeightEnum' body_text_color: type: string maxLength: 255 body_text_alignment: $ref: '#/components/schemas/BodyTextAlignmentEnum' heading_1_font_family: type: string maxLength: 250 heading_1_font_size: type: integer maximum: 32767 minimum: -32768 heading_1_font_weight: $ref: '#/components/schemas/Heading1FontWeightEnum' heading_1_text_color: type: string maxLength: 255 heading_1_text_alignment: $ref: '#/components/schemas/Heading1TextAlignmentEnum' heading_2_font_family: type: string maxLength: 250 heading_2_font_size: type: integer maximum: 32767 minimum: -32768 heading_2_font_weight: $ref: '#/components/schemas/Heading2FontWeightEnum' heading_2_text_color: type: string maxLength: 255 heading_2_text_alignment: $ref: '#/components/schemas/Heading2TextAlignmentEnum' heading_3_font_family: type: string maxLength: 250 heading_3_font_size: type: integer maximum: 32767 minimum: -32768 heading_3_font_weight: $ref: '#/components/schemas/Heading3FontWeightEnum' heading_3_text_color: type: string maxLength: 255 heading_3_text_alignment: $ref: '#/components/schemas/Heading3TextAlignmentEnum' heading_4_font_family: type: string maxLength: 250 heading_4_font_size: type: integer maximum: 32767 minimum: -32768 heading_4_font_weight: $ref: '#/components/schemas/Heading4FontWeightEnum' heading_4_text_color: type: string maxLength: 255 heading_4_text_alignment: $ref: '#/components/schemas/Heading4TextAlignmentEnum' heading_5_font_family: type: string maxLength: 250 heading_5_font_size: type: integer maximum: 32767 minimum: -32768 heading_5_font_weight: $ref: '#/components/schemas/Heading5FontWeightEnum' heading_5_text_color: type: string maxLength: 255 heading_5_text_alignment: $ref: '#/components/schemas/Heading5TextAlignmentEnum' heading_6_font_family: type: string maxLength: 250 heading_6_font_size: type: integer maximum: 32767 minimum: -32768 heading_6_font_weight: $ref: '#/components/schemas/Heading6FontWeightEnum' heading_6_text_color: type: string maxLength: 255 heading_6_text_alignment: $ref: '#/components/schemas/Heading6TextAlignmentEnum' ImageConfigBlock: type: object description: Style overrides for this element. properties: image: $ref: '#/components/schemas/image_constraint' TextElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be a formula. format: allOf: - $ref: '#/components/schemas/FormatEnum' default: plain description: 'The format of the text * `plain` - Plain * `markdown` - Markdown' required: - id - order - page_id - parent_element_id - type RoleTypeEnum: enum: - allow_all - allow_all_except - disallow_all_except type: string description: '* `allow_all` - Allow All * `allow_all_except` - Allow All Except * `disallow_all_except` - Disallow All Except' RepeatElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. orientation: $ref: '#/components/schemas/OrientationEnum' items_per_row: description: The amount repetitions per row, per device type. Only applicable when the orientation is horizontal. horizontal_gap: type: integer maximum: 2000 minimum: 0 description: The amount of horizontal space between repeat elements. vertical_gap: type: integer maximum: 2000 minimum: 0 description: The amount of vertical space between repeat elements. required: - id - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - page_id - parent_element_id - type RatingStyleEnum: enum: - star - heart - thumbs-up - flag - smile type: string description: '* `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' TextElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be a formula. format: allOf: - $ref: '#/components/schemas/FormatEnum' default: plain description: 'The format of the text * `plain` - Plain * `markdown` - Markdown' required: - order - type ButtonAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' InputTextElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This text input's default value. required: type: boolean default: false description: Whether this form element is a required field. validation_type: allOf: - $ref: '#/components/schemas/ValidationTypeEnum' description: 'Optionally set the validation type to use when applying form data. * `any` - Any * `email` - Email * `integer` - Integer' placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. is_multiline: type: boolean default: false description: Whether this text input is multiline. rows: type: integer maximum: 100 minimum: 1 default: 3 description: Number of rows displayed by the rendered input element input_type: allOf: - $ref: '#/components/schemas/InputTypeEnum' default: text description: 'The type of the input, not applicable for multiline inputs. * `text` - Text * `password` - Password' required: - id - order - page_id - parent_element_id - type HeaderElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer required: - id - order - page_id - parent_element_id - type IFrameElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. source_type: allOf: - $ref: '#/components/schemas/SourceTypeEnum' default: url url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the page to embed embed: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Inline HTML to embed height: type: integer maximum: 2000 minimum: 1 default: 300 description: Height in pixels of the iframe required: - id - order - page_id - parent_element_id - type ColumnElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. column_amount: type: integer maximum: 6 minimum: 1 description: The amount of columns inside this column element. column_gap: type: integer maximum: 2000 minimum: 0 description: The amount of space between the columns. alignment: $ref: '#/components/schemas/Alignment6d7Enum' required: - id - order - page_id - parent_element_id - type ButtonElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The caption of the button. required: - id - order - page_id - parent_element_id - type LabelFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' TypographyConfigBlock: type: object description: Style overrides for this element. properties: typography: $ref: '#/components/schemas/heading_6_text_decoration' RatingInputElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this field required: - id - order - page_id - parent_element_id - type HeadingElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. level: type: integer maximum: 6 minimum: 1 default: 1 description: The level of the heading from 1 to 6. required: - order - type HeadingElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. level: type: integer maximum: 6 minimum: 1 default: 1 description: The level of the heading from 1 to 6. required: - id - order - page_id - parent_element_id - type IFrameElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' source_type: allOf: - $ref: '#/components/schemas/SourceTypeEnum' default: url url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the page to embed embed: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Inline HTML to embed height: type: integer maximum: 2000 minimum: 1 default: 300 description: Height in pixels of the iframe required: - order - type RecordSelectorElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: false description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: false description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this record selector default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This record selector default value. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. multiple: type: boolean default: false description: Whether this record selector allows users to choose multiple values. option_name_suffix: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The formula to generate the displayed option name suffix required: - id - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - page_id - parent_element_id - type DuplicateElement: type: object properties: elements: type: array items: $ref: '#/components/schemas/Element' readOnly: true description: The duplicated elements. workflow_actions: type: array items: $ref: '#/components/schemas/BuilderWorkflowAction' readOnly: true description: The duplicated workflow actions required: - elements - workflow_actions RepeatElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. orientation: $ref: '#/components/schemas/OrientationEnum' items_per_row: description: The amount repetitions per row, per device type. Only applicable when the orientation is horizontal. horizontal_gap: type: integer maximum: 2000 minimum: 0 description: The amount of horizontal space between repeat elements. vertical_gap: type: integer maximum: 2000 minimum: 0 description: The amount of vertical space between repeat elements. required: - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable TextElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/TypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be a formula. format: allOf: - $ref: '#/components/schemas/FormatEnum' default: plain description: 'The format of the text * `plain` - Plain * `markdown` - Markdown' required: - id - order - page_id - parent_element_id - type CheckboxElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The input's default value. required: type: boolean default: false description: Whether this form element is a required field. required: - id - order - page_id - parent_element_id - type ImageElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ImageConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' image_source_type: $ref: '#/components/schemas/ImageSourceTypeEnum' image_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The image file image_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the image file alt_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Text that is displayed when the image can't load required: - order - type FileInputElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputAndTypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input multiple: type: boolean description: Whether this file input allows users to choose multiple files required: type: boolean description: Whether this form element is a required field. default_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file name. default_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file url. help_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The help text which should be visible on the element. max_filesize: type: integer maximum: 100 minimum: 1 default: 5 description: Whether to show a preview of image files. allowed_filetypes: description: Allowed file types for this input. preview: type: boolean description: Whether to show a preview of image files. required: - order - type LinkElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. variant: allOf: - $ref: '#/components/schemas/VariantEnum' description: 'The variant of the link. * `link` - Link * `button` - Button' required: - order - type AuthFormElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonInputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. user_source_id: type: integer nullable: true description: Display the auth form for the selected user source login_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the login button required: - id - order - page_id - parent_element_id - type MenuElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonAndLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. orientation: $ref: '#/components/schemas/OrientationEnum' alignment: $ref: '#/components/schemas/AlignmentD61Enum' menu_items: type: array items: $ref: '#/components/schemas/MenuItem' InputFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' RepeatElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. orientation: $ref: '#/components/schemas/OrientationEnum' items_per_row: description: The amount repetitions per row, per device type. Only applicable when the orientation is horizontal. horizontal_gap: type: integer maximum: 2000 minimum: 0 description: The amount of horizontal space between repeat elements. vertical_gap: type: integer maximum: 2000 minimum: 0 description: The amount of vertical space between repeat elements. required: - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - type RatingElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - id - order - page_id - parent_element_id - type PatchedMoveElement: type: object properties: before_id: type: integer nullable: true description: If provided, the element is moved before the element with this Id. Otherwise the element is placed at the end of the page. parent_element_id: type: integer nullable: true description: If provided, the element is moved as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. target_page_id: type: integer nullable: true description: If provided, the new target page for the element. CollectionElementPropertyOptions: type: object description: 'Mixin to a DRF serializer class to raise an exception if data with unknown fields is provided to the serializer.' properties: schema_property: type: string description: The name of the property in the schema this option belongs to. maxLength: 225 filterable: type: boolean description: Whether this element is filterable or not by visitors. sortable: type: boolean description: Whether this element is sortable or not by visitors. searchable: type: boolean description: Whether this element is searchable or not by visitors. required: - schema_property InputConfigBlock: type: object description: Style overrides for this element. properties: input: $ref: '#/components/schemas/input_horizontal_padding' RepeatElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. orientation: $ref: '#/components/schemas/OrientationEnum' items_per_row: description: The amount repetitions per row, per device type. Only applicable when the orientation is horizontal. horizontal_gap: type: integer maximum: 2000 minimum: 0 description: The amount of horizontal space between repeat elements. vertical_gap: type: integer maximum: 2000 minimum: 0 description: The amount of vertical space between repeat elements. required: - id - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - page_id - parent_element_id - type Heading4TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' ButtonElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The caption of the button. required: - order - type ButtonConfigBlock: type: object description: Style overrides for this element. properties: button: $ref: '#/components/schemas/button_active_border_color' DateFormatEnum: enum: - EU - US - ISO type: string description: '* `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' OrientationEnum: enum: - horizontal - vertical type: string description: '* `horizontal` - Horizontal * `vertical` - Vertical' PatchedElement_TypeUpdateElement: anyOf: - $ref: '#/components/schemas/HeadingElementUpdateElement' - $ref: '#/components/schemas/TextElementUpdateElement' - $ref: '#/components/schemas/RatingElementUpdateElement' - $ref: '#/components/schemas/RatingInputElementUpdateElement' - $ref: '#/components/schemas/LinkElementUpdateElement' - $ref: '#/components/schemas/ImageElementUpdateElement' - $ref: '#/components/schemas/InputTextElementUpdateElement' - $ref: '#/components/schemas/ColumnElementUpdateElement' - $ref: '#/components/schemas/ButtonElementUpdateElement' - $ref: '#/components/schemas/TableElementUpdateElement' - $ref: '#/components/schemas/RepeatElementUpdateElement' - $ref: '#/components/schemas/RecordSelectorElementUpdateElement' - $ref: '#/components/schemas/FormContainerElementUpdateElement' - $ref: '#/components/schemas/ChoiceElementUpdateElement' - $ref: '#/components/schemas/CheckboxElementUpdateElement' - $ref: '#/components/schemas/IFrameElementUpdateElement' - $ref: '#/components/schemas/DateTimePickerElementUpdateElement' - $ref: '#/components/schemas/HeaderElementUpdateElement' - $ref: '#/components/schemas/FooterElementUpdateElement' - $ref: '#/components/schemas/MenuElementUpdateElement' - $ref: '#/components/schemas/SimpleContainerElementUpdateElement' - $ref: '#/components/schemas/AuthFormElementUpdateElement' - $ref: '#/components/schemas/FileInputElementUpdateElement' SimpleContainerElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. required: - id - order - page_id - parent_element_id - type VariantEnum: enum: - link - button type: string description: '* `link` - Link * `button` - Button' FileInputElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputAndTypographyConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input multiple: type: boolean description: Whether this file input allows users to choose multiple files required: type: boolean description: Whether this form element is a required field. default_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file name. default_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This input's default file url. help_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The help text which should be visible on the element. max_filesize: type: integer maximum: 100 minimum: 1 default: 5 description: Whether to show a preview of image files. allowed_filetypes: description: Allowed file types for this input. preview: type: boolean description: Whether to show a preview of image files. required: - id - order - page_id - parent_element_id - type Element_TypeElement: oneOf: - $ref: '#/components/schemas/HeadingElementElement' - $ref: '#/components/schemas/TextElementElement' - $ref: '#/components/schemas/RatingElementElement' - $ref: '#/components/schemas/RatingInputElementElement' - $ref: '#/components/schemas/LinkElementElement' - $ref: '#/components/schemas/ImageElementElement' - $ref: '#/components/schemas/InputTextElementElement' - $ref: '#/components/schemas/ColumnElementElement' - $ref: '#/components/schemas/ButtonElementElement' - $ref: '#/components/schemas/TableElementElement' - $ref: '#/components/schemas/RepeatElementElement' - $ref: '#/components/schemas/RecordSelectorElementElement' - $ref: '#/components/schemas/FormContainerElementElement' - $ref: '#/components/schemas/ChoiceElementElement' - $ref: '#/components/schemas/CheckboxElementElement' - $ref: '#/components/schemas/IFrameElementElement' - $ref: '#/components/schemas/DateTimePickerElementElement' - $ref: '#/components/schemas/HeaderElementElement' - $ref: '#/components/schemas/FooterElementElement' - $ref: '#/components/schemas/MenuElementElement' - $ref: '#/components/schemas/SimpleContainerElementElement' - $ref: '#/components/schemas/AuthFormElementElement' - $ref: '#/components/schemas/FileInputElementElement' discriminator: propertyName: type mapping: heading: '#/components/schemas/HeadingElementElement' text: '#/components/schemas/TextElementElement' rating: '#/components/schemas/RatingElementElement' rating_input: '#/components/schemas/RatingInputElementElement' link: '#/components/schemas/LinkElementElement' image: '#/components/schemas/ImageElementElement' input_text: '#/components/schemas/InputTextElementElement' column: '#/components/schemas/ColumnElementElement' button: '#/components/schemas/ButtonElementElement' table: '#/components/schemas/TableElementElement' repeat: '#/components/schemas/RepeatElementElement' record_selector: '#/components/schemas/RecordSelectorElementElement' form_container: '#/components/schemas/FormContainerElementElement' choice: '#/components/schemas/ChoiceElementElement' checkbox: '#/components/schemas/CheckboxElementElement' iframe: '#/components/schemas/IFrameElementElement' datetime_picker: '#/components/schemas/DateTimePickerElementElement' header: '#/components/schemas/HeaderElementElement' footer: '#/components/schemas/FooterElementElement' menu: '#/components/schemas/MenuElementElement' simple_container: '#/components/schemas/SimpleContainerElementElement' auth_form: '#/components/schemas/AuthFormElementElement' input_file: '#/components/schemas/FileInputElementElement' OptionTypeEnum: enum: - manual - formulas type: string description: '* `manual` - Manual * `formulas` - Formulas' TypeA5fEnum: enum: - heading - text - rating - rating_input - link - image - input_text - column - button - table - repeat - record_selector - form_container - choice - checkbox - iframe - datetime_picker - header - footer - menu - simple_container - auth_form - input_file type: string description: '* `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' ButtonTableAndTypographyButtonConfigBlock: type: object description: Style overrides for this element. properties: button: $ref: '#/components/schemas/button_active_border_color' table: $ref: '#/components/schemas/heading_6_text_decoration' header_button: $ref: '#/components/schemas/button_active_border_color' RatingElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - order - type LinkFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' RatingInputElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this field Heading1TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' FormContainerElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' submit_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple reset_initial_values_post_submission: type: boolean description: Whether to reset the form to using its initial values after a successful form submission. required: - order - type image_constraint: type: object properties: image_max_height: type: integer description: The image max height image_alignment: $ref: '#/components/schemas/ImageAlignmentEnum' image_max_width: type: integer maximum: 100 minimum: 0 description: The max-width for this image element. image_border_radius: type: integer maximum: 100 minimum: 0 description: The border radius for this image element. image_constraint: allOf: - $ref: '#/components/schemas/ImageConstraintEnum' description: 'The image constraint to apply to this image * `cover` - Cover * `contain` - Contain * `full-width` - Full Width' button_active_border_color: type: object properties: button_font_family: type: string maxLength: 250 button_font_size: type: integer maximum: 32767 minimum: -32768 button_font_weight: $ref: '#/components/schemas/ButtonFontWeightEnum' button_alignment: $ref: '#/components/schemas/ButtonAlignmentEnum' button_text_alignment: $ref: '#/components/schemas/ButtonTextAlignmentEnum' button_width: $ref: '#/components/schemas/ButtonWidthEnum' button_background_color: type: string description: The background color of buttons maxLength: 255 button_text_color: type: string description: The text color of buttons maxLength: 255 button_border_color: type: string description: The border color of buttons maxLength: 255 button_border_size: type: integer maximum: 32767 minimum: -32768 description: Button border size button_border_radius: type: integer maximum: 32767 minimum: -32768 description: Button border radius button_vertical_padding: type: integer maximum: 32767 minimum: -32768 description: Button vertical padding button_horizontal_padding: type: integer maximum: 32767 minimum: -32768 description: Button horizontal padding button_hover_background_color: type: string description: The background color of buttons when hovered maxLength: 255 button_hover_text_color: type: string description: The text color of buttons when hovered maxLength: 255 button_hover_border_color: type: string description: The border color of buttons when hovered maxLength: 255 button_active_background_color: type: string description: The background color of buttons when active maxLength: 255 button_active_text_color: type: string description: The text color of buttons when active maxLength: 255 button_active_border_color: type: string description: The border color of buttons when active maxLength: 255 FooterElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer required: - order - type Heading2TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' TargetEnum: enum: - self - blank type: string description: '* `self` - Self * `blank` - Blank' ButtonButtonConfigBlock: type: object description: Style overrides for this element. properties: button: $ref: '#/components/schemas/button_active_border_color' header_button: $ref: '#/components/schemas/button_active_border_color' FooterElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. share_type: $ref: '#/components/schemas/ShareTypeEnum' pages: type: array items: type: integer required: - id - order - page_id - parent_element_id - type TableElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonTableAndTypographyButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. fields: type: array items: $ref: '#/components/schemas/CollectionField' orientation: description: The table orientation (horizontal or vertical) for each device type required: - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - type Visibility789Enum: enum: - all - logged-in - not-logged type: string description: '* `all` - All * `logged-in` - Logged In * `not-logged` - Not Logged' Element_TypePublicElement: oneOf: - $ref: '#/components/schemas/HeadingElementPublicElement' - $ref: '#/components/schemas/TextElementPublicElement' - $ref: '#/components/schemas/RatingElementPublicElement' - $ref: '#/components/schemas/RatingInputElementPublicElement' - $ref: '#/components/schemas/LinkElementPublicElement' - $ref: '#/components/schemas/ImageElementPublicElement' - $ref: '#/components/schemas/InputTextElementPublicElement' - $ref: '#/components/schemas/ColumnElementPublicElement' - $ref: '#/components/schemas/ButtonElementPublicElement' - $ref: '#/components/schemas/TableElementPublicElement' - $ref: '#/components/schemas/RepeatElementPublicElement' - $ref: '#/components/schemas/RecordSelectorElementPublicElement' - $ref: '#/components/schemas/FormContainerElementPublicElement' - $ref: '#/components/schemas/ChoiceElementPublicElement' - $ref: '#/components/schemas/CheckboxElementPublicElement' - $ref: '#/components/schemas/IFrameElementPublicElement' - $ref: '#/components/schemas/DateTimePickerElementPublicElement' - $ref: '#/components/schemas/HeaderElementPublicElement' - $ref: '#/components/schemas/FooterElementPublicElement' - $ref: '#/components/schemas/MenuElementPublicElement' - $ref: '#/components/schemas/SimpleContainerElementPublicElement' - $ref: '#/components/schemas/AuthFormElementPublicElement' - $ref: '#/components/schemas/FileInputElementPublicElement' discriminator: propertyName: type mapping: heading: '#/components/schemas/HeadingElementPublicElement' text: '#/components/schemas/TextElementPublicElement' rating: '#/components/schemas/RatingElementPublicElement' rating_input: '#/components/schemas/RatingInputElementPublicElement' link: '#/components/schemas/LinkElementPublicElement' image: '#/components/schemas/ImageElementPublicElement' input_text: '#/components/schemas/InputTextElementPublicElement' column: '#/components/schemas/ColumnElementPublicElement' button: '#/components/schemas/ButtonElementPublicElement' table: '#/components/schemas/TableElementPublicElement' repeat: '#/components/schemas/RepeatElementPublicElement' record_selector: '#/components/schemas/RecordSelectorElementPublicElement' form_container: '#/components/schemas/FormContainerElementPublicElement' choice: '#/components/schemas/ChoiceElementPublicElement' checkbox: '#/components/schemas/CheckboxElementPublicElement' iframe: '#/components/schemas/IFrameElementPublicElement' datetime_picker: '#/components/schemas/DateTimePickerElementPublicElement' header: '#/components/schemas/HeaderElementPublicElement' footer: '#/components/schemas/FooterElementPublicElement' menu: '#/components/schemas/MenuElementPublicElement' simple_container: '#/components/schemas/SimpleContainerElementPublicElement' auth_form: '#/components/schemas/AuthFormElementPublicElement' input_file: '#/components/schemas/FileInputElementPublicElement' TableElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonTableAndTypographyButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. schema_property: type: string nullable: true description: A multiple valued schema property to use for the data source. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: true description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: true description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. fields: type: array items: $ref: '#/components/schemas/CollectionField' orientation: description: The table orientation (horizontal or vertical) for each device type required: - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable Heading2FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' ValidationTypeEnum: enum: - any - email - integer type: string description: '* `any` - Any * `email` - Email * `integer` - Integer' DateTimePickerElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this date time picker required: type: boolean default: false description: Whether this form element is a required field. default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This date time picker input's default value. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' default: EU description: 'EU (25/04/2024), US (04/25/2024) or ISO (2024-04-25) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' include_time: type: boolean default: false description: Whether to include time in the representation of the date time_format: allOf: - $ref: '#/components/schemas/TimeFormatEnum' default: '24' description: '24 (14:00) or 12 (02:30) PM * `24` - 24 hour * `12` - 12 hour' required: - id - order - page_id - parent_element_id - type BodyTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' CollectionField: type: object description: 'This serializer transform the flat properties object from/to a config dict property. This allows us to see the field on the frontend side as a simple polymorphic object.' properties: id: type: integer readOnly: true uid: type: string format: uuid name: type: string description: The name of the field. maxLength: 225 type: type: string description: The type of the field. maxLength: 225 styles: nullable: true description: The theme overrides for this field required: - id - type RatingInputElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this field required: - order - type FormContainerElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. submit_button_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple reset_initial_values_post_submission: type: boolean description: Whether to reset the form to using its initial values after a successful form submission. TimeFormatEnum: enum: - '24' - '12' type: string description: '* `24` - 24 hour * `12` - 12 hour' InputTextElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This text input's default value. required: type: boolean default: false description: Whether this form element is a required field. validation_type: allOf: - $ref: '#/components/schemas/ValidationTypeEnum' description: 'Optionally set the validation type to use when applying form data. * `any` - Any * `email` - Email * `integer` - Integer' placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. is_multiline: type: boolean default: false description: Whether this text input is multiline. rows: type: integer maximum: 100 minimum: 1 default: 3 description: Number of rows displayed by the rendered input element input_type: allOf: - $ref: '#/components/schemas/InputTypeEnum' default: text description: 'The type of the input, not applicable for multiline inputs. * `text` - Text * `password` - Password' required: - order - type Alignment6d7Enum: enum: - top - center - bottom type: string description: '* `top` - Top * `center` - Center * `bottom` - Bottom' BodyFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' IFrameElementUpdateElement: type: object properties: css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. source_type: allOf: - $ref: '#/components/schemas/SourceTypeEnum' default: url url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the page to embed embed: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Inline HTML to embed height: type: integer maximum: 2000 minimum: 1 default: 300 description: Height in pixels of the iframe SimpleContainerElementCreateElement: type: object description: 'This serializer allow to set the type of an element and the element id before which we want to insert the new element.' properties: order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. before_id: type: integer description: If provided, creates the element before the element with the given id. type: allOf: - $ref: '#/components/schemas/TypeA5fEnum' description: 'The type of the element. * `heading` - heading * `text` - text * `rating` - rating * `rating_input` - rating_input * `link` - link * `image` - image * `input_text` - input_text * `column` - column * `button` - button * `table` - table * `repeat` - repeat * `record_selector` - record_selector * `form_container` - form_container * `choice` - choice * `checkbox` - checkbox * `iframe` - iframe * `datetime_picker` - datetime_picker * `header` - header * `footer` - footer * `menu` - menu * `simple_container` - simple_container * `auth_form` - auth_form * `input_file` - input_file' parent_element_id: type: integer nullable: true description: If provided, creates the element as a child of the element with the given id. place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: allOf: - $ref: '#/components/schemas/Visibility789Enum' default: all visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' required: - order - type StyleBackgroundEnum: enum: - none - color - image type: string description: '* `none` - None * `color` - Color * `image` - Image' MenuItem: type: object description: Serializes the MenuItemElement. properties: id: type: integer readOnly: true variant: allOf: - $ref: '#/components/schemas/VariantEnum' description: 'The variant of the link. * `link` - Link * `button` - Button' type: allOf: - $ref: '#/components/schemas/MenuItemTypeEnum' description: 'The type of the Menu Item. * `button` - Button * `link` - Link * `separator` - Separator * `spacer` - Spacer' menu_item_order: type: integer maximum: 2147483647 minimum: 0 uid: type: string format: uuid name: type: string description: The name of the Menu Item. maxLength: 225 navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. parent_menu_item: type: integer nullable: true description: The parent MenuItemElement element, if it is a nested item. target: allOf: - $ref: '#/components/schemas/TargetEnum' description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' children: type: array items: type: object additionalProperties: {} description: A MenuItemElement that is a child of this instance. required: - id - menu_item_order - name UserFile: type: object properties: size: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 mime_type: type: string maxLength: 127 is_image: type: boolean image_width: type: integer maximum: 2147483647 minimum: 0 nullable: true image_height: type: integer maximum: 2147483647 minimum: 0 nullable: true uploaded_at: type: string format: date-time readOnly: true url: type: string format: uri readOnly: true thumbnails: type: object additionalProperties: {} readOnly: true name: type: string readOnly: true original_name: type: string maxLength: 255 required: - name - original_name - size - thumbnails - uploaded_at - url RecordSelectorElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. data_source_id: type: integer nullable: true description: The data source we want to show in the element for. Only data_sources that return list are allowed. items_per_page: type: integer minimum: 0 default: 20 description: The amount item loaded with each page. button_load_more_label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The label of the show more button property_options: type: array items: $ref: '#/components/schemas/CollectionElementPropertyOptions' description: The schema property options that can be set for the collection element. is_publicly_sortable: type: boolean readOnly: true default: false description: Whether this collection element is publicly sortable. is_publicly_filterable: type: boolean readOnly: true default: false description: Whether this collection element is publicly filterable. is_publicly_searchable: type: boolean readOnly: true default: true description: Whether this collection element is publicly searchable. required: type: boolean default: false description: Whether this form element is a required field. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this record selector default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: This record selector default value. placeholder: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The placeholder text which should be applied to the element. multiple: type: boolean default: false description: Whether this record selector allows users to choose multiple values. option_name_suffix: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The formula to generate the displayed option name suffix required: - id - is_publicly_filterable - is_publicly_searchable - is_publicly_sortable - order - page_id - parent_element_id - type Element_TypeCreateElement: oneOf: - $ref: '#/components/schemas/HeadingElementCreateElement' - $ref: '#/components/schemas/TextElementCreateElement' - $ref: '#/components/schemas/RatingElementCreateElement' - $ref: '#/components/schemas/RatingInputElementCreateElement' - $ref: '#/components/schemas/LinkElementCreateElement' - $ref: '#/components/schemas/ImageElementCreateElement' - $ref: '#/components/schemas/InputTextElementCreateElement' - $ref: '#/components/schemas/ColumnElementCreateElement' - $ref: '#/components/schemas/ButtonElementCreateElement' - $ref: '#/components/schemas/TableElementCreateElement' - $ref: '#/components/schemas/RepeatElementCreateElement' - $ref: '#/components/schemas/RecordSelectorElementCreateElement' - $ref: '#/components/schemas/FormContainerElementCreateElement' - $ref: '#/components/schemas/ChoiceElementCreateElement' - $ref: '#/components/schemas/CheckboxElementCreateElement' - $ref: '#/components/schemas/IFrameElementCreateElement' - $ref: '#/components/schemas/DateTimePickerElementCreateElement' - $ref: '#/components/schemas/HeaderElementCreateElement' - $ref: '#/components/schemas/FooterElementCreateElement' - $ref: '#/components/schemas/MenuElementCreateElement' - $ref: '#/components/schemas/SimpleContainerElementCreateElement' - $ref: '#/components/schemas/AuthFormElementCreateElement' - $ref: '#/components/schemas/FileInputElementCreateElement' discriminator: propertyName: type mapping: heading: '#/components/schemas/HeadingElementCreateElement' text: '#/components/schemas/TextElementCreateElement' rating: '#/components/schemas/RatingElementCreateElement' rating_input: '#/components/schemas/RatingInputElementCreateElement' link: '#/components/schemas/LinkElementCreateElement' image: '#/components/schemas/ImageElementCreateElement' input_text: '#/components/schemas/InputTextElementCreateElement' column: '#/components/schemas/ColumnElementCreateElement' button: '#/components/schemas/ButtonElementCreateElement' table: '#/components/schemas/TableElementCreateElement' repeat: '#/components/schemas/RepeatElementCreateElement' record_selector: '#/components/schemas/RecordSelectorElementCreateElement' form_container: '#/components/schemas/FormContainerElementCreateElement' choice: '#/components/schemas/ChoiceElementCreateElement' checkbox: '#/components/schemas/CheckboxElementCreateElement' iframe: '#/components/schemas/IFrameElementCreateElement' datetime_picker: '#/components/schemas/DateTimePickerElementCreateElement' header: '#/components/schemas/HeaderElementCreateElement' footer: '#/components/schemas/FooterElementCreateElement' menu: '#/components/schemas/MenuElementCreateElement' simple_container: '#/components/schemas/SimpleContainerElementCreateElement' auth_form: '#/components/schemas/AuthFormElementCreateElement' input_file: '#/components/schemas/FileInputElementCreateElement' StyleWidthChildEnum: enum: - normal - medium - small type: string description: '* `normal` - Normal * `medium` - Medium * `small` - Small' Heading4FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' ShareTypeEnum: enum: - all - only - except type: string description: '* `all` - All * `only` - Only * `except` - Except' ImageElementPublicElement: type: object description: Basic element serializer mostly for returned values. properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ImageConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. image_source_type: $ref: '#/components/schemas/ImageSourceTypeEnum' image_file: $ref: '#/components/schemas/UserFile' image_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A link to the image file alt_text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Text that is displayed when the image can't load required: - id - order - page_id - parent_element_id - type Element: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. required: - id - order - page_id - parent_element_id - type Heading1FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' NavigationTypeEnum: enum: - page - custom type: string description: '* `page` - Page * `custom` - Custom' RatingElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: description: The theme overrides for this element style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 rating_style: allOf: - $ref: '#/components/schemas/RatingStyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - id - order - page_id - parent_element_id - type MenuItemTypeEnum: enum: - button - link - separator - spacer type: string description: '* `button` - Button * `link` - Link * `separator` - Separator * `spacer` - Spacer' CheckboxElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/InputConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. label: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text label for this input default_value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The input's default value. required: type: boolean default: false description: Whether this form element is a required field. required: - id - order - page_id - parent_element_id - type LinkElementElement: type: object description: 'Basic element serializer mostly for returned values. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicElementSerializer when you update this one.' properties: id: type: integer readOnly: true page_id: type: integer readOnly: true type: type: string readOnly: true description: The type of the element. order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. parent_element_id: type: integer nullable: true description: The parent element, if inside a container. readOnly: true place_in_container: type: string nullable: true description: The place in the container. maxLength: 255 css_classes: type: string description: The additional CSS classes for this element. maxLength: 255 visibility: $ref: '#/components/schemas/Visibility789Enum' visibility_condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Change element visibility depending on a formula value styles: $ref: '#/components/schemas/ButtonLinkConfigBlock' style_border_top_color: type: string description: Top border color. maxLength: 255 style_border_top_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the top border. style_padding_top: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the top border. style_margin_top: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the top border. style_border_bottom_color: type: string description: Bottom border color maxLength: 255 style_border_bottom_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the bottom border. style_padding_bottom: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the bottom border. style_margin_bottom: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the bottom border. style_border_left_color: type: string description: Left border color maxLength: 255 style_border_left_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the left border. style_padding_left: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the left border. style_margin_left: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the left border. style_border_right_color: type: string description: Right border color maxLength: 255 style_border_right_size: type: integer maximum: 2147483647 minimum: 0 description: Pixel height of the right border. style_padding_right: type: integer maximum: 2147483647 minimum: 0 description: Padding size of the right border. style_margin_right: type: integer maximum: 2147483647 minimum: 0 description: Margin size of the right border. style_background_radius: type: integer maximum: 32767 minimum: -32768 description: Background radius. style_border_radius: type: integer maximum: 32767 minimum: -32768 description: Border radius. style_background: allOf: - $ref: '#/components/schemas/StyleBackgroundEnum' description: 'What type of background the element should have. * `none` - None * `color` - Color * `image` - Image' style_background_color: type: string description: The background color if `style_background` is color. maxLength: 255 style_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The background image file style_background_mode: allOf: - $ref: '#/components/schemas/StyleBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' style_width: allOf: - $ref: '#/components/schemas/StyleWidthEnum' description: 'Indicates the width of the root element. * `full` - Full * `full-width` - Full Width * `normal` - Normal * `medium` - Medium * `small` - Small' style_width_child: allOf: - $ref: '#/components/schemas/StyleWidthChildEnum' description: 'Indicates the width of the child element. * `normal` - Normal * `medium` - Medium * `small` - Small' role_type: $ref: '#/components/schemas/RoleTypeEnum' roles: description: User roles associated with this element, used in conjunction with role_type. navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The value of the element. Must be an formula. variant: allOf: - $ref: '#/components/schemas/VariantEnum' description: 'The variant of the link. * `link` - Link * `button` - Button' required: - id - order - page_id - parent_element_id - type securitySchemes: Database token: type: http scheme: bearer bearerFormat: Token your_token JWT: type: http scheme: bearer bearerFormat: JWT your_token UserSource JWT: type: http scheme: bearer bearerFormat: JWT your_token