README

用于 baserow.io 的 API 客户端

composer require cedricziel/baserow

文档

use CedricZiel\Baserow\Client;

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);

// list all rows in table id 42
$client->listDatabaseTableRows(42);

email_tester - post /api/_health/email/

向提供的电子邮件地址发送测试电子邮件。这对于测试 Baserow 的电子邮件配置很有用，因为错误会明确返回。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->emailTester();

full_health_check - get /api/_health/full/

运行全面健康检查，测试尽可能多的服务和系统。这些健康检查可能是昂贵的操作，例如将文件写入存储等。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->fullHealthCheck();

audit_log_list - get /api/admin/audit-log/

列出给定工作空间 ID 的所有审计日志条目。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogList();

audit_log_action_types - get /api/admin/audit-log/action-types/

列出与审计日志条目相关的所有不同操作类型。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogActionTypes();

async_audit_log_export - post /api/admin/audit-log/export/

创建一个作业，将筛选后的审计日志导出到 CSV 文件。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->asyncAuditLogExport();

audit_log_users - get /api/admin/audit-log/users/

列出在审计日志中执行操作的 所有用户。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogUsers();

audit_log_workspaces - get /api/admin/audit-log/workspaces/

列出与审计日志条目相关的所有不同工作空间名称。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogWorkspaces();

list_auth_providers - get /api/admin/auth-provider/

列出所有可用的身份验证提供程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listAuthProviders();

create_auth_provider - post /api/admin/auth-provider/

创建新的身份验证提供程序。这可以用于启用与第三方服务（如 Google 或 Facebook）的身份验证。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createAuthProvider();

get_auth_provider - get /api/admin/auth-provider/{auth_provider_id}/

获取身份验证提供程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getAuthProvider();

update_auth_provider - patch /api/admin/auth-provider/{auth_provider_id}/

更新新的身份验证提供程序。这可以用于启用与第三方服务（如 Google 或 Facebook）的身份验证。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateAuthProvider();

delete_auth_provider - delete /api/admin/auth-provider/{auth_provider_id}/

删除身份验证提供程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteAuthProvider();

admin_dashboard - get /api/admin/dashboard/

返回过去 24 小时、7 天和 30 天内的新用户和活跃用户。`previous_` 值是该时期之前的值，例如 `previous_new_users_last_24_hours` 是从 48 小时前到 24 小时前注册的新用户。它可以用来计算注册数量的增加或减少。还包括过去 30 天每天的新用户和活跃用户列表。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminDashboard();

admin_list_groups - get /api/admin/groups/

该端点已被弃用，并替换为新的端点，admin_list_workspaces。

对该端点的支持将在 2024 年结束。

如果请求的用户是工作人员，则返回所有组及其详细信息。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminListGroups();

admin_delete_group - delete /api/admin/groups/{group_id}/

该端点已被弃用，并替换为新的端点，admin_delete_workspace。

对该端点的支持将在 2024 年结束。

如果请求的用户是工作人员，则删除指定的组和该组中的应用程序。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminDeleteGroup();

admin_list_users - get /api/admin/users/

如果请求的用户是工作人员，则返回所有用户及其详细信息。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminListUsers();

admin_create_user - post /api/admin/users/

如果请求的用户是工作人员，则创建并返回新的用户。即使新注册被禁用，此操作也有效。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminCreateUser();

admin_edit_user - patch /api/admin/users/{user_id}/

如果请求的用户是工作人员，则更新指定的用户属性并返回更新的用户。您不能将自己更新为不再具有管理员或活跃状态。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminEditUser();

admin_delete_user - delete /api/admin/users/{user_id}/

如果请求用户拥有管理员权限，则删除指定的用户。您不能删除自己。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminDeleteUser();

admin_impersonate_user - post /api/admin/users/impersonate/

此端点允许通过请求JWT令牌和用户对象，由员工冒充另一个用户。请求用户必须拥有员工访问权限才能进行此操作。不能冒充超级用户或员工。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminImpersonateUser();

admin_list_workspaces - get /api/admin/workspaces/

如果请求用户是员工，则返回所有工作空间及其详细信息。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminListWorkspaces();

admin_delete_workspace - delete /api/admin/workspaces/{workspace_id}/

如果请求用户是员工，则删除指定的 workspace 及其内部的应用程序。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminDeleteWorkspace();

list_application_integrations - get /api/application/{application_id}/integrations/

如果用户有权访问相关应用程序的工作空间，则列出与应用程序相关的所有集成。如果 workspace 与模板相关，则此端点将公开访问。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listApplicationIntegrations();

create_application_integration - post /api/application/{application_id}/integrations/

创建新的集成

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createApplicationIntegration();

list_application_user_source_users - get /api/application/{application_id}/list-user-source-users/

列出每个用户来源的前5个可用用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listApplicationUserSourceUsers();

list_application_user_sources - get /api/application/{application_id}/user-sources/

如果用户有权访问相关应用程序的工作空间，则列出与应用程序相关的所有 user_sources。如果 workspace 与模板相关，则此端点将公开访问。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listApplicationUserSources();

create_application_user_source - post /api/application/{application_id}/user-sources/

创建新的 user_source

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createApplicationUserSource();

list_application_user_source_roles - get /api/application/{application_id}/user-sources/roles/

如果用户有权访问相关应用程序的工作空间，则列出与应用程序相关的所有角色。如果 workspace 与模板相关，则此端点将公开访问。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listApplicationUserSourceRoles();

list_all_applications - get /api/applications/

列出授权用户可以访问的所有应用程序。属于应用程序的属性可能因类型而异。应用程序始终属于单个 workspace。用户有权访问的所有 workspace 中的应用程序都将在此列出。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listAllApplications();

workspace_get_application - get /api/applications/{application_id}/

如果授权用户位于应用程序的 workspace 中，则返回请求的应用程序。属于应用程序的属性可能因类型而异。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceGetApplication();

update_application - patch /api/applications/{application_id}/

如果授权用户位于应用程序的 workspace 中，则更新与提供的 application_id 参数相关的现有应用程序。无法更改类型，但可以更改如名称之类的属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateApplication();

delete_application - delete /api/applications/{application_id}/

如果授权用户位于应用程序的 workspace 中，则删除应用程序。所有相关子项也将被删除。例如，在数据库应用程序的情况下，所有底层表、字段、视图和行都将被删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteApplication();

duplicate_application_async - post /api/applications/{application_id}/duplicate/async/

如果授权用户位于应用程序的 workspace 中，则复制应用程序。所有相关子项也将被复制。例如，在数据库应用程序的情况下，所有底层表、字段、视图和行都将被复制。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->duplicateApplicationAsync();

group_list_applications - get /api/applications/group/{group_id}/

此端点已被弃用，并已被新的端点替换，workspace_list_applications。

对该端点的支持将在 2024 年结束。

如果授权用户位于相关 group_id 参数所属的组中，则列出与提供的组相关的所有应用程序。如果组与模板相关，则此端点将公开访问。属于应用程序的属性可能因类型而异。应用程序始终属于单个组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupListApplications();

group_create_application - post /api/applications/group/{group_id}/

此端点已弃用，已被新的端点 workspace_create_application 替换。

对该端点的支持将在 2024 年结束。

基于提供的类型创建一个新的应用程序。新创建的应用程序将被添加到与提供的 group_id 参数相关的组中。如果授权用户不属于该组，则返回错误。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupCreateApplication();

group_order_applications - post /api/applications/group/{group_id}/order/

此端点已弃用，已被新的端点 workspace_order_applications 替换。

对该端点的支持将在 2024 年结束。

更改提供的应用程序 ID 的顺序，以匹配列表中 ID 的匹配位置。如果授权用户不属于该组，则会被忽略。未提供的表单的顺序将被设置为 0。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupOrderApplications();

workspace_list_applications - get /api/applications/workspace/{workspace_id}/

列出与提供的 workspace_id 参数相关的所有应用程序，如果授权用户在该工作区中。如果工作区与模板相关，则此端点将公开访问。应用程序的属性可能因类型而异。应用程序始终属于单个工作区。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceListApplications();

workspace_create_application - post /api/applications/workspace/{workspace_id}/

基于提供的类型创建一个新的应用程序。新创建的应用程序将被添加到与提供的 workspace_id 参数相关的 工作区中。如果授权用户不属于该工作区，则返回错误。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceCreateApplication();

workspace_order_applications - post /api/applications/workspace/{workspace_id}/order/

更改提供的应用程序 ID 的顺序，以匹配列表中 ID 的匹配位置。如果授权用户不属于该工作区，则会被忽略。未提供的表单的顺序将被设置为 0。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceOrderApplications();

audit_log_list_2 - get /api/audit-log/

列出给定工作空间 ID 的所有审计日志条目。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogList2();

audit_log_action_types_2 - get /api/audit-log/action-types/

列出与审计日志条目相关的所有不同操作类型。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogActionTypes2();

async_audit_log_export_2 - post /api/audit-log/export/

创建一个作业，将筛选后的审计日志导出到 CSV 文件。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->asyncAuditLogExport2();

audit_log_users_2 - get /api/audit-log/users/

列出在审计日志中执行操作的 所有用户。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogUsers2();

