openapi: 3.0.3 info: title: Baserow API spec Admin Applications 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: Applications paths: /api/applications/: get: operationId: list_all_applications description: Lists all the applications that the user has access to. The properties that belong to the application can differ per type. An application always belongs to a single workspace. All the applications of the workspaces that the user has access to are going to be listed here. tags: - Applications security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ApplicationApplication' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP 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/applications/{application_id}/: get: operationId: workspace_get_application description: Returns the requested application if the authorized user is in the application's workspace. The properties that belong to the application can differ per type. parameters: - in: path name: application_id schema: type: integer description: Returns the application related to the provided value. required: true tags: - Applications security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationApplication' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - 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_APPLICATION_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: '' patch: operationId: workspace_update_application description: Updates the existing application related to the provided `application_id` param if the authorized user is in the application's workspace. It is not possible to change the type, but properties like the name can be changed. 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: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: application_id schema: type: integer description: Updates the application related to the provided value. required: true tags: - Applications requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedApplicationBaseApplicationUpdatePolymorphic' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedApplicationBaseApplicationUpdatePolymorphic' multipart/form-data: schema: $ref: '#/components/schemas/PatchedApplicationBaseApplicationUpdatePolymorphic' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationApplication' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - 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_APPLICATION_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: workspace_delete_application description: Deletes an application if the authorized user is in the application's workspace. All the related children are also going to be deleted. For example in case of a database application all the underlying tables, fields, views and rows are going to be deleted. 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: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: application_id schema: type: integer description: Deletes the application related to the provided value. required: true tags: - Applications 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_USER_NOT_IN_GROUP - ERROR_CANNOT_DELETE_ALREADY_DELETED_ITEM 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_APPLICATION_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/applications/{application_id}/duplicate/async/: post: operationId: duplicate_application_async description: Duplicate an application if the authorized user is in the application's workspace. All the related children are also going to be duplicated. For example in case of a database application all the underlying tables, fields, views and rows are going to be duplicated. 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: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: application_id schema: type: integer description: The id of the application to duplicate. required: true tags: - Applications security: - UserSource JWT: [] - JWT: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/DuplicateApplicationJobTypeResponse' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_APPLICATION_NOT_IN_GROUP - ERROR_MAX_JOB_COUNT_EXCEEDED 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_APPLICATION_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/applications/workspace/{workspace_id}/: get: operationId: workspace_list_applications description: Lists all the applications of the workspace related to the provided `workspace_id` parameter if the authorized user is in that workspace. If theworkspace is related to a template, then this endpoint will be publicly accessible. The properties that belong to the application can differ per type. An application always belongs to a single workspace. parameters: - in: path name: workspace_id schema: type: integer description: Returns only applications that are in the workspace related to the provided value. required: true tags: - Applications security: - UserSource JWT: [] - JWT: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ApplicationApplication' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP 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_GROUP_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: workspace_create_application description: Creates a new application based on the provided type. The newly created application is going to be added to the workspace related to the provided `workspace_id` parameter. If the authorized user does not belong to the workspace an error will be returned. 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: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: workspace_id schema: type: integer description: Creates an application for the workspace related to the provided value. required: true tags: - Applications requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationBaseApplicationCreatePolymorphic' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ApplicationBaseApplicationCreatePolymorphic' multipart/form-data: schema: $ref: '#/components/schemas/ApplicationBaseApplicationCreatePolymorphic' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationApplication' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - 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_GROUP_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/applications/workspace/{workspace_id}/order/: post: operationId: workspace_order_applications description: Changes the order of the provided application ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order of the not provided tables will be set to `0`. 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: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: workspace_id schema: type: integer description: Updates the order of the applications in the workspace related to the provided value. required: true tags: - Applications requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderApplications' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderApplications' multipart/form-data: schema: $ref: '#/components/schemas/OrderApplications' required: true 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_USER_NOT_IN_GROUP - ERROR_APPLICATION_NOT_IN_GROUP 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_GROUP_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: 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' LinkTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' Page: type: object description: '👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicPageSerializer when you update this one.' properties: id: type: integer readOnly: true name: type: string maxLength: 255 path: type: string maxLength: 255 path_params: type: array items: $ref: '#/components/schemas/PathParam' order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. builder_id: type: integer readOnly: true shared: type: boolean readOnly: true visibility: allOf: - $ref: '#/components/schemas/VisibilityC5fEnum' readOnly: true description: 'Controls the page''s visibility. When set to ''logged-in'', the builder''s login_page must also be set. * `all` - All * `logged-in` - Logged In' role_type: allOf: - $ref: '#/components/schemas/RoleTypeEnum' readOnly: true description: 'Role type is used in conjunction with roles to control access to this page. * `allow_all` - Allow All * `allow_all_except` - Allow All Except * `disallow_all_except` - Disallow All Except' roles: readOnly: true description: List of user roles that are associated with this page. Used in conjunction with role_type. query_params: type: array items: $ref: '#/components/schemas/QueryParam' required: - builder_id - id - name - order - path - role_type - roles - shared - visibility Type76dEnum: enum: - database - dashboard - automation - builder type: string description: '* `database` - database * `dashboard` - dashboard * `automation` - automation * `builder` - builder' BuilderBaseApplicationCreatePolymorphic: type: object properties: name: type: string maxLength: 160 type: $ref: '#/components/schemas/Type76dEnum' init_with_data: type: boolean default: false favicon_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The favicon image file login_page_id: type: integer nullable: true description: The login page for this application. This is related to the visibility settings of builder pages. scripts: type: array items: $ref: '#/components/schemas/CustomScript' description: Custom CSS/JS scripts for this builder custom_code: allOf: - $ref: '#/components/schemas/CustomCode' description: Custom CSS/JS code for this builder required: - name - type PatchedApplicationBaseApplicationUpdatePolymorphic: anyOf: - $ref: '#/components/schemas/DatabaseBaseApplicationUpdatePolymorphic' - $ref: '#/components/schemas/DashboardBaseApplicationUpdatePolymorphic' - $ref: '#/components/schemas/AutomationBaseApplicationUpdatePolymorphic' - $ref: '#/components/schemas/BuilderBaseApplicationUpdatePolymorphic' 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' ButtonTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' LoadTypeEnum: enum: - defer - async type: string description: '* `` - None * `defer` - Defer * `async` - Async' ButtonWidthEnum: enum: - auto - full type: string description: '* `auto` - Auto * `full` - Full' ApplicationApplication: oneOf: - $ref: '#/components/schemas/DatabaseApplication' - $ref: '#/components/schemas/DashboardApplication' - $ref: '#/components/schemas/AutomationApplication' - $ref: '#/components/schemas/BuilderApplication' discriminator: propertyName: type mapping: database: '#/components/schemas/DatabaseApplication' dashboard: '#/components/schemas/DashboardApplication' automation: '#/components/schemas/AutomationApplication' builder: '#/components/schemas/BuilderApplication' 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' DatabaseBaseApplicationUpdatePolymorphic: type: object properties: name: type: string maxLength: 160 required: - name 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' CustomScriptTypeEnum: enum: - stylesheet - javascript type: string description: '* `stylesheet` - Stylesheet * `javascript` - JavaScript' BodyTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' CustomScript: type: object properties: id: type: integer readOnly: true type: allOf: - $ref: '#/components/schemas/CustomScriptTypeEnum' description: 'The type of script. * `stylesheet` - Stylesheet * `javascript` - JavaScript' url: type: string format: uri description: The URL of the script. maxLength: 200 load_type: description: 'The load type of the script. * `` - None * `defer` - Defer * `async` - Async' oneOf: - $ref: '#/components/schemas/LoadTypeEnum' - $ref: '#/components/schemas/BlankEnum' crossorigin: description: 'The Crossorigin type of the script. * `` - None * `anonymous` - Anonymous * `credentials` - Use credentials' oneOf: - $ref: '#/components/schemas/CrossoriginEnum' - $ref: '#/components/schemas/BlankEnum' required: - id Workspace: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 165 generative_ai_models_enabled: type: string readOnly: true required: - generative_ai_models_enabled - id - name CustomCode: type: object properties: css: type: string description: Custom CSS code. js: type: string description: Custom JavaScript code. 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' AutomationApplication: type: object description: The Automation serializer. properties: id: type: integer readOnly: true name: type: string maxLength: 160 order: type: integer maximum: 2147483647 minimum: 0 type: type: string readOnly: true workspace: allOf: - $ref: '#/components/schemas/Workspace' description: The workspace that the application belongs to. created_on: type: string format: date-time readOnly: true workflows: type: array items: $ref: '#/components/schemas/AutomationWorkflow' readOnly: true description: This field is specific to the `automation` application and contains an array of workflows that are in the automation. required: - created_on - id - name - order - type - workflows - workspace TableHeaderFontWeightEnum: 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' CrossoriginEnum: enum: - anonymous - credentials type: string description: '* `` - None * `anonymous` - Anonymous * `credentials` - Use credentials' Heading3TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' DuplicateApplicationJobTypeResponse: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true description: The type of the job. progress_percentage: type: integer description: A percentage indicating how far along the job is. 100 means that it's finished. state: type: string description: Indicates the state of the import job. human_readable_error: type: string description: A human readable error message indicating what went wrong. created_on: type: string format: date-time readOnly: true updated_on: type: string format: date-time readOnly: true original_application: allOf: - $ref: '#/components/schemas/ApplicationApplication' readOnly: true duplicated_application: allOf: - $ref: '#/components/schemas/ApplicationApplication' readOnly: true required: - created_on - duplicated_application - id - original_application - progress_percentage - state - type - updated_on 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' Heading5TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' DatabaseBaseApplicationCreatePolymorphic: type: object properties: name: type: string maxLength: 160 type: $ref: '#/components/schemas/Type76dEnum' init_with_data: type: boolean default: false required: - name - type DatabaseApplication: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 160 order: type: integer maximum: 2147483647 minimum: 0 type: type: string readOnly: true workspace: allOf: - $ref: '#/components/schemas/Workspace' description: The workspace that the application belongs to. created_on: type: string format: date-time readOnly: true tables: type: array items: $ref: '#/components/schemas/Table' readOnly: true description: This field is specific to the `database` application and contains an array of tables that are in the database. required: - created_on - id - name - order - tables - type - workspace BuilderBaseApplicationUpdatePolymorphic: type: object properties: name: type: string maxLength: 160 favicon_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The favicon image file login_page_id: type: integer nullable: true description: The login page for this application. This is related to the visibility settings of builder pages. scripts: type: array items: $ref: '#/components/schemas/CustomScript' description: Custom CSS/JS scripts for this builder custom_code: allOf: - $ref: '#/components/schemas/CustomCode' description: Custom CSS/JS code for this builder required: - name TableHeaderTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' Heading4TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' DashboardApplication: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 160 order: type: integer maximum: 2147483647 minimum: 0 type: type: string readOnly: true workspace: allOf: - $ref: '#/components/schemas/Workspace' description: The workspace that the application belongs to. created_on: type: string format: date-time readOnly: true description: type: string required: - created_on - id - name - order - type - workspace QueryParam: type: object properties: name: type: string description: The name of the parameter. maxLength: 255 type: allOf: - $ref: '#/components/schemas/TypeC70Enum' description: 'The type of the parameter. * `text` - text * `numeric` - numeric' required: - name - type 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 AutomationBaseApplicationCreatePolymorphic: type: object description: The Automation serializer. properties: name: type: string maxLength: 160 type: $ref: '#/components/schemas/Type76dEnum' init_with_data: type: boolean default: false required: - name - type DashboardBaseApplicationCreatePolymorphic: type: object properties: name: type: string maxLength: 160 type: $ref: '#/components/schemas/Type76dEnum' init_with_data: type: boolean default: false description: type: string required: - name - type VisibilityC5fEnum: enum: - all - logged-in type: string description: '* `all` - All * `logged-in` - Logged In' PageBackgroundModeEnum: enum: - tile - fill - fit type: string description: '* `tile` - Tile * `fill` - Fill * `fit` - Fit' Heading6TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' Table: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. database_id: type: integer readOnly: true data_sync: $ref: '#/components/schemas/DataSync' required: - data_sync - database_id - id - name - order 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' AutomationWorkflow: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. automation_id: type: integer readOnly: true allow_test_run_until: type: string format: date-time nullable: true simulate_until_node_id: type: integer nullable: true description: When set, upon the next workflow run, simulates the dispatch of the workflow until this node and updates the sample_data of the node's service. readOnly: true published_on: type: string readOnly: true state: type: string readOnly: true graph: description: Contains the node graph. notification_recipient_ids: type: array items: type: integer readOnly: true required: - automation_id - id - name - notification_recipient_ids - order - published_on - simulate_until_node_id - state AutomationBaseApplicationUpdatePolymorphic: type: object description: The Automation serializer. properties: name: type: string maxLength: 160 required: - name BlankEnum: enum: - '' 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' ColorTypographyButtonImagePageInputTableLinklink_active_text_decoration: type: object properties: primary_color: type: string maxLength: 255 secondary_color: type: string maxLength: 255 border_color: type: string maxLength: 255 main_success_color: type: string maxLength: 255 main_warning_color: type: string maxLength: 255 main_error_color: type: string maxLength: 255 custom_colors: {} 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' 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 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' page_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The image file page_background_color: type: string description: The background color of the page maxLength: 255 page_background_mode: allOf: - $ref: '#/components/schemas/PageBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' 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 table_border_color: type: string description: The color of the table border maxLength: 255 table_border_size: type: integer maximum: 32767 minimum: -32768 description: Table border size table_border_radius: type: integer maximum: 32767 minimum: -32768 description: Table border radius table_header_background_color: type: string description: The background color of the table header cells maxLength: 255 table_header_text_color: type: string description: The text color of the table header cells maxLength: 255 table_header_font_size: type: integer maximum: 32767 minimum: -32768 description: The font size of the header cells table_header_font_weight: $ref: '#/components/schemas/TableHeaderFontWeightEnum' table_header_font_family: type: string description: The font family of the table header cells maxLength: 250 table_header_text_alignment: $ref: '#/components/schemas/TableHeaderTextAlignmentEnum' table_cell_background_color: type: string description: The background color of the table cells maxLength: 255 table_cell_alternate_background_color: type: string description: The alternate background color of the table cells maxLength: 255 table_cell_alignment: $ref: '#/components/schemas/TableCellAlignmentEnum' table_cell_vertical_padding: type: integer maximum: 32767 minimum: -32768 description: Table cell vertical padding table_cell_horizontal_padding: type: integer maximum: 32767 minimum: -32768 description: Table cell horizontal padding table_vertical_separator_color: type: string description: The color of the table vertical separator maxLength: 255 table_vertical_separator_size: type: integer maximum: 32767 minimum: -32768 description: Table vertical separator size table_horizontal_separator_color: type: string description: The color of the table horizontal separator maxLength: 255 table_horizontal_separator_size: type: integer maximum: 32767 minimum: -32768 description: Table horizontal separator size 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 DataSync: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true table_id: type: integer description: The table where the data is synced into. readOnly: true database_id: type: string readOnly: true synced_properties: type: array items: $ref: '#/components/schemas/DataSyncSyncedProperty' last_sync: type: string format: date-time nullable: true description: Timestamp when the table was last synced. last_error: type: string nullable: true auto_add_new_properties: type: boolean description: If enabled and new properties are detected on sync, then they're automatically added. Note that this means all properties will always be added. two_way_sync: type: boolean description: If enabled, then it's possible to make changes to the synced table. They will automatically be synced with the source data. Note that this is only possible if the data sync type has a two-way sync strategy. required: - database_id - id - synced_properties - table_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' DashboardBaseApplicationUpdatePolymorphic: type: object properties: name: type: string maxLength: 160 description: type: string required: - name ButtonAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' 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' 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' OrderApplications: type: object properties: application_ids: type: array items: type: integer description: Application ids in the desired order. required: - application_ids TableCellAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' Heading1TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' DataSyncSyncedProperty: type: object properties: field_id: type: integer readOnly: true key: type: string description: The matching `key` of the `DataSyncProperty`. maxLength: 255 unique_primary: type: boolean description: Indicates whether the data sync property is used for unique identification when syncing. required: - field_id - key TypeC70Enum: enum: - text - numeric type: string description: '* `text` - text * `numeric` - numeric' ApplicationBaseApplicationCreatePolymorphic: anyOf: - $ref: '#/components/schemas/DatabaseBaseApplicationCreatePolymorphic' - $ref: '#/components/schemas/DashboardBaseApplicationCreatePolymorphic' - $ref: '#/components/schemas/AutomationBaseApplicationCreatePolymorphic' - $ref: '#/components/schemas/BuilderBaseApplicationCreatePolymorphic' 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' ImageAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' PathParam: type: object properties: name: type: string description: The name of the parameter. maxLength: 255 type: allOf: - $ref: '#/components/schemas/TypeC70Enum' description: 'The type of the parameter. * `text` - text * `numeric` - numeric' required: - name - type Heading2TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' BuilderApplication: type: object description: 'The builder serializer. 👉 Mind to update the baserow.contrib.builder.api.domains.serializer.PublicBuilderSerializer file when you update this one if needed.' properties: id: type: integer readOnly: true name: type: string maxLength: 160 order: type: integer maximum: 2147483647 minimum: 0 type: type: string readOnly: true workspace: allOf: - $ref: '#/components/schemas/Workspace' description: The workspace that the application belongs to. created_on: type: string format: date-time readOnly: true favicon_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The favicon image file login_page_id: type: integer nullable: true description: The login page for this application. This is related to the visibility settings of builder pages. pages: type: array items: $ref: '#/components/schemas/Page' readOnly: true description: This field is specific to the `builder` application and contains an array of pages that are in the builder. theme: allOf: - $ref: '#/components/schemas/ColorTypographyButtonImagePageInputTableLinklink_active_text_decoration' readOnly: true description: This field is specific to the `builder` application and contains the theme settings. scripts: type: array items: $ref: '#/components/schemas/CustomScript' readOnly: true description: Scripts to embed for this application custom_code: allOf: - $ref: '#/components/schemas/CustomCode' description: Custom CSS/JS code for this builder required: - created_on - custom_code - id - name - order - pages - scripts - theme - type - workspace ImageConstraintEnum: enum: - cover - contain - full-width type: string description: '* `cover` - Cover * `contain` - Contain * `full-width` - Full Width' 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