audit_log_workspaces_2 - get /api/audit-log/workspaces/

列出与审计日志条目相关的所有不同工作空间名称。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->auditLogWorkspaces2();

list_auth_providers_login_options - get /api/auth-provider/login-options/

列出配置的认证提供程序的可用登录选项。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listAuthProvidersLoginOptions();

get_builder_domains - get /api/builder/{builder_id}/domains/

获取构建器的所有域名。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getBuilderDomains();

create_builder_domain - post /api/builder/{builder_id}/domains/

为应用程序构建器创建一个新的域名。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createBuilderDomain();

order_builder_domains - post /api/builder/{builder_id}/domains/order/

为构建器的域名应用新的顺序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderBuilderDomains();

create_builder_page - post /api/builder/{builder_id}/pages/

为应用程序构建器创建一个新的页面。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createBuilderPage();

order_builder_pages - post /api/builder/{builder_id}/pages/order/

为构建器的页面应用新的顺序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderBuilderPages();

update_builder_theme - patch /api/builder/{builder_id}/theme/

更新提供的 ID 的主题属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateBuilderTheme();

update_builder_page_data_source - patch /api/builder/data-source/{data_source_id}/

更新现有的构建器数据源。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateBuilderPageDataSource();

delete_builder_page_data_source - delete /api/builder/data-source/{data_source_id}/

根据给定的 ID 删除相关的数据源。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteBuilderPageDataSource();

dispatch_builder_page_data_source - post /api/builder/data-source/{data_source_id}/dispatch/

调度相关的数据源服务并返回结果。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->dispatchBuilderPageDataSource();

move_builder_page_data_source - patch /api/builder/data_source/{data_source_id}/move/

将数据源移动到页面中的另一个数据源之前，或者在未提供之前数据源的情况下移动到页面的末尾。数据源必须属于同一页面。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->moveBuilderPageDataSource();

update_builder_domain - patch /api/builder/domains/{domain_id}/

更新应用程序构建器现有的域名。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateBuilderDomain();

delete_builder_domain - delete /api/builder/domains/{domain_id}/

删除应用程序构建器现有的域名。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteBuilderDomain();

publish_builder_domain - post /api/builder/domains/{domain_id}/publish/async/

此端点启动一个异步任务以发布构建器。该任务克隆给定构建器的当前版本，并将其发布到指定的域名。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->publishBuilderDomain();

ask_public_builder_domain_exists - get /api/builder/domains/ask-public-domain-exists/

此端点可用于检查是否为SSL证书目的存在域名。它与Caddy on_demand TLS兼容，如以下链接中所述：https://caddyserver.com.cn/docs/json/apps/tls/automation/on_demand/ask/。如果存在，则返回200状态码；如果不存在，则返回404。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->askPublicBuilderDomainExists();

get_public_builder_by_id - get /api/builder/domains/published/by_id/{builder_id}/

返回给定构建器ID的构建器的公共序列化版本及其页面。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getPublicBuilderById();

get_public_builder_by_domain_name - get /api/builder/domains/published/by_name/{domain_name}/

返回给定域名及其页面的构建器的公共序列化版本。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getPublicBuilderByDomainName();

list_public_builder_page_data_sources - get /api/builder/domains/published/page/{page_id}/data_sources/

列出与提供的参数相关的页面相关联的所有数据源，如果构建器是公共的。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listPublicBuilderPageDataSources();

list_public_builder_page_elements - get /api/builder/domains/published/page/{page_id}/elements/

列出与提供的参数相关的页面所有元素。如果用户是匿名用户，则页面必须属于已发布的构建器实例才能访问。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listPublicBuilderPageElements();

list_public_builder_page_workflow_actions - get /api/builder/domains/published/page/{page_id}/workflow_actions/

列出所有具有公开可访问数据的流程操作。出于安全原因，可能省略一些配置，例如密码或PII。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listPublicBuilderPageWorkflowActions();

update_builder_page_element - patch /api/builder/element/{element_id}/

更新现有的构建器元素。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateBuilderPageElement();

delete_builder_page_element - delete /api/builder/element/{element_id}/

删除与给定ID相关的元素。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteBuilderPageElement();

duplicate_builder_page_element - post /api/builder/element/{element_id}/duplicate/

复制一个元素及其所有子元素以及相关的流程操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->duplicateBuilderPageElement();

move_builder_page_element - patch /api/builder/element/{element_id}/move/

将元素移动到页面中另一个元素之前，或者如果没有给定之前元素，则在页面末尾。元素必须属于同一页面。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->moveBuilderPageElement();

list_builder_page_data_sources - get /api/builder/page/{page_id}/data-sources/

列出与提供的参数相关的页面相关联的所有数据源，如果用户有权访问相关构建器的工空间。如果工空间与模板相关，则此端点将是公开可访问的。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listBuilderPageDataSources();

create_builder_page_data_source - post /api/builder/page/{page_id}/data-sources/

创建新的构建器数据源。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createBuilderPageDataSource();

dispatch_builder_page_data_sources - post /api/builder/page/{page_id}/dispatch-data-sources/

分配相关页面数据源的服务。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->dispatchBuilderPageDataSources();

list_builder_page_elements - get /api/builder/page/{page_id}/elements/

列出与提供的参数相关的页面所有元素，如果用户有权访问相关构建器的工空间。如果工空间与模板相关，则此端点将是公开可访问的。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listBuilderPageElements();

create_builder_page_element - post /api/builder/page/{page_id}/elements/

创建新的构建器元素。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createBuilderPageElement();

list_builder_page_workflow_actions - get /api/builder/page/{page_id}/workflow_actions/

列出与提供的参数相关的页面所有流程操作，如果用户有权访问相关构建器的工空间。如果工空间与模板相关，则此端点将是公开可访问的。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listBuilderPageWorkflowActions();

create_builder_page_workflow_action - post /api/builder/page/{page_id}/workflow_actions/

创建新的构建器流程操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createBuilderPageWorkflowAction();

order_builder_workflow_actions - post /api/builder/page/{page_id}/workflow_actions/order/

对页面流程操作应用新顺序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderBuilderWorkflowActions();

update_builder_page - patch /api/builder/pages/{page_id}/

更新应用程序构建器的现有页面。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateBuilderPage();

delete_builder_page - delete /api/builder/pages/{page_id}/

删除应用程序构建器中现有页面

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteBuilderPage();

duplicate_builder_page_async - POST /api/builder/pages/{page_id}/duplicate/async/

如果授权用户有权访问构建器的 workspace，则启动一个任务以复制具有提供的 page_id 参数的页面。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->duplicateBuilderPageAsync();

update_builder_page_workflow_action - PATCH /api/builder/workflow_action/{workflow_action_id}/

更新现有的构建器工作流程操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateBuilderPageWorkflowAction();

delete_builder_page_workflow_action - DELETE /api/builder/workflow_action/{workflow_action_id}/

删除与给定 id 相关的工作流程操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteBuilderPageWorkflowAction();

dispatch_builder_page_workflow_action - POST /api/builder/workflow_action/{workflow_action_id}/dispatch/

调度相关的工作流程_action 服务并返回结果。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->dispatchBuilderPageWorkflowAction();

get_export_job - GET /api/database/export/{job_id}/

如果请求用户有权访问，则返回指定导出作业的导出进度和状态或导出文件的 URL。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getExportJob();

export_table - POST /api/database/export/table/{table_id}/

创建并启动一个新导出作业，用于导出具有某些导出选项的表。如果请求用户没有权限查看表，则返回错误。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->exportTable();

get_database_table_field - GET /api/database/fields/{field_id}/

如果授权用户有权访问相关数据库的 workspace，则返回现有字段。根据类型，可能返回不同的属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableField();

update_database_table_field - PATCH /api/database/fields/{field_id}/

如果授权用户有权访问相关数据库的 workspace，则更新现有字段。类型也可以更改，根据该类型，可以可选地设置不同的附加属性。如果更改字段类型，可能会发生数据转换失败的情况，在这种情况下返回 ERROR_CANNOT_CHANGE_FIELD_TYPE，但这很少发生。如果无法转换数据值，则将其设置为 null，因此可能会丢失数据。如果更新的字段导致其他字段更改，则相关字段的具体实例将包含在相关字段响应密钥中。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableField();

delete_database_table_field - DELETE /api/database/fields/{field_id}/

如果授权用户有权访问相关数据库的 workspace，则删除现有字段。注意，与该字段相关的所有相关数据也将被删除。主字段不能被删除，因为它们的值代表行。如果删除字段导致其他字段更改，则相关字段的具体实例将包含在相关字段响应密钥中。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableField();

duplicate_table_field - POST /api/database/fields/{field_id}/duplicate/async/

如果授权用户有权访问数据库的 workspace，则复制具有提供的 table_id 参数的表。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->duplicateTableField();

generate_table_ai_field_value - POST /api/database/fields/{field_id}/generate-ai-field-values/

端点用于 AI 字段启动一个同步任务，该任务将根据在字段设置中配置的动态构造的提示更新提供的行 ID 的单元格值。这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->generateTableAiFieldValue();

get_database_field_unique_row_values - GET /api/database/fields/{field_id}/unique_row_values/

按频率顺序返回现有字段的全部唯一行值列表。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseFieldUniqueRowValues();

list_database_table_fields - GET /api/database/fields/table/{table_id}/

如果用户有权访问相关数据库的 workspace，则列出与提供的参数相关的表的全部字段。如果 workspace 与模板相关，则此端点将是公开可访问的。表由字段组成，每个字段可以有不同的类型。每个类型可以有不同的属性。字段可以与常规表的列进行比较。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableFields();

create_database_table_field - POST /api/database/fields/table/{table_id}/

如果授权用户有权访问相关数据库的 workspace，则为与提供的 table_id 参数相关的表创建新字段。根据类型，可以可选地设置不同的属性。如果创建字段导致其他字段更改，则相关字段的具体实例将包含在相关字段响应密钥中。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableField();

generate_formula_with_ai - POST /api/database/fields/table/{table_id}/generate-ai-formula/

该端点根据请求体中提供的可读输入，为指定的id生成与表格相关的Baserow公式。这是一个高级功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->generateFormulaWithAi();

type_formula_field - post /api/database/formula/{table_id}/type/

计算并返回指定公式值的类型。不会以任何方式改变字段的任何状态。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->typeFormulaField();

list_database_table_row_names - get /api/database/rows/names/

返回给定表格给定行的名称。行的名称是该行主字段的值。结果可用于例如，当你想要显示另一个表中的链接行名称时。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableRowNames();

list_database_table_rows - get /api/database/rows/table/{table_id}/

列出与提供参数相关的表的全部行（如果用户有权限访问相关数据库的工作空间）。响应以分页的方式显示，分页方式为每页/大小。还可以提供可选的搜索查询，仅返回与搜索查询匹配的数据行。返回行的属性取决于表具有哪些字段。要获取字段的完整概述，请使用 list_database_table_fields 端点列出所有字段。在示例中列出了所有字段类型，但通常field_{id}键中的数字将是字段的id。或者如果提供了GET参数user_field_names，则键将是字段的名称。值是用户提供的值，其格式取决于字段类型。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableRows();

create_database_table_row - post /api/database/rows/table/{table_id}/

如果用户有权访问相关表的工作空间，则在该表中创建新行。接受的请求体字段取决于表具有哪些字段。要获取字段的完整概述，请使用 list_database_table_fields 来列出所有字段。没有字段是必需的，如果没有提供，则值将是null、false或已设置的默认值。如果您想为id为10的字段添加值，则键必须命名为field_10。或者，如果提供了user_field_names GET参数，则键必须是字段的名称。当然，可以在一个请求中提供多个字段。下面的示例中将找到所有不同的字段类型，示例中的数字/ID只是为了示例目的，字段ID必须替换为字段的实际ID或如果提供了user_field_names，则替换为字段的名称。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableRow();

get_database_table_row - get /api/database/rows/table/{table_id}/{row_id}/

如果用户有权访问相关表的工作空间，则从表中获取现有行。返回行的属性取决于表具有哪些字段。要获取字段的完整概述，请使用 list_database_table_fields 端点列出所有字段。在示例中列出了所有字段类型，但通常field_{id}键中的数字将是字段ID。或者如果提供了GET参数user_field_names，则键将是字段的名称。值是用户提供的值，其格式取决于字段类型。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableRow();

update_database_table_row - patch /api/database/rows/table/{table_id}/{row_id}/

如果用户有权访问相关表的工作区，则更新表中现有的行。接受的身体字段取决于表具有的字段。要全面了解字段，请使用 list_database_table_fields 端点列出所有字段。如果没有提供任何字段，则不更新其值。当您想更新具有 10 ID 的字段的值时，键必须命名为 field_10。或者如果提供了 GET 参数 user_field_names，则要更新的字段的键必须是该字段的名称。可以在一个请求中提供多个不同的字段进行更新。在下面的示例中，您将找到所有不同的字段类型，示例中的数字/ID只是为了示例目的，字段_ID 必须替换为字段的实际 ID 或如果提供了 user_field_names，则为字段的名称。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableRow();

delete_database_table_row - 删除 /api/database/rows/table/{table_id}/{row_id}/

如果用户有权访问该表的工作区，则删除表中现有的行。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableRow();

get_adjacent_database_table_row - 获取 /api/database/rows/table/{table_id}/{row_id}/adjacent/

获取具有给定 table_id 的表中给定 row_id 的相邻行。如果设置了 previous 标志，则返回上一行，否则返回下一行。您可以指定 view_id，它将应用提供的视图的过滤器和排序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getAdjacentDatabaseTableRow();

get_database_table_row_history - 获取 /api/database/rows/table/{table_id}/{row_id}/history/

获取具有给定 table_id 的表中给定 row_id 的行更改历史记录。行更改历史记录是分页的，并且可以使用 limit 和 offset 查询参数进行限制。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableRowHistory();

move_database_table_row - 修补 /api/database/rows/table/{table_id}/{row_id}/move/

将相关于给定 row_id 参数的行移动到另一个位置。只能将行移动到另一个现有行之前或移动到末尾。如果提供了 before_id，则与 row_id 参数相关的行将移动到该行之前。如果没有提供 before_id 参数，则该行将移动到末尾。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->moveDatabaseTableRow();

batch_create_database_table_rows - 发送 /api/database/rows/table/{table_id}/batch/

如果用户有权访问相关表的工作区，则创建表中的新行。接受的身体字段取决于表具有的字段。要全面了解字段，请使用 list_database_table_fields 来列出所有字段。如果没有提供任何字段，则其值将为 null 或 false 或设置的一些默认值。如果您想为具有例如 10 ID 的字段添加值，则键必须命名为 field_10。或者，如果提供了 user_field_names GET 参数，则键必须是字段的名称。当然，可以在一个请求中提供多个字段。在下面的示例中，您将找到所有不同的字段类型，示例中的数字/ID只是为了示例目的，字段_ID 必须替换为字段的实际 ID 或如果提供了 user_field_names，则为字段的名称。

警告：此端点尚未与行创建网关一起工作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->batchCreateDatabaseTableRows();

batch_update_database_table_rows - 修补 /api/database/rows/table/{table_id}/batch/

如果用户有权访问相关表的 workspace，则更新表中的现有行。接受的字段取决于表拥有的字段。要查看所有字段的完整概述，请使用 list_database_table_fields 端点列出它们。如果未提供，则不需要任何字段，且值将不会被更新。当您想更新具有 id 10 的字段的值时，键必须命名为 field_10。或者，如果提供了 GET 参数 user_field_names，则要更新的字段键必须是该字段的名称。可以为每一行提供多个不同的字段进行更新。在下面的示例中，您将找到所有不同的字段类型，示例中的数字/ids只是为了示例目的，字段_ID 必须替换为实际的字段 id 或如果提供了 user_field_names，则为字段的名称。

警告：此端点目前不支持行更新 webhooks。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->batchUpdateDatabaseTableRows();

批量删除数据库表行 - POST /api/database/rows/table/{table_id}/batch-delete/

如果用户有权访问表的 workspace，则删除表中的现有行。

警告：此端点目前不支持行删除 webhooks。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->batchDeleteDatabaseTableRows();

获取数据库表 - GET /api/database/tables/{table_id}/

如果授权用户有权访问相关数据库的 workspace，则返回请求的表。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTable();

更新数据库表 - PATCH /api/database/tables/{table_id}/

如果授权用户有权访问相关数据库的 workspace，则更新现有表。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTable();

删除数据库表 - DELETE /api/database/tables/{table_id}/

如果授权用户有权访问相关数据库的 workspace，则删除现有表。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTable();

异步复制数据库表 - POST /api/database/tables/{table_id}/duplicate/async/

如果授权用户有权访问数据库的 workspace，则启动一个作业以使用提供的 table_id 参数复制表。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->duplicateDatabaseTableAsync();

异步导入数据到数据库表 - POST /api/database/tables/{table_id}/import/async/

如果授权用户有权访问相关数据库的 workspace，则在指定的表中导入数据。此端点是异步的，并返回创建的作业以跟踪任务进度。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->importDataDatabaseTableAsync();

列出数据库表 - GET /api/database/tables/database/{database_id}/

如果用户有权访问与 database_id 参数相关的数据库的 workspace，则列出数据库中的所有表。表就像其名称所暗示的那样。它可以包含多个字段，每个字段都有自己的类型和多个行。可以通过 create_database_table_field 和 create_database_table_row 端点添加。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTables();

创建数据库表 - POST /api/database/tables/database/{database_id}/

如果授权用户有权访问数据库的 workspace，则同步创建与提供的 database_id 参数相关的数据库的新表。

作为替代，您可以使用 create_async_database_table 以获得更好的性能和导入更大的文件。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTable();

异步创建数据库表 - POST /api/database/tables/database/{database_id}/async/

创建一个作业，用于为与提供的 database_id 参数相关的数据库创建新表，如果授权用户有权访问数据库的 workspace。此端点是异步的，并返回创建的作业以跟踪任务进度。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableAsync();

排序数据库表 - POST /api/database/tables/database/{database_id}/order/

更改提供的表 id 的顺序，以匹配列表中 id 的匹配位置。如果授权用户不属于 workspace，则会被忽略。未提供的表的顺序将设置为 0。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderDatabaseTables();

列出数据库令牌 - GET /api/database/tokens/

列出属于授权用户的数据库令牌。令牌可用于在令牌工作空间的表中进行创建、读取、更新和删除行操作。只有当令牌具有正确权限时，它才在表上工作。可以使用“数据库表行”端点进行这些操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTokens();

create_database_token - post /api/database/tokens/

为指定工作空间和授权用户创建新的数据库令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseToken();

get_database_token - get /api/database/tokens/{token_id}/

如果请求的数据库令牌属于授权用户，并且用户有权访问相关工作空间，则返回该数据库令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseToken();

update_database_token - patch /api/database/tokens/{token_id}/

如果数据库令牌属于授权用户，并且用户有权访问相关工作空间，则更新现有数据库令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseToken();

delete_database_token - delete /api/database/tokens/{token_id}/

如果数据库令牌属于授权用户，并且用户有权访问相关工作空间，则删除现有数据库令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseToken();

check_database_token - get /api/database/tokens/check/

此端点可用于检查提供的个人API令牌是否有效。如果是，则返回200响应，否则返回403。这可以用于Zapier或n8n等集成测试令牌是否有效。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->checkDatabaseToken();

premium_view_attributes_update - patch /api/database/view/{view_id}/premium

仅对高级用户设置视图属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->premiumViewAttributesUpdate();

database_table_public_view_link_field_lookup - get /api/database/views/{slug}/link-field-lookup/{field_id}/

如果视图是公开共享的，或者经过身份验证的用户有权访问相关工作空间，则可以使用此端点进行包含在视图中的链接行字段的值查找。通常，未经身份验证的访客无法获取表的行。此端点使得可以获取包含在视图中的链接行的相关表ID和主字段值。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->databaseTablePublicViewLinkRowFieldLookup();

public_view_token_auth - post /api/database/views/{slug}/public/auth/

如果提供的密码与视图所有者保存的密码匹配，则返回一个有效的、永不过期的JWT令牌，用于此公开共享视图。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->publicViewTokenAuth();

get_public_view_info - get /api/database/views/{slug}/public/info/

返回显示单个共享视图所需的公共信息。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getPublicViewInfo();

get_database_table_view - get /api/database/views/{view_id}/

返回现有视图。根据类型，可能返回不同的属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableView();

update_database_table_view - patch /api/database/views/{view_id}/

更新现有视图。类型不能更改。它取决于现有的类型，哪些属性可以更改。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableView();

delete_database_table_view - delete /api/database/views/{view_id}/

删除现有视图。请注意，视图的所有相关设置也将被删除。删除视图后，数据保持完整，因为这与表相关，而不是与视图相关。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableView();

list_database_table_view_decorations - get /api/database/views/{view_id}/decorations/

列出与提供的view_id相关的视图的所有装饰，如果用户有权访问相关数据库的工作空间。视图可以有多个装饰。视图装饰器可以用于装饰行。例如，可以用于在行匹配某些条件时更改行的边框或背景颜色。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableViewDecorations();

create_database_table_view_decoration - post /api/database/views/{view_id}/decorations/

如果授权用户有权访问相关数据库的工作空间，则为与提供的view_id参数相关的视图创建新的装饰。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableViewDecoration();

duplicate_database_table_view - post /api/database/views/{view_id}/duplicate/

如果用户有权访问，则复制现有视图。当复制视图时，除了

• 名称将附加复制编号。例如：ViewName>ViewName(2)和View(2)>View(3)
• 如果原始视图是公开共享的，新视图将不再共享。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->duplicateDatabaseTableView();

get_database_table_view_field_options - get /api/database/views/{view_id}/field-options/

如果认证用户有权访问相关工作区，则响应提供视图的字段选项。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableViewFieldOptions();

update_database_table_view_field_options - patch /api/database/views/{view_id}/field-options/

更新视图的字段选项。字段选项因字段类型而异。例如，如果用户更改，可以使用此方法更新grid视图的字段宽度。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableViewFieldOptions();

create_database_table_view_filter_group - post /api/database/views/{view_id}/filter-groups/

为与提供的view_id参数相关的视图创建一个新的筛选器组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableViewFilterGroup();

list_database_table_view_filters - get /api/database/views/{view_id}/filters/

列出与提供的view_id相关的视图的所有筛选器。一个视图可以有多个筛选器。当请求视图的所有行时，仅返回适用于筛选器的那些行。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableViewFilters();

create_database_table_view_filter - post /api/database/views/{view_id}/filters/

为与提供的view_id参数相关的视图创建一个新的筛选器。当请求视图的行时，例如通过list_database_table_grid_view_rows端点，则仅返回适用于所有筛选器的行。筛选器将字段的值与筛选器的值进行比较。比较值的方式取决于类型。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableViewFilter();

list_database_table_view_groupings - get /api/database/views/{view_id}/group_bys/

如果用户有权访问相关数据库的工作区，则列出与提供的view_id相关的视图的所有分组。一个视图可以有多个分组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableViewGroupings();

create_database_table_view_group - post /api/database/views/{view_id}/group_bys/

如果授权用户有权访问相关数据库的工作区，则为与提供的view_id参数相关的视图创建一个新的分组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableViewGroup();

rotate_database_view_slug - post /api/database/views/{view_id}/rotate-slug/

通过替换为新值来旋转视图的唯一slug。这意味着视图的公开共享URL将更改。任何人使用旧URL都无法访问视图。只有可共享的视图类型才能旋转它们的slug。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->rotateDatabaseViewSlug();

list_database_table_view_sortings - get /api/database/views/{view_id}/sortings/

如果用户有权访问相关数据库的工作区，则列出与提供的view_id相关的视图的所有排序。一个视图可以有多个排序。当请求所有行时，它们将按所需顺序排列。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableViewSortings();

create_database_table_view_sort - post /api/database/views/{view_id}/sortings/

如果授权用户有权访问相关数据库的工作区，则为与提供的view_id参数相关的视图创建一个新的排序。当请求视图的行时，例如通过list_database_table_grid_view_rows端点，它们将按所有排序定义的顺序返回。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableViewSort();

public_list_database_table_calendar_view_rows - get /api/database/views/calendar/{slug}/public/rows/

如果日历视图是公开共享的，则响应提供按视图的日期字段选项分组序列化的行，相关的slug。可以提供额外的查询参数来控制每个选择选项的limit和offset。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->publicListDatabaseTableCalendarViewRows();

list_database_table_calendar_view_rows - get /api/database/views/calendar/{view_id}/

如果用户已认证且有权访问相关工作区，则按日期字段序列化响应有关视图的行。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableCalendarViewRows();

get_database_table_view_decoration - get /api/database/views/decoration/{view_decoration_id}/

如果当前用户有权访问相关数据库的工作区，则返回现有的视图装饰。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableViewDecoration();

update_database_table_view_decoration - patch /api/database/views/decoration/{view_decoration_id}/

如果授权用户有权访问相关数据库的工作区，则更新现有的装饰。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableViewDecoration();

delete_database_table_view_decoration - delete /api/database/views/decoration/{view_decoration_id}/

如果授权用户有权访问相关数据库的工作空间，则删除现有装饰。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableViewDecoration();

get_database_table_view_filter_group - get /api/database/views/filter-group/{filter_group_id}/

返回具有给定 view_filter_group_id 的现有视图过滤组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableViewFilterGroup();

update_database_table_view_filter_group - patch /api/database/views/filter-group/{filter_group_id}/

更新具有给定 view_filter_group_id 的现有过滤组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableViewFilterGroup();

delete_database_table_view_filter_group - delete /api/database/views/filter-group/{filter_group_id}/

删除具有给定 view_filter_group_id 的现有过滤组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableViewFilterGroup();

get_database_table_view_filter - get /api/database/views/filter/{view_filter_id}/

返回现有的视图过滤。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableViewFilter();

update_database_table_view_filter - patch /api/database/views/filter/{view_filter_id}/

更新现有的过滤。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableViewFilter();

delete_database_table_view_filter - delete /api/database/views/filter/{view_filter_id}/

如果授权用户有权访问相关数据库的工作空间，则删除现有的过滤。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableViewFilter();

get_meta_database_table_form_view - get /api/database/views/form/{slug}/submit/

如果表单是公开共享的或用户有权访问相关的工作空间，则返回与表单视图相关的元数据。这些数据可以用于构建具有正确字段的表单。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getMetaDatabaseTableFormView();

submit_database_table_form_view - post /api/database/views/form/{slug}/submit/

如果表单是公开共享的或用户有权访问相关的工作空间，则提交表单。提供的数据将根据表单中的字段和每个字段的规则进行验证。如果有效，将在表中创建一个新行。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->submitDatabaseTableFormView();

upload_file_form_view - post /api/database/views/form/{slug}/upload-file/

通过直接上传文件内容匿名地将文件上传到Baserow。期望包含文件内容的 file 多部分。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->uploadFileFormView();

public_list_database_table_gallery_view_rows - get /api/database/views/gallery/{slug}/public/rows/

列出与提供的 slug 相关的视图表的请求行，如果画廊视图是公开的。响应通过限制/偏移或页面/大小进行分页。这种样式取决于提供的GET参数。返回行的属性取决于表具有哪些字段。要获取字段的完整概述，请使用 list_database_table_fields 端点列出它们全部。在示例中列出了所有字段类型，但通常在 field_{id} 键中的数字将是字段的ID。值是用户提供的，其格式取决于字段类型。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->publicListDatabaseTableGalleryViewRows();

list_database_table_gallery_view_rows - get /api/database/views/gallery/{view_id}/

如果授权用户有权访问数据库的工作空间，则列出与提供的 view_id 相关的视图表的请求行。响应通过限制/偏移进行分页。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableGalleryViewRows();

get_database_table_public_grid_view_field_aggregations - get /api/database/views/grid/{slug}/public/aggregations/

返回之前为此网格视图定义的所有字段聚合值。如果此视图存在过滤器，则聚合仅在对过滤行进行计算。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTablePublicGridViewFieldAggregations();

public_list_database_table_grid_view_rows - get /api/database/views/grid/{slug}/public/rows/

列出与提供的 slug 相关的视图表的请求行，如果网格视图是公开的。响应通过限制/偏移或页面/大小进行分页。这种样式取决于提供的GET参数。返回行的属性取决于表具有哪些字段。要获取字段的完整概述，请使用 list_database_table_fields 端点列出它们全部。在示例中列出了所有字段类型，但通常在 field_{id} 键中的数字将是字段的ID。值是用户提供的，其格式取决于字段类型。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->publicListDatabaseTableGridViewRows();

list_database_table_grid_view_rows - get /api/database/views/grid/{view_id}/

列出与提供的view_id相关的视图表请求的行，如果授权用户有权访问数据库的工作空间。响应通过限制/偏移或页面/大小方式分页。该样式取决于提供的GET参数。返回行的属性取决于表具有哪些字段。要查看所有字段的完整概述，请使用list_database_table_fields端点列出它们。在示例中列出了所有字段类型，但通常field_{id}键中的数字将是字段的id。值是用户提供的，其格式取决于字段类型。

自动应用过滤器和排序。要获取应用的过滤器和排序的完整概述，可以使用list_database_table_view_filters和list_database_table_view_sortings端点。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableGridViewRows();

filter_database_table_grid_view_rows - post /api/database/views/grid/{view_id}/

仅列出与请求匹配的行和字段。仅返回row_ids列表中的id的行。同样，对于字段，也仅返回field_ids中的id的字段。此端点可用于在更改某些内容后刷新数据。例如，在Web前端更改字段类型后，可以使用此端点刷新相关单元格的数据。在示例中列出了所有字段类型，但通常field_{id}键中的数字将是字段的id。值是用户提供的，其格式取决于字段类型。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->filterDatabaseTableGridViewRows();

get_database_table_grid_view_field_aggregation - get /api/database/views/grid/{view_id}/aggregation/{field_id}/

计算选定网格视图中指定字段的全部值的聚合。您必须通过设置GET参数type来选择聚合类型。如果为选定的视图配置了过滤器，则仅在过滤行上计算聚合。您需要具有对视图的读取权限才能请求聚合。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableGridViewFieldAggregation();

get_database_table_grid_view_field_aggregations - get /api/database/views/grid/{view_id}/aggregations/

返回以前为此网格视图定义的所有字段聚合值。如果此视图存在过滤器，则仅对过滤行进行聚合计算。您需要具有对视图的读取权限才能请求聚合。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableGridViewFieldAggregations();

get_database_table_view_group - get /api/database/views/group_by/{view_group_by_id}/

如果授权用户有权访问相关数据库的工作空间，则返回现有的视图分组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableViewGroup();

update_database_table_view_group - patch /api/database/views/group_by/{view_group_by_id}/

如果授权用户有权访问相关数据库的工作空间，则更新现有的分组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableViewGroup();

delete_database_table_view_group - delete /api/database/views/group_by/{view_group_by_id}/

如果授权用户有权访问相关数据库的工作空间，则删除现有的分组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableViewGroup();

public_list_database_table_kanban_view_rows - get /api/database/views/kanban/{slug}/public/rows/

如果看板视图是公开共享的，则返回根据与slug相关的视图的单选字段选项分组序列化的行。可以提供额外的查询参数来控制每个选项的limit和offset。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->publicListDatabaseTableKanbanViewRows();

list_database_table_kanban_view_rows - get /api/database/views/kanban/{view_id}/

如果用户已验证且有权访问相关的工作空间，则返回根据视图的单选字段选项分组序列化的行。可以提供额外的查询参数来控制每个选项的limit和offset。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableKanbanViewRows();

get_database_table_view_sort - get /api/database/views/sort/{view_sort_id}/

如果授权用户有权访问相关数据库的工作空间，则返回现有的视图排序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableViewSort();

update_database_table_view_sort - patch /api/database/views/sort/{view_sort_id}/

如果授权用户有权访问相关数据库的工作区，则更新现有排序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableViewSort();

delete_database_table_view_sort - 删除 /api/database/views/sort/{view_sort_id}/

如果授权用户有权访问相关数据库的工作区，则删除现有排序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableViewSort();

list_database_table_views - get /api/database/views/table/{table_id}/

列出与提供的 table_id 相关的表的所有视图。如果工作区与模板相关，则此端点将是公开可访问的。一个表可以有多个视图。每个视图可以以不同的方式显示数据。例如，grid 视图以类似电子表格的方式显示。该类型有自定义的数据检索和处理端点。未来还将添加其他视图类型，如日历或看板。每种类型都可以有不同的属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableViews();

create_database_table_view - post /api/database/views/table/{table_id}/

为提供的 table_id 参数相关的表创建一个新的视图。根据类型，可以可选地设置不同的属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableView();

order_database_table_views - post /api/database/views/table/{table_id}/order/

更改提供的视图 ID 的顺序，使其与列表中 ID 的匹配位置相匹配。未提供的视图的顺序将被设置为 0。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderDatabaseTableViews();

get_database_table_webhook - get /api/database/webhooks/{webhook_id}/

如果授权用户有权访问相关数据库工作区，则返回现有的 webhook。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getDatabaseTableWebhook();

update_database_table_webhook - patch /api/database/webhooks/{webhook_id}/

如果授权用户有权访问相关数据库工作区，则更新现有的视图。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateDatabaseTableWebhook();

delete_database_table_webhook - delete /api/database/webhooks/{webhook_id}/

如果授权用户有权访问相关数据库工作区，则删除现有的 webhook。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteDatabaseTableWebhook();

list_database_table_webhooks - get /api/database/webhooks/table/{table_id}/

如果用户有权访问相关数据库工作区，则列出与提供的 table_id 相关的表的所有 webhook。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listDatabaseTableWebhooks();

create_database_table_webhook - post /api/database/webhooks/table/{table_id}/

如果授权用户有权访问相关数据库工作区，则为提供的 table_id 参数相关的表创建一个新的 webhook。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createDatabaseTableWebhook();

test_call_database_table_webhook - post /api/database/webhooks/table/{table_id}/test-call/

如果用户有权访问与表相关的 workspace，则此端点将根据提供的数据触发测试调用。测试调用将立即执行，并且请求、响应和状态将包括在响应中。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->testCallDatabaseTableWebhook();

secure_file_serve_download - get /api/files/{signed_data}

使用后端和安全的文件服务功能下载文件。签名数据从 URL 中提取出来，用于验证用户是否有权访问该文件。如果权限检查通过且文件存在，则将文件提供给用户。

这是一个 企业 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->secureFileServeDownload();

list_groups - get /api/groups/

此端点已被弃用，并替换为新的端点，list_workspaces。

对该端点的支持将在 2024 年结束。

列出授权用户的所有组。一个组可以包含多个应用程序，如数据库。多个用户可以访问一个组。例如，每个公司都可以有自己的组，包含与该公司相关的数据库。组的顺序对每个用户都是自定义的。顺序可以通过 order_groups 端点进行配置。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listGroups();

create_group - post /api/groups/

此端点已被弃用，并替换为新的端点，create_workspace。

对该端点的支持将在 2024 年结束。

创建一个新组，其中只有授权用户可以访问。不会添加初始数据，如数据库应用程序，它们必须通过其他端点创建。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createGroup();

update_group - patch /api/groups/{group_id}/

此端点已被弃用，并替换为新的端点，update_workspace。

对该端点的支持将在 2024 年结束。

如果授权用户属于该组，则更新与提供的 group_id 参数相关的现有组。目前还不能向组中添加其他用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateGroup();

delete_group - 删除 /api/groups/{group_id}/

此端点已被弃用，并由新的端点替换，请参阅 delete_workspace。

对该端点的支持将在 2024 年结束。

如果授权用户属于该组，则删除现有组。该组中包含的所有应用程序、数据库、表等也将被删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteGroup();

leave_group - post /api/groups/{group_id}/leave/

此端点已被弃用，并由新的端点替换，请参阅 leave_workspace。

对该端点的支持将在 2024 年结束。

如果用户在该组中，则使经过身份验证的用户离开与提供的 group_id 相关的组。如果用户是该组的最后一名管理员，则他们无法离开。组中必须始终有一名管理员，否则将无法控制。在这种情况下，他们必须首先删除组或向另一成员授予管理员权限。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->leaveGroup();

group_permissions - get /api/groups/{group_id}/permissions/

此端点已被弃用，并由新的端点替换，请参阅 workspace_permissions。

对该端点的支持将在 2024 年结束。

返回确定特定用户在特定组中的权限所需的所有权限数据。有关详细信息，请参阅 core.handler.CoreHandler.get_permissions()。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupPermissions();

get_group_invitation - get /api/groups/invitations/{group_invitation_id}/

此端点已被弃用，并由新的端点替换，请参阅 get_workspace_invitation。

对该端点的支持将在 2024 年结束。

如果授权用户对相关组有管理员权限，则返回请求的组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getGroupInvitation();

update_group_invitation - patch /api/groups/invitations/{group_invitation_id}/

此端点已被弃用，并由新的端点替换，请参阅 update_workspace_invitation。

对该端点的支持将在 2024 年结束。

如果授权用户对相关组有管理员权限，则更新与提供的 group_invitation_id 参数相关的现有组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateGroupInvitation();

delete_group_invitation - delete /api/groups/invitations/{group_invitation_id}/

此端点已被弃用，并由新的端点替换，请参阅 delete_workspace_invitation。

对该端点的支持将在 2024 年结束。

如果授权用户对相关组有管理员权限，则删除组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteGroupInvitation();

accept_group_invitation - post /api/groups/invitations/{group_invitation_id}/accept/

此端点已被弃用，并由新的端点替换，请参阅 accept_workspace_invitation。

对该端点的支持将在 2024 年结束。

如果用户的电子邮件地址与邀请中的电子邮件地址匹配，则接受给定 ID 的组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->acceptGroupInvitation();

reject_group_invitation - post /api/groups/invitations/{group_invitation_id}/reject/

此端点已被弃用，并由新的端点替换，请参阅 reject_workspace_invitation。

对该端点的支持将在 2024 年结束。

如果用户的电子邮件地址与邀请中的电子邮件地址匹配，则拒绝给定 ID 的组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->rejectGroupInvitation();

list_group_invitations - get /api/groups/invitations/group/{group_id}/

此端点已被弃用，并由新的端点替换，请参阅 list_workspace_invitations。

对该端点的支持将在 2024 年结束。

如果授权用户对该组有管理员权限，则列出与提供的 group_id 参数相关的组的所有组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listGroupInvitations();

create_group_invitation - post /api/groups/invitations/group/{group_id}/

此端点已被弃用，并由新的端点 create_workspace_invitation 替换。

对该端点的支持将在 2024 年结束。

如果授权用户具有相关组的管理员权限，则为此电子邮件地址创建新的群组邀请。将向用户发送包含注册链接的电子邮件。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createGroupInvitation();

get_group_invitation_by_token - get /api/groups/invitations/token/{token}/

此端点已被弃用，并由新的端点 get_workspace_invitation_by_token 替换。

对该端点的支持将在 2024 年结束。

如果找到具有提供的标记的邀请，则返回序列化的群组邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getGroupInvitationByToken();

order_groups - post /api/groups/order/

此端点已被弃用，并由新的端点 order_workspaces 替换。

对该端点的支持将在 2024 年结束。

更改提供的组 ID 的顺序以匹配列表中 ID 的位置。如果授权用户不属于该组，则会被忽略。顺序将针对每个用户进行自定义。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderGroups();

update_group_user - patch /api/groups/users/{group_user_id}/

此端点已被弃用，并由新的端点 update_workspace_user 替换。

如果授权用户具有相关组的管理员权限，则更新与提供的 group_user_id 参数相关的现有组用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateGroupUser();

delete_group_user - delete /api/groups/users/{group_user_id}/

此端点已被弃用，并由新的端点 delete_workspace_user 替换。

如果授权用户具有相关组的管理员权限，则删除组用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteGroupUser();

list_group_users - get /api/groups/users/group/{group_id}/

此端点已被弃用，并由新的端点 list_workspace_users 替换。

如果授权用户具有相关组的管理员权限，则列出组中的所有用户。要将用户添加到组中，必须首先发送邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listGroupUsers();

update_application_integration - patch /api/integration/{integration_id}/

更新现有集成。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateApplicationIntegration();

delete_application_integration - delete /api/integration/{integration_id}/

删除与给定 id 相关的集成。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteApplicationIntegration();

move_application_integration - patch /api/integration/{integration_id}/move/

在应用程序中移动集成，在另一个集成之前或在没有给定之前集成的情况下位于应用程序的末尾。集成必须属于同一应用程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->moveApplicationIntegration();

list_job - get /api/jobs/

列出所有现有作业。作业是在后台异步执行的任务。您可以使用 get_job 端点来读取作业的当前进度。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listJob();

create_job - post /api/jobs/

创建新的作业。此作业在后台异步运行并执行特定于提供的类型参数的任务。可以使用 get_job 来获取作业的当前状态。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createJob();

get_job - get /api/jobs/{job_id}/

返回与提供的作业 ID 相关的信息。此端点可以用于实时获取作业的状态和进度。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getJob();

admin_licenses - get /api/licenses/

列出注册到此实例的所有有效许可证。高级许可证可用于为固定数量的用户解锁高级功能。企业许可证可以类似地用于解锁企业功能。有关自托管许可证的更多信息，请参阅我们的定价页面 https://baserow.io/pricing。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminLicenses();

admin_register_license - post /api/licenses/

注册新许可证。注册后，您可以分配用户到该许可证，使其在许可证有效期间能够使用许可证功能。如果已经存在具有相同 license_id 的现有许可证，并且提供的许可证晚于该许可证签发，则现有许可证将升级。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminRegisterLicense();

admin_get_license - 获取 /api/licenses/{id}/

返回有关提供的参数相关的许可证的详细信息。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminGetLicense();

admin_remove_license - 删除 /api/licenses/{id}/

删除与提供的参数相关的现有许可证。如果许可证处于活动状态，则正在使用该许可证的所有用户将失去对该许可证授予的功能的访问权限。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminRemoveLicense();

admin_add_user_to_license - 发送 POST 请求到 /api/licenses/{id}/{user_id}/

将与提供的参数相关的用户添加到与参数相关的许可证中。这仅发生在许可证还有足够的座位，并且用户尚未在该许可证上的情况下。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminAddUserToLicense();

admin_remove_user_from_license - 发送 DELETE 请求到 /api/licenses/{id}/{user_id}/

删除与提供的参数相关的用户和与参数相关的许可证。这仅发生在用户在该许可证上时，否则不会发生任何事情。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminRemoveUserFromLicense();

admin_license_check - 获取 /api/licenses/{id}/check/

此端点会与权威机构核对是否需要更新许可证。它还会检查许可证是否在其限制范围内运行，并可能对此采取行动。也可能发生许可证被删除的情况，因为实例 ID 不匹配或因为无效。在这种情况下，将返回 204 状态码。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminLicenseCheck();

admin_fill_remaining_seats_of_license - 发送 POST 请求到 /api/licenses/{id}/fill-seats/

使用找到的第一个用户填充许可证剩余的空座位。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminFillRemainingSeatsOfLicense();

admin_license_lookup_users - 获取 /api/licenses/{id}/lookup-users/

此端点可用于查找可以添加到许可证的用户。已在该许可证上的用户不会在此处返回。可选地，可以提供 search 查询参数来过滤结果。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminLicenseLookupUsers();

admin_remove_all_users_from_license - 发送 POST 请求到 /api/licenses/{id}/remove-all-users/

删除许可证上的所有用户。这将清空所有座位。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->adminRemoveAllUsersFromLicense();

list_workspace_notifications - 获取 /api/notifications/{workspace_id}/

列出给定工作空间和当前用户的通告。响应是分页的，可以使用查询参数控制限制和偏移参数。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listWorkspaceNotifications();

clear_workspace_notifications - 发送 DELETE 请求到 /api/notifications/{workspace_id}/

清除给定工作空间和用户的全部通告。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->clearWorkspaceNotifications();

mark_notification_as_read - 发送 PATCH 请求到 /api/notifications/{workspace_id}/{notification_id}/

将通告标记为已读。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->markNotificationAsRead();

mark_all_workspace_notifications_as_read - 发送 POST 请求到 /api/notifications/{workspace_id}/mark-all-as-read/

将给定工作空间和用户的全部通告标记为已读。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->markAllWorkspaceNotificationsAsRead();

group_list_role_assignments - 获取 /api/role/{group_id}/

此端点已被弃用，并已替换为新的端点 workspace_assign_role。

对该端点的支持将在 2024 年结束。

您可以列出组内的角色分配，可选地限制在该组内的特定范围。如果没有指定范围，则组被视为范围。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupListRoleAssignments();

group_assign_role - 发送 POST 请求到 /api/role/{group_id}/

此端点已被弃用，并已替换为新的端点 workspace_assign_role。

对该端点的支持将在 2024 年结束。

您可以使用此端点将角色分配给给定范围内的给定组中的主题。如果您想删除角色，可以省略角色属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupAssignRole();

group_batch_assign_role - 发送 POST 请求到 /api/role/{group_id}/batch/

此端点已被弃用，并已替换为新的端点 workspace_batch_assign_role。

对该端点的支持将在 2024 年结束。

您可以使用此端点将角色分配给给定范围内的给定组中的多个主题。如果您想删除角色，可以省略角色属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupBatchAssignRole();

list_role_assignments - 获取 /api/role/{workspace_id}/

您可以在工作空间内列出角色分配，可以选择性过滤到该工作空间内的特定范围。如果没有指定范围，则工作空间被视为范围。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listRoleAssignments();

assign_role - post /api/role/{workspace_id}/

使用此端点，您可以为给定范围内的指定工作空间中的主体分配角色。如果您想删除角色，可以省略角色属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->assignRole();

batch_assign_role - post /api/role/{workspace_id}/batch/

使用此端点，您可以为给定工作空间内的多个主体分配角色。如果您想删除角色，可以省略角色属性。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->batchAssignRole();

get_row_comments - get /api/row_comments/{table_id}/{row_id}/

返回指定表和行的所有行注释。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getRowComments();

create_row_comment - post /api/row_comments/{table_id}/{row_id}/

在指定的行上创建注释。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createRowComment();

update_row_comment_notification_mode - put /api/row_comments/{table_id}/{row_id}/notification-mode/

更新用户对指定表行上评论的通知偏好。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateRowCommentNotificationMode();

update_row_comment - patch /api/row_comments/{table_id}/comment/{comment_id}/

更新行注释。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateRowComment();

delete_row_comment - delete /api/row_comments/{table_id}/comment/{comment_id}/

删除行注释。

这是一个 高级 功能。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteRowComment();

get_settings - get /api/settings/

返回所有由管理员配置的设置。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getSettings();

get_instance_id - get /api/settings/instance-id/

返回自托管实例 ID。只有具有员工权限的用户才能请求。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getInstanceId();

update_settings - patch /api/settings/update/

如果用户具有管理员权限，则更新由管理员配置的设置。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateSettings();

delete_snapshot - delete /api/snapshots/{snapshot_id}/

删除快照。删除快照不会影响创建快照的应用程序，也不会影响通过恢复创建的应用程序。快照删除是永久的，无法撤销。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteSnapshot();

restore_snapshot - post /api/snapshots/{snapshot_id}/restore/

恢复快照。当恢复应用程序快照时，将在与原始应用程序相同的工空间中创建一个新应用程序，其名称为快照名称，并在快照创建时在原始应用程序中的数据。原始应用程序不受影响。快照可以多次恢复，并且如果发生冲突，则会在新应用程序名称中添加数字后缀。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->restoreSnapshot();

list_snapshots - get /api/snapshots/application/{application_id}/

列出为给定应用程序创建的快照。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listSnapshots();

create_snapshot - post /api/snapshots/application/{application_id}/

创建新的应用程序快照。快照代表应用程序在特定时间点的状态，以后可以恢复，便于创建整个应用程序的备份。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createSnapshot();

oauth_provider_login_callback - get /api/sso/oauth2/callback/{provider_id}/

处理来自 OAuth2 提供者的回调并成功登录用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->oauthProviderLoginCallback();

oauth_provider_login_redirect - get /api/sso/oauth2/login/{provider_id}/

根据提供的身份验证提供者 ID 重定向到 OAuth2 提供者的身份验证 URL。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->oauthProviderLoginRedirect();

auth_provider_saml_acs_url - post /api/sso/saml/acs/

通过验证 SAML 响应完成 SAML 身份验证流程。如果用户已存在于 Baserow 中，则登录用户或创建一个新的用户。一旦认证，用户将被重定向到他们试图访问的原始 URL。如果响应无效，用户将被重定向到具有特定错误消息的错误页面。如果提供了，它接受语言代码和工作空间邀请令牌作为查询参数。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->authProviderSamlAcsUrl();

auth_provider_saml_sp_login - get /api/sso/saml/login/

当用户想要从 Baserow（服务提供商）启动 SSO SAML 登录时，将调用此端点。用户将被重定向到 SAML 身份提供者（IdP），在那里用户可以认证。一旦在 IdP 中登录，用户将被重定向回断言消费者服务端点（ACS），在那里将验证 SAML 响应，并提供一个新 JWT 会话令牌以与 Baserow API 一起使用。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->authProviderSamlSpLogin();

auth_provider_login_url - get /api/sso/saml/login-url/

返回用于启动SSO SAML登录的正确重定向URL。如果配置了多个SAML提供者，则需要提供电子邮件地址，否则将返回唯一配置的SAML提供者注册URL。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->authProviderLoginUrl();

get_team - get /api/teams/{team_id}/

返回与提供的团队ID相关的信息。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getTeam();

update_team - put /api/teams/{team_id}/

使用新的名称更新现有团队。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateTeam();

delete_team - delete /api/teams/{team_id}/

如果授权用户在团队的工区内，则删除团队。所有相关子项（例如主题）也将被删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteTeam();

list_team_subjects - get /api/teams/{team_id}/subjects/

列出给定团队中的所有团队主题。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listTeamSubjects();

create_subject - post /api/teams/{team_id}/subjects/

创建一个新的团队主题。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createSubject();

get_subject - get /api/teams/{team_id}/subjects/{subject_id}/

返回与提供的主题ID相关的信息。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getSubject();

delete_subject - delete /api/teams/{team_id}/subjects/{subject_id}/

如果授权用户在团队的工区内，则删除主题。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteSubject();

group_list_teams - get /api/teams/group/{group_id}/

此端点已被弃用，并被新的端点workspace_list_teams取代。

对该端点的支持将在 2024 年结束。

列出给定组中的所有团队。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupListTeams();

group_create_team - post /api/teams/group/{group_id}/

此端点已被弃用，并被新的端点workspace_create_team取代。

对该端点的支持将在 2024 年结束。

在给定组中创建一个新的团队。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupCreateTeam();

workspace_list_teams - get /api/teams/workspace/{workspace_id}/

列出给定工区中的所有团队。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceListTeams();

workspace_create_team - post /api/teams/workspace/{workspace_id}/

创建一个新的团队。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceCreateTeam();

list_templates - get /api/templates/

列出所有模板类别及其所属的模板。模板的workspace_id可用于预览目的，因为该工区包含模板中的应用程序。所有与该工区相关的get和list端点都是公开可访问的。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listTemplates();

group_install_template - post /api/templates/install/{group_id}/{template_id}/

此端点已被弃用，并被新的端点workspace_install_template取代。

对该端点的支持将在 2024 年结束。

如果用户有权访问该组，则将给定模板的应用程序安装到该组中。响应包含这些新创建的应用程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupInstallTemplate();

group_install_template_async - post /api/templates/install/{group_id}/{template_id}/async/

此端点已被弃用，并被新的端点workspace_install_template_async取代。

对该端点的支持将在 2024 年结束。

启动异步作业，如果用户有权访问该组，则将给定模板的应用程序安装到该组中。响应包含这些新创建的应用程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupInstallTemplateAsync();

install_template - post /api/templates/install/{workspace_id}/{template_id}/

(弃用)如果用户有权访问该工区，则将给定模板的应用程序安装到该工区中。响应包含这些新创建的应用程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->installTemplate();

install_template_async - post /api/templates/install/{workspace_id}/{template_id}/async/

启动异步作业，如果用户有权访问该工区，则将给定模板的应用程序安装到该工区中。响应包含这些新创建的应用程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->installTemplateAsync();

get_trash_structure - get /api/trash/

响应请求用户可检查的可用工作区和应用程序的垃圾箱内容。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getTrashStructure();

group_get_contents - get /api/trash/group/{group_id}/

此端点已被弃用，并被新的端点workspace_get_contents取代。

对该端点的支持将在 2024 年结束。

根据选择，对特定应用进行过滤后，返回垃圾内容组。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupGetContents();

group_empty_contents - 删除 /api/trash/group/{group_id}/

该端点已弃用，并由新的端点 workspace_empty_contents 替换。

对该端点的支持将在 2024 年结束。

清空指定的组和/或应用中的垃圾，包括组和应用自身如果它们也被删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->groupEmptyContents();

restore - patch /api/trash/restore/

将指定的垃圾项恢复到basern。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->restore();

workspace_get_contents - get /api/trash/workspace/{workspace_id}/

返回垃圾内容，可选地按特定应用进行过滤。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceGetContents();

workspace_empty_contents - delete /api/trash/workspace/{workspace_id}/

清空指定的空间和/或应用中的垃圾，包括空间和应用自身如果它们也被删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspaceEmptyContents();

create_user - post /api/user/

根据提供的值创建新用户。如果需要，可以立即生成一个认证JWT。在创建账户后，将创建包含数据库的初始空间。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createUser();

upload_file - post /api/user-files/upload-file/

通过直接上传文件内容将文件上传到Baserow。期望一个包含文件内容的file多部分。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->uploadFile();

upload_via_url - post /api/user-files/upload-via-url/

通过从提供的URL下载文件将其上传到Baserow。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->uploadViaUrl();

user_source_token_refresh - post /api/user-source-auth-refresh/

生成一个新的access_token，该token可用于使用有效的刷新token从用户源用户开始继续在Baserow上操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->userSourceTokenRefresh();

user_source_token_blacklist - post /api/user-source-token-blacklist/

将提供的用户源token列入黑名单。这可以用来注销用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->userSourceTokenBlacklist();

update_application_user_source - patch /api/user-source/{user_source_id}/

更新现有的用户源。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateApplicationUserSource();

delete_application_user_source - delete /api/user-source/{user_source_id}/

删除与给定id关联的用户源。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteApplicationUserSource();

user_source_force_token_auth - post /api/user-source/{user_source_id}/force-token-auth

根据ID强制验证现有用户。如果成功，将返回一个访问令牌和一个刷新令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->userSourceForceTokenAuth();

move_application_user_source - patch /api/user-source/{user_source_id}/move/

在应用程序中移动用户源，在另一个用户源之前或如果没有提供之前用户源则在应用程序的末尾。用户源必须属于同一应用程序。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->moveApplicationUserSource();

user_source_token_auth - post /api/user-source/{user_source_id}/token-auth

根据凭据对用户源进行验证现有用户。如果成功，将返回一个访问令牌和一个刷新令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->userSourceTokenAuth();

update_account - patch /api/user/account/

更新认证用户的账户信息。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateAccount();

change_password - post /api/user/change-password/

更改认证用户的密码，但只有当旧密码匹配时。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->changePassword();

dashboard - get /api/user/dashboard/

列出所有相关的用户信息，例如可以在仪表板上显示的信息。它将包含该用户的全部待处理工作空间邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->dashboard();

redo - patch /api/user/redo/

重做请求用户执行的最新可重做操作。必须提供ClientSessionId头，并且只有由具有相同ClientSessionId值设置的相同用户执行的操作才会重做。此外，ClientSessionId头必须在1到256个字符之间，并且只能包含字母数字或-字符。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->redo();

reset_password - post /api/user/reset-password/

如果重置token有效，则更改用户的密码。该 send_password_reset_email 端点向用户发送包含token的电子邮件。该token可以用于在此处更改密码，而无需提供旧密码。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->resetPassword();

schedule_account_deletion - post /api/user/schedule-account-deletion/

安排已验证用户的账户删除。用户将在实例管理员定义的宽限期后永久删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->scheduleAccountDeletion();

send_password_reset_email - post /api/user/send-reset-password-email/

向用户的电子邮件地址发送包含密码重置链接的电子邮件。如果找到具有给定电子邮件地址的用户，则会执行此操作。如果找不到电子邮件地址，端点不会失败。链接的有效期为48小时。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->sendPasswordResetEmail();

send_verify_email - post /api/user/send-verify-email/

如果用户的电子邮件尚未验证，则向用户发送包含电子邮件验证链接的电子邮件。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->sendVerifyEmail();

token_auth - post /api/user/token-auth/

基于用户的电子邮件和密码验证现有用户。如果成功，将返回访问令牌和刷新令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->tokenAuth();

token_blacklist - post /api/user/token-blacklist/

将提供的令牌列入黑名单。这可以用来注销用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->tokenBlacklist();

token_refresh - post /api/user/token-refresh/

根据有效的刷新令牌生成新的访问令牌，以便从Baserow的有效刷新令牌开始继续操作。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->tokenRefresh();

token_verify - post /api/user/token-verify/

验证刷新令牌是否有效，并可用于生成新的访问令牌。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->tokenVerify();

undo - patch /api/user/undo/

撤销请求用户执行的最新可撤销操作。必须提供ClientSessionId头，并且只有与请求操作相同的用户和具有相同的ClientSessionId值的API请求执行的操作才会被撤销。此外，ClientSessionId头必须介于1到256个字符之间，并且只能包含字母数字或-字符。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->undo();

verify_email - post /api/user/verify-email/

通过传递正确的验证令牌，可以确认用户的电子邮件地址属于用户。如果请求是由未经身份验证的用户执行的，此端点还可以可选地返回用户信息、访问令牌和刷新令牌，以便自动在系统中签入用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->verifyEmail();

list_workspaces - get /api/workspaces/

列出授权用户的全部工作空间。一个工作空间可以包含多个应用程序，如数据库。多个用户可以访问一个工作空间。例如，每个公司都可以有自己的工作空间，其中包含与该公司相关的数据库。工作空间的顺序是针对每个用户定制的。顺序可以通过order_workspaces端点进行配置。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listWorkspaces();

create_workspace - post /api/workspaces/

创建一个新的工作空间，只有授权用户可以访问。不会添加初始数据，如数据库应用程序，它们必须通过其他端点创建。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createWorkspace();

update_workspace - patch /api/workspaces/{workspace_id}/

如果授权用户属于该工作空间，则更新与提供的workspace_id参数相关的现有工作空间。目前尚无法向工作空间添加其他用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateWorkspace();

delete_workspace - delete /api/workspaces/{workspace_id}/

如果授权用户属于该工作空间，则删除现有工作空间。工作空间中包含的所有应用程序、数据库、表等也将被删除。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteWorkspace();

leave_workspace - post /api/workspaces/{workspace_id}/leave/

如果用户位于提供workspace_id的工作空间中，则使已验证用户离开该工作空间。如果用户是该工作空间中最后的管理员，他们将无法离开。工作空间中必须始终有一个管理员，否则它将无人控制。如果是这种情况，他们必须首先删除工作空间或向其他成员授予管理员权限。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->leaveWorkspace();

workspace_permissions - get /api/workspaces/{workspace_id}/permissions/

返回确定特定用户对特定工作空间权限所需的数据。有关详细信息，请参阅core.handler.CoreHandler.get_permissions()。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->workspacePermissions();

get_workspace_generative_ai_models_settings - get /api/workspaces/{workspace_id}/settings/generative-ai/

返回指定工作区的生成式AI模型设置。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getWorkspaceGenerativeAiModelsSettings();

update_workspace_generative_ai_models_settings - patch /api/workspaces/{workspace_id}/settings/generative-ai/

更新指定工作区的生成式AI模型设置。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateWorkspaceGenerativeAiModelsSettings();

create_initial_workspace - post /api/workspaces/create-initial-workspace/

创建一个初始工作区。通常在用户注册并跳过前端引导后调用。它包含一些示例数据。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createInitialWorkspace();

get_workspace_invitation - get /api/workspaces/invitations/{workspace_invitation_id}/

如果授权用户拥有相关工作区的管理员权限，则返回请求的工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getWorkspaceInvitation();

update_workspace_invitation - patch /api/workspaces/invitations/{workspace_invitation_id}/

如果授权用户拥有相关工作区的管理员权限，则更新与提供的 workspace_invitation_id 参数相关的现有工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateWorkspaceInvitation();

delete_workspace_invitation - delete /api/workspaces/invitations/{workspace_invitation_id}/

如果授权用户拥有相关工作区的管理员权限，则删除工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteWorkspaceInvitation();

accept_workspace_invitation - post /api/workspaces/invitations/{workspace_invitation_id}/accept/

如果用户的电子邮件地址与邀请匹配，则接受具有给定id的工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->acceptWorkspaceInvitation();

reject_workspace_invitation - post /api/workspaces/invitations/{workspace_invitation_id}/reject/

如果用户的电子邮件地址与邀请匹配，则拒绝具有给定id的工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->rejectWorkspaceInvitation();

get_workspace_invitation_by_token - get /api/workspaces/invitations/token/{token}/

如果找到具有提供的token的邀请，则返回序列化的工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->getWorkspaceInvitationByToken();

list_workspace_invitations - get /api/workspaces/invitations/workspace/{workspace_id}/

如果授权用户拥有相关工作区的管理员权限，则列出与提供的 workspace_id 参数相关的工作区的所有工作区邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listWorkspaceInvitations();

create_workspace_invitation - post /api/workspaces/invitations/workspace/{workspace_id}/

如果授权用户拥有相关工作区的管理员权限，则为电子邮件地址创建新的工作区邀请。将向用户发送包含注册链接的电子邮件。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->createWorkspaceInvitation();

order_workspaces - post /api/workspaces/order/

更改提供的workspace ids的顺序，以匹配id在列表中的位置。如果授权用户不属于工作区，则将被忽略。顺序将针对每个用户自定义。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->orderWorkspaces();

update_workspace_user - patch /api/workspaces/users/{workspace_user_id}/

如果授权用户拥有相关工作区的管理员权限，则更新与提供的 workspace_user_id 参数相关的现有工作区用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->updateWorkspaceUser();

delete_workspace_user - delete /api/workspaces/users/{workspace_user_id}/

如果授权用户拥有相关工作区的管理员权限，则删除工作区用户。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->deleteWorkspaceUser();

list_workspace_users - get /api/workspaces/users/workspace/{workspace_id}/

如果授权用户拥有相关工作区的管理员权限，则列出工作区中的所有用户。要将用户添加到工作区，必须首先发送邀请。

$token = 'my-token';
$client = Client::createForUrl('https://baserow.example.com', accessToken: $token);
$client->listWorkspaceUsers();

许可证

Apache 2.0