Quickbase （独立发布者）

Quickbase 是一个应用程序开发平台，它通过使任何技术背景的问题解决者能够协同工作，以安全、安全且持续地创建应用程序生态系统，从而联合业务和 IT 团队。 Quickbase 通过跨一个通用平台大规模实现公民开发，帮助企业加快独特流程的持续创新。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	特洛伊·泰勒
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

连接器元数据
发布者	特洛伊·泰勒，日立解决方案
网站	https://www.quickbase.com/
隐私策略	https://www.quickbase.com/privacy
类别	生产力;IT作

创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
领域主机名	字符串	指定领域主机名的名称。	True
Authorization	securestring	“QB-USER-TOKEN yourToken”形式的用户令牌。	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

下载附件	下载文件附件，其中包含以 base64 格式编码的文件附件内容。 API 响应返回标头中的 `Content-Disposition` 文件名。可以从 /records 和 /reports 终结点（如果适用）检索有关文件的元数据。使用这些终结点获取提取文件所需的信息。
停用用户令牌	停用经过身份验证的用户令牌。完成此作后，必须在用户界面中重新激活用户令牌。
克隆用户令牌	克隆经过身份验证的用户令牌。与该令牌关联的所有应用程序都自动与新令牌相关联。
创建关系	在表和查找/摘要字段中创建关系。只能为同一应用中的表创建关系。
创建字段	在表中创建字段，包括该字段的自定义权限。
创建应用	在帐户中创建应用程序。必须在相应的帐户中拥有应用程序创建权限。可以使用此 API 设置主属性和应用程序变量。
创建表	在应用程序中创建表。
删除关系	使用此终结点可删除整个关系，包括所有查找和摘要字段。不会删除关系中的引用字段。
删除字段	根据字段 ID 删除表中的一个或多个字段。这还将永久删除该字段中的任何数据或计算。
删除应用	删除整个应用程序，包括所有表和数据。
删除用户令牌	删除经过身份验证的用户令牌。这是不可逆的。
删除表	删除应用程序中的特定表，包括其中所有数据。
删除记录	基于查询删除表中的记录。或者，可以删除表中的所有记录。
删除附件	删除一个文件附件版本。可以从 /records 和 /reports 终结点（如果适用）检索有关文件的元数据。使用这些终结点获取删除文件版本所需的信息。
复制应用	复制指定的应用程序。新应用程序将具有与原始应用程序相同的架构。有关其他复制选项，请参阅下文。
插入和更新记录	在表中插入和/或更新记录。在此单个 API 调用中，可以提交插入和更新。更新可以使用表上的键字段或任何其他支持的唯一字段。有关应如何设置每个字段类型的格式的详细信息，请参阅 “字段类型”页。此作允许对成功的记录进行增量处理，即使某些记录失败也是如此。注意：此终结点支持最大有效负载大小 10MB。
更新关系	使用此终结点将查找字段和摘要字段添加到现有关系。更新关系不会删除现有的查找/摘要字段。
更新字段	更新字段的属性和自定义权限。尝试更新某些属性可能会导致现有数据不再服从字段的新属性，并可能被拒绝。有关特定情况，请参阅下面的必需、唯一和选项的说明。在请求正文中未指定的字段的任何属性都将保持不变。
更新应用	更新特定应用程序的主要属性和/或应用程序变量。未在请求正文中指定的应用的任何属性都将保持不变。
更新数据表	更新特定表的主要属性。在请求正文中未指定的表的任何属性都将保持不变。
查询数据	以 Quickbase 查询语言传入查询。根据每个记录的大致大小返回具有智能分页的记录数据。元数据对象将包含循环访问响应并收集更多数据所需的信息。
获取 DBID 的临时令牌	使用此终结点获取限定为应用或表的临时授权令牌。然后，可以使用此令牌进行其他 API 调用（请参阅授权）。此令牌将在 5 分钟内过期。
获取字段	根据字段 ID 获取单个字段的属性。所有字段类型上存在的属性均在顶级返回。对特定类型的字段唯一的属性在“properties”属性下返回。有关每个字段类型的属性的详细信息，请参阅 “字段类型”页。
获取字段使用情况	获取单个字段使用情况统计信息。这是可在字段属性的使用表中找到的信息摘要。
获取应用	返回应用程序的主要属性，包括应用程序变量。
获取应用事件	获取可以根据此应用程序中的数据或用户作触发的事件列表，包括：电子邮件通知、提醒、订阅、QB作、Webhook、记录更改触发的自动化（不包括计划）。
获取应用的表	获取特定应用程序中存在的所有表的列表。每个表的属性与 Get 表中返回的属性相同。
获取所有关系	获取特定表的所有关系及其定义的列表。提供了给定应用程序中关系的父端和子端的详细信息。对于跨应用程序关系，将返回有限的详细信息。
获取所有字段的使用情况	获取表的所有字段使用情况统计信息。这是可在字段属性的使用表中找到的信息摘要。
获取所有表报表	获取表的所有报表的架构（属性）。如果运行 API 的用户是应用程序管理员，该 API 还将返回具有所有者用户 ID 的所有个人报告。
获取报表	获取单个报表的架构（属性）。
获取表	获取作为应用程序一部分的单个表的属性。
获取表的字段	获取特定表中所有字段的属性。每个字段的属性与 Get 字段中的属性相同。
运行公式	允许通过 API 调用运行公式。在自定义代码中使用此方法可获取公式的值，而无需记录上的离散字段。
运行报表	基于 ID 运行报表，并返回与其关联的基础数据。数据的格式因报表类型而异。专注于记录级数据的报表（表、日历等）返回单个记录。聚合报表（摘要，图表）将返回报表中配置的汇总信息。不返回特定于 UI 的元素，例如总计、平均值和可视化效果。基于每个记录的大致大小返回具有智能分页的数据。元数据对象将包含循环访问响应并收集更多数据所需的信息。

下载附件

操作 ID:: DownloadFile

下载文件附件，其中包含以 base64 格式编码的文件附件内容。 API 响应返回标头中的 Content-Disposition 文件名。可以从 /records 和 /reports 终结点（如果适用）检索有关文件的元数据。使用这些终结点获取提取文件所需的信息。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。
记录 ID	recordId	True	integer	记录的唯一标识符。
字段 ID	fieldId	True	integer	字段的唯一标识符。
版本号	versionNumber	True	integer	文件附件版本号。

response: string

停用用户令牌

操作 ID:: DeactivateUserToken

停用经过身份验证的用户令牌。完成此作后，必须在用户界面中重新激活用户令牌。

名称	路径	类型	说明
id	id	integer	id

克隆用户令牌

操作 ID:: CloneUserToken

克隆经过身份验证的用户令牌。与该令牌关联的所有应用程序都自动与新令牌相关联。

参数

名称	密钥	必需	类型	说明
姓名	name		string	克隆的用户令牌的新名称。
描述	description		string	克隆的用户令牌的说明。

克隆用户令牌响应: cloneUserTokenResponse

创建关系

操作 ID:: CreateRelationship

在表和查找/摘要字段中创建关系。只能为同一应用中的表创建关系。

参数

名称	密钥	必需	类型	说明
summaryFid	summaryFid		double	要汇总的字段 ID。
标签	label		string	摘要字段的标签。
AccumulationType	accumulationType	True	string	摘要字段的累积类型。
where	where		string	筛选器使用 Quickbase 查询语言，用于确定要返回的记录。
lookupFieldIds	lookupFieldIds		array of integer	父表中将成为子表中查找字段的字段 ID 数组。
parentTableId	parentTableId	True	string	关系的父表 ID。
标签	label		string	外键字段的标签。
表 ID	tableId	True	string	表的唯一标识符（DBID）。这是子表。

创建关系响应: createRelationshipResponse

创建字段

操作 ID:: CreateField

在表中创建字段，包括该字段的自定义权限。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。
审计	audited		boolean	指示是否在快速数据库审核日志中跟踪该字段。仅当应用启用了审核日志时，才能将此属性设置为“true”。请参阅 “快速数据库审核日志”下的“启用数据更改日志”。
fieldHelp	fieldHelp		string	为产品中的用户显示的已配置的帮助文本。
bold	bold		boolean	指示字段是否配置为在产品中以粗体显示。
comments	comments		string	管理员在字段属性上输入的注释。
doesTotal	doesTotal		boolean	此字段是否在产品内的报表中总计。
autoSave	autoSave		boolean	链接字段是否会自动保存。
defaultValueLuid	defaultValueLuid		integer	默认用户 ID 值。
maxVersions	maxVersions		integer	为文件附件配置的最大版本数。
格式	format		integer	显示时间的格式。
carryChoices	carryChoices		boolean	复制字段时是否应携带其多重选择字段。
最大长度 (maxLength)	maxLength		integer	此字段的 Quickbase 中允许输入的最大字符数。
linkText	linkText		string	已配置的文本值，用于替换用户在产品中看到的 URL。
parentFieldId	parentFieldId		integer	父复合字段的 ID（如果适用）。
displayTimezone	displayTimezone		boolean	指示是否在产品中显示时区。
allowNewChoices	allowNewChoices		boolean	指示用户是否可以向选择列表添加新选项。
defaultToday	defaultToday		boolean	指示当前是否为新记录默认字段值。
单位	units		string	单位标签。
sourceFieldId	sourceFieldId		integer	源字段的 ID。
doesAverage	doesAverage		boolean	此字段是否在产品内的报表中平均值。
公式	formula		string	在 Quickbase 中配置的字段公式。
decimalPlaces	decimalPlaces		integer	此字段的产品中显示的小数位数。
displayMonth	displayMonth		string	如何显示月份。
seeVersions	seeVersions		boolean	指示用户是否可以查看产品中文件附件的最新版本。
numLines	numLines		integer	此文本字段的 Quickbase 中显示的行数。
defaultKind	defaultKind		string	用户默认类型。
displayEmail	displayEmail		string	如何显示电子邮件。
coverText	coverText		string	可用于在浏览器中显示链接的备用用户友好文本。
currencySymbol	currencySymbol		string	在产品中显示字段值时使用的当前符号。
targetFieldId	targetFieldId		integer	目标字段的 ID。
displayUser	displayUser		string	用户如何在产品中显示配置的选项。
blankIsZero	blankIsZero		boolean	是否在产品中的计算中将空白值视为 0。
确切	exact		boolean	报表链接是否需要完全匹配。
defaultDomain	defaultDomain		string	默认电子邮件域。
defaultValue	defaultValue		string	添加新记录时为字段配置的默认值。
缩写	abbreviate		boolean	显示 URL 时不要显示 URL 协议。
numberFormat	numberFormat		integer	用于在产品中显示数值的格式（小数点、分隔符、数字组）。
targetTableName	targetTableName		string	字段的目标表名称。
appearsAs	appearsAs		string	链接文本（如果为空），URL 将用作链接文本。
width	width		integer	产品中字段的 html 输入宽度。
CurrencyFormat	currencyFormat		string	在产品中显示字段值时使用的货币格式。
displayImages	displayImages		boolean	指示图像是否在产品中的窗体和报表上显示文件附件。
displayDayOfWeek	displayDayOfWeek		boolean	指示是否在产品中显示一周中的一天。
commaStart	commaStart		integer	如果适用，在产品中显示逗号之前的位数。
choices	choices		array of string	为提供用户选项的字段存在的条目数组。请注意，这些选项是指将来添加的任何记录的有效值。即使此字段中存在具有这些值的现有记录，也允许从选项列表中删除值。当用户在浏览器中查看数据时，它们将以红色显示，但没有任何其他效果。使用此属性更新字段时，旧选项将被删除并替换为新选项。
targetTableId	targetTableId		string	目标表的 ID。
displayRelative	displayRelative		boolean	是否将时间显示为相对时间。
compositeFields	compositeFields		object
displayTime	displayTime		boolean	指示是否显示时间，以及日期。
VersionMode	versionMode		string	文件的版本模式。保留所有版本与保留最新版本。
snapFieldId	snapFieldId		integer	用于从中获取值快照值的字段的 ID（如果适用）。
hours24	hours24		boolean	指示是否在产品中以 24 小时格式显示时间。
sortAlpha	sortAlpha		boolean	是否按字母顺序排序，默认排序按记录 ID。
sortAsGiven	sortAsGiven		boolean	指示列出的条目是否按字母顺序进行排序。
hasExtension	hasExtension		boolean	此字段是否具有电话扩展。
useNewWindow	useNewWindow		boolean	指示当用户在产品中单击该 URL 时是否应打开一个新窗口。
appendOnly	appendOnly		boolean	此字段是否仅追加。
displayAsLink	displayAsLink		boolean	指示是否应将属于关系的字段显示为指向产品中父记录的超链接。
appearsByDefault	appearsByDefault		boolean	指示字段是否在报表中标记为默认值。
FieldType2	fieldType	True	string	字段类型，单击任何字段类型链接以获取详细信息。
角色	role		string	与字段的给定权限关联的角色
permissionType	permissionType		string	为此字段的角色授予的权限
roleId	roleId		integer	给定角色的 ID
addToForms	addToForms		boolean	要添加的字段是否应显示在窗体上。
标签	label	True	string	字段的标签（名称）。
findEnabled	findEnabled		boolean	指示字段是否标记为可搜索。
noWrap	noWrap		boolean	指示字段是否配置为在产品中显示时不换行。

创建字段响应: createFieldResponse

创建应用

操作 ID:: CreateApp

在帐户中创建应用程序。必须在相应的帐户中拥有应用程序创建权限。可以使用此 API 设置主属性和应用程序变量。

参数

名称	密钥	必需	类型	说明
assignToken	assignToken		boolean	如果要将应用分配给用于创建应用程序的用户令牌，则设置为 true。默认值为 false。
姓名	name	True	string	变量的名称。
value	value	True	string	变量的值。
姓名	name	True	string	应用名称。允许在同一领域创建具有相同名称的多个应用，因为它们将具有不同的 dbid 值。我们敦促你小心这样做。
描述	description		string	应用的说明。如果此属性被排除在外，则应用说明将为空。

创建应用响应: createAppResponse

创建表

操作 ID:: CreateTable

在应用程序中创建表。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符
姓名	name	True	string	表的名称。
pluralRecordName	pluralRecordName		string	表中记录的复数名词。如果未传递此值，则默认值为“Records”。
singleRecordName	singleRecordName		string	表中记录的单一名词。如果未传递此值，则默认值为“Record”。
描述	description		string	表的说明。如果未传递此值，则默认值为空。

创建表响应: createTableResponse

删除关系

操作 ID:: DeleteRelationship

使用此终结点可删除整个关系，包括所有查找和摘要字段。不会删除关系中的引用字段。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符（DBID）。这是子表。
关系 ID	relationshipId	True	double	关系 ID。这是子表上引用字段的字段 ID。

删除关系响应: deleteRelationshipResponse

删除字段

操作 ID:: DeleteFields

根据字段 ID 删除表中的一个或多个字段。这还将永久删除该字段中的任何数据或计算。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。
fieldIds	fieldIds	True	array of integer	要删除的字段 ID 的列表。

删除字段响应: deleteFieldsResponse

删除应用

操作 ID:: DeleteApp

删除整个应用程序，包括所有表和数据。

参数

名称	密钥	必需	类型	说明
姓名	name	True	string	若要确认应用程序删除，请请求应用程序名称。
应用 ID	appId	True	string	应用的唯一标识符。

删除应用响应: deleteAppResponse

删除用户令牌

操作 ID:: DeleteUserToken

删除经过身份验证的用户令牌。这是不可逆的。

删除用户令牌响应: deleteUserTokenResponse

删除表

操作 ID:: DeleteTable

删除应用程序中的特定表，包括其中所有数据。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符
表 ID	tableId	True	string	表的唯一标识符（DBID）。

删除表响应: deleteTableResponse

删除记录

操作 ID:: DeleteRecords

基于查询删除表中的记录。或者，可以删除表中的所有记录。

参数

名称	密钥	必需	类型	说明
from	from	True	string	表的唯一标识符。
where	where	True	string	要删除记录的筛选器。若要删除所有记录，请指定包含所有记录的筛选器，例如 {3.GT.0} ，其中 3 是记录 ID 字段的 ID。

删除记录响应: deleteRecordsResponse

删除附件

操作 ID:: DeleteFile

删除一个文件附件版本。可以从 /records 和 /reports 终结点（如果适用）检索有关文件的元数据。使用这些终结点获取删除文件版本所需的信息。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。
记录 ID	recordId	True	integer	记录的唯一标识符。
字段 ID	fieldId	True	integer	字段的唯一标识符。
版本号	versionNumber	True	integer	文件附件版本号。

删除文件响应: deleteFileResponse

复制应用

操作 ID:: CopyApp

复制指定的应用程序。新应用程序将具有与原始应用程序相同的架构。有关其他复制选项，请参阅下文。

参数

名称	密钥	必需	类型	说明
姓名	name	True	string	新复制的应用的名称
描述	description		string	新复制的应用的说明
assignUserToken	assignUserToken		boolean	是否添加用于向新应用发出此请求的用户令牌
excludeFiles	excludeFiles		boolean	如果 keepData 为 true，则是否也复制文件附件。如果 keepData 为 false，则忽略此属性
keepData	keepData		boolean	是否复制应用的数据以及架构
usersAndRoles	usersAndRoles		boolean	如果为 true，用户将连同分配的角色一起复制。如果为 false，则会复制用户和角色，但不会分配角色
应用 ID	appId	True	string	应用的唯一标识符。

复制应用响应: copyAppResponse

插入和更新记录

操作 ID:: UpsertRecords

在表中插入和/或更新记录。在此单个 API 调用中，可以提交插入和更新。更新可以使用表上的键字段或任何其他支持的唯一字段。有关应如何设置每个字段类型的格式的详细信息，请参阅 “字段类型”页。此作允许对成功的记录进行增量处理，即使某些记录失败也是如此。
注意： 此终结点支持最大有效负载大小 10MB。

参数

名称	密钥	必需	类型	说明
到	to	True	string	表标识符。
数据	data		object
mergeFieldId	mergeFieldId		integer	合并字段 ID。
fieldsToReturn	fieldsToReturn		array of integer	指定一个字段 ID 数组，该数组将返回任何更新或添加的记录的数据。如果请求任何字段 ID，则始终返回记录 ID（FID 3）。

成功的响应，其中包含添加、更新或未更改的记录的详细信息。在下面的示例中，该表以前有 1 到 10 个 ID 的十条记录。用户发布更新记录 1 值并添加两条新记录（全部成功）的更新插入。

Upsert 响应: upsertResponse

更新关系

操作 ID:: UpdateRelationship

使用此终结点将查找字段和摘要字段添加到现有关系。更新关系不会删除现有的查找/摘要字段。

参数

名称	密钥	必需	类型	说明
summaryFid	summaryFid		double	要汇总的字段 ID。
标签	label		string	摘要字段的标签。
AccumulationType	accumulationType	True	string	摘要字段的累积类型。
where	where		string	筛选器使用 Quickbase 查询语言，用于确定要返回的记录。
lookupFieldIds	lookupFieldIds		array of integer	父表上的字段 ID 数组，该数组将成为子表中的查阅字段。
表 ID	tableId	True	string	表的唯一标识符（DBID）。这是子表。
关系 ID	relationshipId	True	double	关系 ID。这是子表上引用字段的字段 ID。

更新关系响应: updateRelationshipResponse

更新字段

操作 ID:: UpdateField

更新字段的属性和自定义权限。尝试更新某些属性可能会导致现有数据不再服从字段的新属性，并可能被拒绝。有关特定情况，请参阅下面的必需、唯一和选项的说明。在请求正文中未指定的字段的任何属性都将保持不变。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。
审计	audited		boolean	指示是否在快速数据库审核日志中跟踪该字段。仅当应用启用了审核日志时，才能将此属性设置为“true”。请参阅 “快速数据库审核日志”下的“启用数据更改日志”。
fieldHelp	fieldHelp		string	为产品中的用户显示的已配置的帮助文本。
bold	bold		boolean	指示字段是否配置为在产品中以粗体显示。
required	required		boolean	指示字段是否是必需的（即，如果每个记录必须在此字段中具有非 null 值）。如果尝试将字段从不需要更改为必需字段，并且该表当前包含在该字段中具有 null 值的记录，则会收到一个错误，指示该字段存在 null 值。在这种情况下，需要在将字段更改为必需字段之前查找并更新这些记录，其值为 null。
comments	comments		string	管理员在字段属性上输入的注释。
doesTotal	doesTotal		boolean	此字段是否在产品内的报表中总计。
autoSave	autoSave		boolean	链接字段是否会自动保存。
defaultValueLuid	defaultValueLuid		integer	默认用户 ID 值。
maxVersions	maxVersions		integer	为文件附件配置的最大版本数。
格式	format		integer	显示时间的格式。
carryChoices	carryChoices		boolean	复制字段时是否应携带其多重选择字段。
最大长度 (maxLength)	maxLength		integer	此字段的 Quickbase 中允许输入的最大字符数。
linkText	linkText		string	已配置的文本值，用于替换用户在产品中看到的 URL。
parentFieldId	parentFieldId		integer	父复合字段的 ID（如果适用）。
displayTimezone	displayTimezone		boolean	指示是否在产品中显示时区。
summaryTargetFieldId	summaryTargetFieldId		integer	用于聚合子级值（如果适用）的字段的 ID。如果摘要函数不需要字段选择（如计数），则显示 0。
allowNewChoices	allowNewChoices		boolean	指示用户是否可以向选择列表添加新选项。
defaultToday	defaultToday		boolean	指示当前是否为新记录默认字段值。
单位	units		string	单位标签。
lookupTargetFieldId	lookupTargetFieldId		integer	此查找的父表上的目标字段的 ID。
SummaryFunction3	summaryFunction		string	摘要字段的累积类型。
sourceFieldId	sourceFieldId		integer	源字段的 ID。
doesAverage	doesAverage		boolean	此字段是否在产品内的报表中平均值。
公式	formula		string	在 Quickbase 中配置的字段公式。
decimalPlaces	decimalPlaces		integer	此字段的产品中显示的小数位数。
displayMonth	displayMonth		string	如何显示月份。
seeVersions	seeVersions		boolean	指示用户是否可以查看产品中文件附件的最新版本。
numLines	numLines		integer	此文本字段的 Quickbase 中显示的行数。
defaultKind	defaultKind		string	用户默认类型。
displayEmail	displayEmail		string	如何显示电子邮件。
coverText	coverText		string	可用于在浏览器中显示链接的备用用户友好文本。
currencySymbol	currencySymbol		string	在产品中显示字段值时使用的当前符号。
summaryQuery	summaryQuery		string	摘要查询。
targetFieldId	targetFieldId		integer	目标字段的 ID。
displayUser	displayUser		string	用户如何在产品中显示配置的选项。
blankIsZero	blankIsZero		boolean	是否在产品中的计算中将空白值视为 0。
确切	exact		boolean	报表链接是否需要完全匹配。
defaultDomain	defaultDomain		string	默认电子邮件域。
defaultValue	defaultValue		string	添加新记录时为字段配置的默认值。
缩写	abbreviate		boolean	显示 URL 时不要显示 URL 协议。
numberFormat	numberFormat		integer	用于在产品中显示数值的格式（小数点、分隔符、数字组）。
targetTableName	targetTableName		string	字段的目标表名称。
appearsAs	appearsAs		string	链接文本（如果为空），URL 将用作链接文本。
width	width		integer	产品中字段的 html 输入宽度。
CurrencyFormat	currencyFormat		string	在产品中显示字段值时使用的货币格式。
displayImages	displayImages		boolean	指示图像是否在产品中的窗体和报表上显示文件附件。
displayDayOfWeek	displayDayOfWeek		boolean	指示是否在产品中显示一周中的一天。
summaryReferenceFieldId	summaryReferenceFieldId		integer	此摘要关系中引用的字段的 ID。
commaStart	commaStart		integer	如果适用，在产品中显示逗号之前的位数。
choices	choices		array of string	为提供用户选项的字段存在的条目数组。请注意，这些选项是指将来添加的任何记录的有效值。即使此字段中存在具有这些值的现有记录，也允许从选项列表中删除值。当用户在浏览器中查看数据时，它们将以红色显示，但没有任何其他效果。使用此属性更新字段时，旧选项将被删除并替换为新选项。
targetTableId	targetTableId		string	目标表的 ID。
displayRelative	displayRelative		boolean	是否将时间显示为相对时间。
compositeFields	compositeFields		object
summaryTableId	summaryTableId		string	摘要字段引用来自的字段的表。
displayTime	displayTime		boolean	指示是否显示时间，以及日期。
VersionMode	versionMode		string	文件的版本模式。保留所有版本与保留最新版本。
snapFieldId	snapFieldId		integer	用于从中获取值快照值的字段的 ID（如果适用）。
hours24	hours24		boolean	指示是否在产品中以 24 小时格式显示时间。
sortAlpha	sortAlpha		boolean	是否按字母顺序排序，默认排序按记录 ID。
sortAsGiven	sortAsGiven		boolean	指示列出的条目是否按字母顺序进行排序。
hasExtension	hasExtension		boolean	此字段是否具有电话扩展。
useNewWindow	useNewWindow		boolean	指示当用户在产品中单击该 URL 时是否应打开一个新窗口。
appendOnly	appendOnly		boolean	此字段是否仅追加。
displayAsLink	displayAsLink		boolean	指示是否应将属于关系的字段显示为指向产品中父记录的超链接。
lookupReferenceFieldId	lookupReferenceFieldId		integer	此查找关系中引用的字段的 ID。
appearsByDefault	appearsByDefault		boolean	指示字段是否在报表中标记为默认值。
独特	unique		boolean	指示表中每个记录是否必须包含此字段的唯一值。如果尝试将字段从不唯一更改为唯一，并且该表当前包含此字段具有相同值的记录，则会收到错误。在这种情况下，需要在将字段更改为唯一之前查找和更新这些记录，其中包含字段的重复值。
角色	role		string	与字段的给定权限关联的角色
permissionType	permissionType		string	为此字段的角色授予的权限
roleId	roleId		integer	给定角色的 ID
addToForms	addToForms		boolean	要添加的字段是否应显示在窗体上。
标签	label		string	字段的标签（名称）。
findEnabled	findEnabled		boolean	指示字段是否标记为可搜索。
noWrap	noWrap		boolean	指示字段是否配置为在产品中显示时不换行。
字段 ID	fieldId	True	integer	字段的唯一标识符（FID）。

更新字段响应: updateFieldResponse

更新应用

操作 ID:: UpdateApp

更新特定应用程序的主要属性和/或应用程序变量。未在请求正文中指定的应用的任何属性都将保持不变。

参数

名称	密钥	必需	类型	说明
姓名	name	True	string	变量的名称。
value	value	True	string	变量的值。
姓名	name		string	应用的名称。
描述	description		string	应用的说明。
应用 ID	appId	True	string	应用的唯一标识符。

更新应用响应: updateAppResponse

更新数据表

操作 ID:: UpdateTable

更新特定表的主要属性。在请求正文中未指定的表的任何属性都将保持不变。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符
姓名	name		string	表的名称。
pluralRecordName	pluralRecordName		string	表中记录的复数名词。如果未传递此值，则默认值为“Records”。
singleRecordName	singleRecordName		string	表中记录的单一名词。如果未传递此值，则默认值为“Record”。
描述	description		string	表的说明。如果未传递此值，则默认值为空。
表 ID	tableId	True	string	表的唯一标识符（DBID）。

更新表响应: updateTableResponse

查询数据

操作 ID:: RunQuery

以 Quickbase 查询语言传入查询。根据每个记录的大致大小返回具有智能分页的记录数据。元数据对象将包含循环访问响应并收集更多数据所需的信息。

参数

名称	密钥	必需	类型	说明
跳过	skip		integer	要跳过的记录数。
compareWithAppLocalTime	compareWithAppLocalTime		boolean	是否针对应用程序本地时间的日期时间字段运行查询。默认情况下，查询使用 UTC 时间运行。
top	top		integer	要显示的最大记录数。
where	where		string	筛选器使用 Quickbase 查询语言，用于确定要返回的记录。如果省略此参数，查询将返回所有记录。
fieldId	fieldId		integer	表中字段的唯一标识符。
Grouping	grouping		string	根据升序（ASC）、降序（DESC）或等值（等值）进行分组
sortBy	sortBy		object	默认情况下，如果查询不提供任何查询，查询将按给定的排序字段或默认排序。设置为 false 以避免在返回的数据顺序不重要时进行排序。在不排序的情况下返回数据可以提高性能。
select	select		object
from	from	True	string	表标识符。

运行查询响应: runQueryResponse

获取 DBID 的临时令牌

操作 ID:: GetTempTokenDBID

使用此终结点获取限定为应用或表的临时授权令牌。然后，可以使用此令牌进行其他 API 调用（请参阅授权）。此令牌将在 5 分钟内过期。

参数

名称	密钥	必需	类型	说明
应用令牌	QB-App-Token		string	Quickbase 应用令牌
DBID	dbid	True	string	应用或表的唯一标识符。

getTempTokenDBIDResponse: getTempTokenDBIDResponse

获取字段

操作 ID:: GetField

根据字段 ID 获取单个字段的属性。
所有字段类型上存在的属性均在顶级返回。对特定类型的字段唯一的属性在“properties”属性下返回。有关每个字段类型的属性的详细信息，请参阅 “字段类型”页。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符（DBID）。
包括字段权限	includeFieldPerms		boolean	如果要返回字段的自定义权限，请设置为“true”。
字段 ID	fieldId	True	integer	字段的唯一标识符（FID）。

获取字段响应: getFieldResponse

获取字段使用情况

操作 ID:: GetFieldUsage

获取单个字段使用情况统计信息。这是可在字段属性的使用表中找到的信息摘要。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符（DBID）。
字段 ID	fieldId	True	integer	字段的唯一标识符（FID）。

名称	路径	类型	说明
		array of object
ID	field.id	integer	标识符。
Name	field.name	string	名称。
类型	field.type	string	类型。
计数	usage.actions.count	integer	计数。
计数	usage.appHomePages.count	integer	计数。
计数	usage.defaultReports.count	integer	计数。
计数	usage.exactForms.count	integer	计数。
计数	usage.fields.count	integer	计数。
计数	usage.forms.count	integer	计数。
计数	usage.notifications.count	integer	计数。
计数	usage.personalReports.count	integer	计数。
计数	usage.relationships.count	integer	计数。
计数	usage.reminders.count	integer	计数。
计数	usage.reports.count	integer	计数。
计数	usage.roles.count	integer	计数。
计数	usage.webhooks.count	integer	计数。

获取应用

操作 ID:: GetApp

返回应用程序的主要属性，包括应用程序变量。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符。

获取应用响应: getAppResponse

获取应用事件

操作 ID:: GetAppEvents

获取可以根据此应用程序中的数据或用户作触发的事件列表，包括：电子邮件通知、提醒、订阅、QB作、Webhook、记录更改触发的自动化（不包括计划）。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符。

名称	路径	类型	说明
		array of object
类型	type	string	类型。
Email	owner.email	string	所有者的电子邮件地址。
ID	owner.id	string	所有者的标识符。
Name	owner.name	string	所有者的名称。
用户名	owner.userName	string	所有者的用户名。
处于活动状态	isActive	boolean	是否处于活动状态。
表 ID	tableId	string	表的标识符。
Name	name	string	名称。
URL	url	string	URL 地址。

获取应用的表

操作 ID:: GetAppTables

获取特定应用程序中存在的所有表的列表。每个表的属性与 Get 表中返回的属性相同。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符

名称	路径	类型	说明
		array of object
Name	name	string	名称。
已创建	created	string	创建时。
Updated	updated	string	更新时。
别名	alias	string	别名。
Description	description	string	说明。
ID	id	string	标识符。
下一条记录 ID	nextRecordId	integer	下一条记录的标识符。
下一个字段 ID	nextFieldId	integer	下一个字段的标识符。
默认排序字段 ID	defaultSortFieldId	integer	默认排序字段的标识符。
默认排序顺序	defaultSortOrder	string	默认排序顺序。
键字段 ID	keyFieldId	integer	键字段的标识符。
单个记录名称	singleRecordName	string	单个记录名称。
复数记录名称	pluralRecordName	string	复数记录名称。
大小限制	sizeLimit	string	大小限制。
已用空间	spaceUsed	string	已用空间。
剩余空间	spaceRemaining	string	剩余空间。

获取所有关系

操作 ID:: GetRelationships

获取特定表的所有关系及其定义的列表。提供了给定应用程序中关系的父端和子端的详细信息。对于跨应用程序关系，将返回有限的详细信息。

参数

名称	密钥	必需	类型	说明
跳过	skip		integer	要跳过的关系数。
表 ID	tableId	True	string	表的唯一标识符（DBID）。

获取关系响应: getRelationshipsResponse

获取所有字段的使用情况

操作 ID:: GetFieldsUsage

获取表的所有字段使用情况统计信息。这是可在字段属性的使用表中找到的信息摘要。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符（DBID）。
跳过	skip		integer	要从列表中跳过的字段数。
Top	top		integer	要返回的最大字段数。

名称	路径	类型	说明
		array of object
ID	field.id	integer	标识符。
Name	field.name	string	名称。
类型	field.type	string	类型。
计数	usage.actions.count	integer	计数。
计数	usage.appHomePages.count	integer	计数。
计数	usage.defaultReports.count	integer	计数。
计数	usage.exactForms.count	integer	计数。
计数	usage.fields.count	integer	计数。
计数	usage.forms.count	integer	计数。
计数	usage.notifications.count	integer	计数。
计数	usage.personalReports.count	integer	计数。
计数	usage.relationships.count	integer	计数。
计数	usage.reminders.count	integer	计数。
计数	usage.reports.count	integer	计数。
计数	usage.roles.count	integer	计数。
计数	usage.webhooks.count	integer	计数。

获取所有表报表

操作 ID:: GetTableReports

获取表的所有报表的架构（属性）。如果运行 API 的用户是应用程序管理员，该 API 还将返回具有所有者用户 ID 的所有个人报告。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。

名称	路径	类型	说明
		array of object
ID	id	string	标识符。
Name	name	string	名称。
类型	type	string	类型。
Description	description	string	说明。
负责人 ID	ownerId	string	所有者的标识符。
已用最后一次	usedLast	string	上次使用时。
已用计数	usedCount	integer	已用计数。

获取报表

操作 ID:: GetReport

获取单个报表的架构（属性）。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符。
报表 ID	reportId	True	string	报表的标识符，表唯一。

获取报表响应: getReportResponse

获取表

操作 ID:: GetTable

获取作为应用程序一部分的单个表的属性。

参数

名称	密钥	必需	类型	说明
应用 ID	appId	True	string	应用的唯一标识符
表 ID	tableId	True	string	表的唯一标识符（DBID）。

获取表响应: getTableResponse

获取表的字段

操作 ID:: GetFields

获取特定表中所有字段的属性。每个字段的属性与 Get 字段中的属性相同。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	表的唯一标识符（DBID）。
包括字段权限	includeFieldPerms		boolean	如果要返回字段的自定义权限，请设置为“true”。

名称	路径	类型	说明
		array of object
ID	id	integer	标识符。
标签	label	string	标签。
字段类型	fieldType	string	字段类型。
无换行	noWrap	boolean	是否没有包装。
Bold	bold	boolean	是否加粗。
必选	required	boolean	是否需要。
默认显示	appearsByDefault	boolean	是否默认显示。
查找已启用	findEnabled	boolean	是否启用查找。
唯一	unique	boolean	是否唯一。
数据复制	doesDataCopy	boolean	数据是否复制。
字段帮助	fieldHelp	string	字段帮助。
审计	audited	boolean	是否已审核。
主键	properties.primaryKey	boolean	主键是否。
外键	properties.foreignKey	boolean	外键是否为外键。
Num Lines	properties.numLines	integer	行数。
最大长度	properties.maxLength	integer	最大长度。
仅追加	properties.appendOnly	boolean	是否仅追加。
allowHTML	properties.allowHTML	boolean	是否允许 HTML。
按给定排序	properties.sortAsGiven	boolean	是否按给定方式排序。
携带选项	properties.carryChoices	boolean	是否携带选择。
允许新选项	properties.allowNewChoices	boolean	是否允许新选择。
Formula	properties.formula	string	公式。
默认值	properties.defaultValue	string	默认值。
数字格式	properties.numberFormat	integer	数字格式。
小数位数	properties.decimalPlaces	integer	小数位数。
是否为平均值	properties.doesAverage	boolean	是否为平均值。
总计	properties.doesTotal	boolean	是否总计。
空白为零	properties.blankIsZero	boolean	空白是否为零。
Permissions	permissions	array of object
权限类型	permissions.permissionType	string	权限类型。
角色	permissions.role	string	角色。
角色 ID	permissions.roleId	integer	角色的标识符。
添加到窗体	addToForms	boolean	是否添加到窗体。

运行公式

操作 ID:: RunFormula

允许通过 API 调用运行公式。在自定义代码中使用此方法可获取公式的值，而无需记录上的离散字段。

参数

名称	密钥	必需	类型	说明
公式	formula	True	string	要运行的公式。这必须是有效的 Quickbase 公式。
摆脱	rid		integer	要对其运行公式的记录 ID。仅适用于在记录上下文中运行的公式。例如，公式 User（）不需要记录 ID。
from	from	True	string	表的唯一标识符（dbid）。

运行公式响应: runFormulaResponse

运行报表

操作 ID:: RunReport

基于 ID 运行报表，并返回与其关联的基础数据。数据的格式因报表类型而异。专注于记录级数据的报表（表、日历等）返回单个记录。聚合报表（摘要，图表）将返回报表中配置的汇总信息。不返回特定于 UI 的元素，例如总计、平均值和可视化效果。基于每个记录的大致大小返回具有智能分页的数据。元数据对象将包含循环访问响应并收集更多数据所需的信息。

参数

名称	密钥	必需	类型	说明
表 ID	tableId	True	string	报表的表的标识符。
跳过	skip		integer	要跳过的记录数。在分页浏览一组结果时，可以设置此值。
Top	top		integer	要返回的最大记录数。可以重写默认的 Quickbase 分页以获取更多或更少的结果。如果此处的请求值超过动态最大值，我们将返回结果的子集，其余值可以在后续 API 调用中收集。
			object
报表 ID	reportId	True	string	报表的标识符，表唯一。

运行报表响应: runReportResponse

定义

createAppResponse

名称	路径	类型	说明
姓名	name	string	应用名称。允许在同一领域创建具有相同名称的多个应用，因为它们将具有不同的 dbid 值。我们敦促你小心这样做。
描述	description	string	应用的说明。如果此属性被排除在外，则应用说明将为空。
已创建	created	string	应用创建的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	应用上次更新的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
日期格式	dateFormat	string	此应用中显示日期值时所使用的格式的说明。请注意，这是仅限浏览器的参数 - 请参阅 API 指南中的 “字段类型详细信息 ”页，了解如何在 API 调用中返回时间值。请参阅 “关于本地化日期 ”以设置应用的日期格式。
timeZone	timeZone	string	此应用中显示时间值时使用的时区的说明。请注意，这是仅限浏览器的参数 - 请参阅门户中的 “字段类型详细信息 ”页，了解 API 调用中返回时间值的方式。请参阅设置应用程序和帐户的时区以设置应用程序的时区。
id	id	string	此应用程序的唯一标识符。
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	指示应用是否包括 Internet 上的每个人访问。请参阅与 Internet 上的每个人共享应用（EOTI）。
变量	variables	array of Variable1	应用变量。请参阅关于应用程序变量
dataClassification	dataClassification	string	分配给应用程序的数据分类标签。如果未打开数据分类，则不会返回。如果数据分类已打开，但未标记应用程序，则返回“None”。平台+ 计划的领域管理员可以在管理控制台中添加数据分类标签。

变量1

名称	路径	类型	说明
姓名	name	string	变量名称。
value	value	string	变量值。

getAppResponse

名称	路径	类型	说明
姓名	name	string	应用名称。允许在同一领域创建具有相同名称的多个应用，因为它们将具有不同的 dbid 值。我们敦促你小心这样做。
描述	description	string	应用的说明。如果此属性被排除在外，则应用说明将为空。
已创建	created	string	应用创建的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	应用上次更新的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
日期格式	dateFormat	string	此应用中显示日期值时所使用的格式的说明。请注意，这是仅限浏览器的参数 - 请参阅 API 指南中的 “字段类型详细信息 ”页，了解如何在 API 调用中返回时间值。请参阅 “关于本地化日期 ”以设置应用的日期格式。
timeZone	timeZone	string	此应用中显示时间值时使用的时区的说明。请注意，这是仅限浏览器的参数 - 请参阅门户中的 “字段类型详细信息 ”页，了解 API 调用中返回时间值的方式。请参阅设置应用程序和帐户的时区以设置应用程序的时区。
id	id	string	此应用程序的唯一标识符。
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	指示应用是否包括 Internet 上的每个人访问。请参阅与 Internet 上的每个人共享应用（EOTI）。
变量	variables	array of Variable1	应用变量。请参阅关于应用程序变量
dataClassification	dataClassification	string	分配给应用程序的数据分类标签。如果未打开数据分类，则不会返回。如果数据分类已打开，但未标记应用程序，则返回“None”。平台+ 计划的领域管理员可以在管理控制台中添加数据分类标签。

updateAppResponse

名称	路径	类型	说明
姓名	name	string	应用名称。允许在同一领域创建具有相同名称的多个应用，因为它们将具有不同的 dbid 值。我们敦促你小心这样做。
描述	description	string	应用的说明。如果此属性被排除在外，则应用说明将为空。
已创建	created	string	应用创建的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	应用上次更新的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
日期格式	dateFormat	string	此应用中显示日期值时所使用的格式的说明。请注意，这是仅限浏览器的参数 - 请参阅 API 指南中的 “字段类型详细信息 ”页，了解如何在 API 调用中返回时间值。请参阅 “关于本地化日期 ”以设置应用的日期格式。
timeZone	timeZone	string	此应用中显示时间值时使用的时区的说明。请注意，这是仅限浏览器的参数 - 请参阅门户中的 “字段类型详细信息 ”页，了解 API 调用中返回时间值的方式。请参阅设置应用程序和帐户的时区以设置应用程序的时区。
id	id	string	此应用程序的唯一标识符。
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	指示应用是否包括 Internet 上的每个人访问。请参阅与 Internet 上的每个人共享应用（EOTI）。
变量	variables	array of Variable1	应用变量。请参阅关于应用程序变量
dataClassification	dataClassification	string	分配给应用程序的数据分类标签。如果未打开数据分类，则不会返回。如果数据分类已打开，但未标记应用程序，则返回“None”。平台+ 计划的领域管理员可以在管理控制台中添加数据分类标签。

deleteAppResponse

名称	路径	类型	说明
deletedAppId	deletedAppId	string	已删除应用程序的 ID。

copyAppResponse

名称	路径	类型	说明
姓名	name	string	应用名称。允许在同一领域创建具有相同名称的多个应用，因为它们将具有不同的 dbid 值。我们敦促你小心这样做。
描述	description	string	应用的说明
已创建	created	string	应用创建的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	应用上次更新的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
日期格式	dateFormat	string	此应用中显示日期值时所使用的格式的说明。请注意，这是仅限浏览器的参数 - 请参阅 API 指南中的 “字段类型详细信息 ”页，了解如何在 API 调用中返回时间值。请参阅 “关于本地化日期 ”以设置应用的日期格式。
timeZone	timeZone	string	此应用中显示时间值时使用的时区的说明。请注意，这是仅限浏览器的参数 - 请参阅门户中的 “字段类型详细信息 ”页，了解 API 调用中返回时间值的方式。请参阅设置应用程序和帐户的时区以设置应用程序的时区。
id	id	string	此应用程序的唯一标识符。
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	指示应用是否包括 Internet 上的每个人访问。请参阅与 Internet 上的每个人共享应用（EOTI）。
变量	variables	array of Variable1	应用变量。请参阅关于应用程序变量
ancestorId	ancestorId	string	从中复制此应用的 ID
dataClassification	dataClassification	string	分配给应用程序的数据分类标签。如果未打开数据分类，则不会返回。如果数据分类已打开，但未标记应用程序，则返回“None”。平台+ 计划的领域管理员可以在管理控制台中添加数据分类标签。

createTableResponse

名称	路径	类型	说明
姓名	name	string	表的名称。
id	id	string	表的唯一标识符（dbid）。
别名	alias	string	表的自动创建的表别名。
描述	description	string	由应用程序管理员配置表的说明。
已创建	created	string	创建表的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	上次更新表架构或数据的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
nextRecordId	nextRecordId	integer	创建下一条记录时将使用的增量记录 ID，如在运行 API 调用时确定的那样。
nextFieldId	nextFieldId	integer	创建下一个字段时将使用的增量字段 ID，如运行 API 调用时确定的那样。
defaultSortFieldId	defaultSortFieldId	integer	为默认排序配置的字段的 ID。
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	表上默认排序顺序的配置。
keyFieldId	keyFieldId	integer	配置为此表上的键的字段的 ID，通常是 Quickbase 记录 ID。
singleRecordName	singleRecordName	string	表由生成器配置的单一名词。
pluralRecordName	pluralRecordName	string	表的生成器配置的复数名词。
sizeLimit	sizeLimit	string	表的大小限制。
spaceUsed	spaceUsed	string	表当前使用的空间量。
spaceRemaining	spaceRemaining	string	表剩余的空间量。

DefaultSortOrder

表上默认排序顺序的配置。

DefaultSortOrder: string

getTableResponse

名称	路径	类型	说明
姓名	name	string	表的名称。
id	id	string	表的唯一标识符（dbid）。
别名	alias	string	表的自动创建的表别名。
描述	description	string	由应用程序管理员配置表的说明。
已创建	created	string	创建表的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	上次更新表架构或数据的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
nextRecordId	nextRecordId	integer	创建下一条记录时将使用的增量记录 ID，如在运行 API 调用时确定的那样。
nextFieldId	nextFieldId	integer	创建下一个字段时将使用的增量字段 ID，如运行 API 调用时确定的那样。
defaultSortFieldId	defaultSortFieldId	integer	为默认排序配置的字段的 ID。
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	表上默认排序顺序的配置。
keyFieldId	keyFieldId	integer	配置为此表上的键的字段的 ID，通常是 Quickbase 记录 ID。
singleRecordName	singleRecordName	string	表由生成器配置的单一名词。
pluralRecordName	pluralRecordName	string	表的生成器配置的复数名词。
sizeLimit	sizeLimit	string	表的大小限制。
spaceUsed	spaceUsed	string	表当前使用的空间量。
spaceRemaining	spaceRemaining	string	表剩余的空间量。

updateTableResponse

名称	路径	类型	说明
姓名	name	string	表的名称。
id	id	string	表的唯一标识符（dbid）。
别名	alias	string	表的自动创建的表别名。
描述	description	string	由应用程序管理员配置表的说明。
已创建	created	string	创建表的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
更新	updated	string	上次更新表架构或数据的时间和日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
nextRecordId	nextRecordId	integer	创建下一条记录时将使用的增量记录 ID，如在运行 API 调用时确定的那样。
nextFieldId	nextFieldId	integer	创建下一个字段时将使用的增量字段 ID，如运行 API 调用时确定的那样。
defaultSortFieldId	defaultSortFieldId	integer	为默认排序配置的字段的 ID。
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	表上默认排序顺序的配置。
keyFieldId	keyFieldId	integer	配置为此表上的键的字段的 ID，通常是 Quickbase 记录 ID。
singleRecordName	singleRecordName	string	表由生成器配置的单一名词。
pluralRecordName	pluralRecordName	string	表的生成器配置的复数名词。
sizeLimit	sizeLimit	string	表的大小限制。
spaceUsed	spaceUsed	string	表当前使用的空间量。
spaceRemaining	spaceRemaining	string	表剩余的空间量。

deleteTableResponse

名称	路径	类型	说明
deletedTableId	deletedTableId	string	已删除的表 ID。

getRelationshipsResponse

名称	路径	类型	说明
关系	relationships	array of Relationship	表中的关系。
Metadata	metadata	Metadata	有关可能有帮助的结果的其他信息。

关系

名称	路径	类型	说明
id	id	integer	关系 ID （外键字段 ID）。
parentTableId	parentTableId	string	关系的父表 ID。
childTableId	childTableId	string	关系的子表 ID。
ForeignKeyField	foreignKeyField	ForeignKeyField	外键字段信息。
isCrossApp	isCrossApp	boolean	这是否是跨应用关系。
lookupFields	lookupFields	array of LookupField	查阅字段数组。
summaryFields	summaryFields	array of SummaryField	摘要字段数组。

ForeignKeyField

外键字段信息。

名称	路径	类型	说明
id	id	integer	字段 ID。
标签	label	string	字段标签。
类型	type	string	字段类型。

LookupField

名称	路径	类型	说明
id	id	integer	字段 ID。
标签	label	string	字段标签。
类型	type	string	字段类型。

SummaryField

名称	路径	类型	说明
id	id	integer	字段 ID。
标签	label	string	字段标签。
类型	type	string	字段类型。

Metadata

有关可能有帮助的结果的其他信息。

名称	路径	类型	说明
跳过	skip	integer	要跳过的关系数。
totalRelationships	totalRelationships	integer	关系总数。
numRelationships	numRelationships	integer	当前响应对象中的关系数。

createRelationshipResponse

名称	路径	类型	说明
id	id	integer	关系 ID （外键字段 ID）。
parentTableId	parentTableId	string	关系的父表 ID。
childTableId	childTableId	string	关系的子表 ID。
ForeignKeyField	foreignKeyField	ForeignKeyField	外键字段信息。
isCrossApp	isCrossApp	boolean	这是否是跨应用关系。
lookupFields	lookupFields	array of LookupField	查阅字段数组。
summaryFields	summaryFields	array of SummaryField	摘要字段数组。

updateRelationshipResponse

名称	路径	类型	说明
id	id	integer	关系 ID （外键字段 ID）。
parentTableId	parentTableId	string	关系的父表 ID。
childTableId	childTableId	string	关系的子表 ID。
ForeignKeyField	foreignKeyField	ForeignKeyField	外键字段信息。
isCrossApp	isCrossApp	boolean	这是否是跨应用关系。
lookupFields	lookupFields	array of LookupField	查阅字段数组。
summaryFields	summaryFields	array of SummaryField	摘要字段数组。

deleteRelationshipResponse

名称	路径	类型	说明
relationshipId	relationshipId	integer	关系 ID。

Query

在 Quickbase 中配置的查询定义，该定义在运行报表时执行。

名称	路径	类型	说明
tableId	tableId	string	报表的表标识符。
筛选器	filter	string	用于查询数据的筛选器。
formulaFields	formulaFields	array of FormulaField	计算公式字段。

FormulaField

名称	路径	类型	说明
id	id	integer	公式字段标识符。
标签	label	string	公式字段标签。
FieldType	fieldType	FieldType	生成的公式值类型。
公式	formula	string	公式文本。
decimalPrecision	decimalPrecision	integer	对于数值公式，数字精度。

FieldType

生成的公式值类型。

FieldType: string

getReportResponse

名称	路径	类型	说明
id	id	string	报表的标识符，表唯一。
姓名	name	string	报表的配置名称。
类型	type	string	Quickbase 中的报表类型（例如图表）。
描述	description	string	报表的配置说明。
所有者 ID	ownerId	integer	可选，仅针对个人报表显示。报表所有者的用户 ID。
Query	query	Query	在 Quickbase 中配置的查询定义，该定义在运行报表时执行。
属性	properties	object	特定于报表类型的属性的列表。若要查看每个报表类型的属性的详细说明，请参阅报表类型。
usedLast	usedLast	string	上次使用报表的时刻。
usedCount	usedCount	integer	使用报表的次数。

runReportResponse

名称	路径	类型	说明
fields	fields	array of Field	一个对象数组，其中包含报表中显示的每个字段的有限元数据。这有助于构建依赖于字段类型和 ID 的逻辑。
数据	data	array of object	表示记录数据或汇总值的对象数组，具体取决于报表类型。
items	data	object
Metadata1	metadata	Metadata1	有关可能有帮助的结果的其他信息。如果指定要跳过的结果数小于可用，或者 API 自动返回的结果更少，则可能需要分页。可以将 numRecords 与 totalRecord 进行比较，以确定是否需要进一步分页。

领域

名称	路径	类型	说明
id	id	integer	字段 ID。
标签	label	string	字段标签。
类型	type	string	字段类型。
labelOverride	labelOverride	string	报表中字段的列标题标签替代。

Metadata1

有关可能有帮助的结果的其他信息。如果指定要跳过的结果数小于可用，或者 API 自动返回的结果更少，则可能需要分页。可以将 numRecords 与 totalRecord 进行比较，以确定是否需要进一步分页。

名称	路径	类型	说明
跳过	skip	integer	要跳过的记录数
numFields	numFields	integer	当前响应对象中每个记录中的字段数
top	top	integer	如果存在，则调用方请求的最大记录数
totalRecords	totalRecords	integer	结果集中的记录总数
numRecords	numRecords	integer	当前响应对象中的记录数

Properties1

字段的其他属性。有关每个字段类型的属性的详细信息，请参阅 “字段类型详细信息 ”页。

名称	路径	类型	说明
comments	comments	string	管理员在字段属性上输入的注释。
doesTotal	doesTotal	boolean	此字段是否在产品内的报表中总计。
autoSave	autoSave	boolean	链接字段是否会自动保存。
defaultValueLuid	defaultValueLuid	integer	默认用户 ID 值。
maxVersions	maxVersions	integer	为文件附件配置的最大版本数。
carryChoices	carryChoices	boolean	复制字段时是否应携带其多重选择字段。
格式	format	integer	显示时间的格式。
最大长度 (maxLength)	maxLength	integer	此字段的 Quickbase 中允许输入的最大字符数。
linkText	linkText	string	已配置的文本值，用于替换用户在产品中看到的 URL。
parentFieldId	parentFieldId	integer	父复合字段的 ID（如果适用）。
displayTimezone	displayTimezone	boolean	指示是否在产品中显示时区。
summaryTargetFieldId	summaryTargetFieldId	integer	用于聚合子级值（如果适用）的字段的 ID。如果摘要函数不需要字段选择（如计数），则显示 0。
allowNewChoices	allowNewChoices	boolean	指示用户是否可以向选择列表添加新选项。
masterChoiceFieldId	masterChoiceFieldId	integer	关系中引用的字段的 ID。
defaultToday	defaultToday	boolean	指示当前是否为新记录默认字段值。
单位	units	string	单位标签。
lookupTargetFieldId	lookupTargetFieldId	integer	此查找的主表上的目标字段的 ID。
SummaryFunction	summaryFunction	SummaryFunction	摘要累积函数类型。
sourceFieldId	sourceFieldId	integer	源字段的 ID。
masterTableTag	masterTableTag	string	此字段所属关系中主表的表别名。
doesAverage	doesAverage	boolean	此字段是否在产品内的报表中平均值。
公式	formula	string	在 Quickbase 中配置的字段公式。
decimalPlaces	decimalPlaces	integer	此字段的产品中显示的小数位数。
seeVersions	seeVersions	boolean	指示用户是否可以查看产品中文件附件的最新版本。
displayMonth	displayMonth	string	如何显示月份。
numLines	numLines	integer	此文本字段的 Quickbase 中显示的行数。
displayEmail	displayEmail	string	如何显示电子邮件。
defaultKind	defaultKind	string	用户默认类型。
coverText	coverText	string	可用于在浏览器中显示链接的备用用户友好文本。
currencySymbol	currencySymbol	string	在产品中显示字段值时使用的当前符号。
masterChoiceTableId	masterChoiceTableId	integer	此关系中主控形状的表的 ID。
targetFieldId	targetFieldId	integer	目标字段的 ID。
displayUser	displayUser	string	用户如何在产品中显示配置的选项。
blankIsZero	blankIsZero	boolean	是否在产品中的计算中将空白值视为 0。
确切	exact	boolean	报表链接是否需要完全匹配。
startField	startField	integer	起始字段 ID。
defaultDomain	defaultDomain	string	默认电子邮件域。
defaultValue	defaultValue	string	添加新记录时为字段配置的默认值。
choicesLuid	choicesLuid	array of object	用户选项列表。
items	choicesLuid	object
缩写	abbreviate	boolean	显示 URL 时不要显示 URL 协议。
xmlTag	xmlTag	string	字段的 xml 标记。
targetTableName	targetTableName	string	字段的目标表名称。
numberFormat	numberFormat	integer	用于在产品中显示数值的格式（小数点、分隔符、数字组）。
appearsAs	appearsAs	string	链接文本（如果为空），URL 将用作链接文本。
width	width	integer	产品中字段的 html 输入宽度。
CurrencyFormat	currencyFormat	CurrencyFormat	在产品中显示字段值时使用的货币格式。
displayImages	displayImages	boolean	指示图像是否在产品中的窗体和报表上显示文件附件。
foreignKey	foreignKey	boolean	指示字段是否为关系中的外键（或引用字段）。
displayDayOfWeek	displayDayOfWeek	boolean	指示是否在产品中显示一周中的一天。
summaryReferenceFieldId	summaryReferenceFieldId	integer	此摘要关系中引用的字段的 ID。
commaStart	commaStart	integer	如果适用，在产品中显示逗号之前的位数。
choices	choices	array of string	为提供用户选项的字段存在的条目数组。
targetTableId	targetTableId	string	目标表的 ID。
displayRelative	displayRelative	boolean	是否将时间显示为相对时间。
compositeFields	compositeFields	array of object	构成复合字段（例如地址）的字段的数组。
items	compositeFields	object
VersionMode	versionMode	VersionMode	文件的版本模式。保留所有版本与保留最新版本。
displayTime	displayTime	boolean	指示是否显示时间，以及日期。
durationField	durationField	integer	持续时间字段 ID。
snapFieldId	snapFieldId	integer	用于从中获取值快照值的字段的 ID（如果适用）。
hours24	hours24	boolean	指示是否在产品中以 24 小时格式显示时间。
sortAlpha	sortAlpha	boolean	是否按字母顺序排序，默认排序按记录 ID。
sortAsGiven	sortAsGiven	boolean	指示列出的条目是否按字母顺序进行排序。
hasExtension	hasExtension	boolean	此字段是否具有电话扩展。
工作日	workWeek	integer	工作周类型。
useNewWindow	useNewWindow	boolean	指示当用户在产品中单击该 URL 时是否应打开一个新窗口。
appendOnly	appendOnly	boolean	此字段是否仅追加。
displayAsLink	displayAsLink	boolean	指示是否应将属于关系的字段显示为指向产品中父记录的超链接。
allowHTML	allowHTML	boolean	此字段是否允许 html。
lookupReferenceFieldId	lookupReferenceFieldId	integer	此查找关系中引用的字段的 ID。

SummaryFunction

摘要累积函数类型。

SummaryFunction: string

CurrencyFormat

在产品中显示字段值时使用的货币格式。

CurrencyFormat: string

VersionMode

文件的版本模式。保留所有版本与保留最新版本。

VersionMode: string

许可

名称	路径	类型	说明
角色	role	string	与字段的给定权限关联的角色
permissionType	permissionType	string	为此字段的角色授予的权限
roleId	roleId	integer	给定角色的 ID

createFieldResponse

名称	路径	类型	说明
id	id	integer	此表唯一的字段 ID。
fieldType	fieldType	string	字段的类型，如下所述。
mode	mode	string	对于派生字段，此值为“lookup”、“summary”或“formula”，以指示派生字段的类型。对于非派生字段，此字段将为空。
标签	label	string	字段的标签（名称）。
noWrap	noWrap	boolean	指示字段是否配置为在产品中显示时不换行。
bold	bold	boolean	指示字段是否配置为在产品中以粗体显示。
required	required	boolean	指示字段是否标记为必需。
appearsByDefault	appearsByDefault	boolean	指示字段是否在报表中标记为默认值。
findEnabled	findEnabled	boolean	指示字段是否标记为可搜索。
独特	unique	boolean	指示字段是否标记为唯一。
doesDataCopy	doesDataCopy	boolean	指示用户复制记录时字段数据是否会复制。
fieldHelp	fieldHelp	string	为产品中的用户显示的已配置的帮助文本。
审计	audited	boolean	指示是否在快速数据库审核日志中跟踪该字段。
Properties1	properties	Properties1	字段的其他属性。有关每个字段类型的属性的详细信息，请参阅 “字段类型详细信息 ”页。
权限	permissions	array of Permission	不同角色的字段权限。

deleteFieldsResponse

名称	路径	类型	说明
deletedFieldIds	deletedFieldIds	array of integer	要删除的字段 ID 的列表。
错误	errors	array of string	找到的错误列表。

getFieldResponse

名称	路径	类型	说明
id	id	integer	此表唯一的字段 ID。
fieldType	fieldType	string	字段的类型，如下所述。
mode	mode	string	对于派生字段，此值为“lookup”、“summary”或“formula”，以指示派生字段的类型。对于非派生字段，此字段将为空。
标签	label	string	字段的标签（名称）。
noWrap	noWrap	boolean	指示字段是否配置为在产品中显示时不换行。
bold	bold	boolean	指示字段是否配置为在产品中以粗体显示。
required	required	boolean	指示字段是否标记为必需。
appearsByDefault	appearsByDefault	boolean	指示字段是否在报表中标记为默认值。
findEnabled	findEnabled	boolean	指示字段是否标记为可搜索。
独特	unique	boolean	指示字段是否标记为唯一。
doesDataCopy	doesDataCopy	boolean	指示用户复制记录时字段数据是否会复制。
fieldHelp	fieldHelp	string	为产品中的用户显示的已配置的帮助文本。
审计	audited	boolean	指示是否在快速数据库审核日志中跟踪该字段。
Properties1	properties	Properties1	字段的其他属性。有关每个字段类型的属性的详细信息，请参阅 “字段类型详细信息 ”页。
权限	permissions	array of Permission	不同角色的字段权限。

updateFieldResponse

名称	路径	类型	说明
id	id	integer	此表唯一的字段 ID。
fieldType	fieldType	string	字段的类型，如下所述。
mode	mode	string	对于派生字段，此值为“lookup”、“summary”或“formula”，以指示派生字段的类型。对于非派生字段，此字段将为空。
标签	label	string	字段的标签（名称）。
noWrap	noWrap	boolean	指示字段是否配置为在产品中显示时不换行。
bold	bold	boolean	指示字段是否配置为在产品中以粗体显示。
required	required	boolean	指示字段是否标记为必需。
appearsByDefault	appearsByDefault	boolean	指示字段是否在报表中标记为默认值。
findEnabled	findEnabled	boolean	指示字段是否标记为可搜索。
独特	unique	boolean	指示字段是否标记为唯一。
doesDataCopy	doesDataCopy	boolean	指示用户复制记录时字段数据是否会复制。
fieldHelp	fieldHelp	string	为产品中的用户显示的已配置的帮助文本。
审计	audited	boolean	指示是否在快速数据库审核日志中跟踪该字段。
Properties1	properties	Properties1	字段的其他属性。有关每个字段类型的属性的详细信息，请参阅 “字段类型详细信息 ”页。
权限	permissions	array of Permission	不同角色的字段权限。

runFormulaResponse

名称	路径	类型	说明
结果	result	string	公式执行结果。

upsertResponse

名称	路径	类型	说明
Metadata2	metadata	Metadata2	有关已创建的记录、更新的记录、引用但未更改的记录以及正在处理时出现任何错误的记录的信息。
数据	data	array of object	应返回的数据。
items	data	object

Metadata2

有关已创建的记录、更新的记录、引用但未更改的记录以及正在处理时出现任何错误的记录的信息。

名称	路径	类型	说明
createdRecordIds	createdRecordIds	array of integer	包含已创建的记录 ID 的数组。
lineErrors	lineErrors	object	仅当记录失败时，才会返回此值。它是处理导致记录未处理的传入数据时发生的错误的集合。每个对象都有一个键，表示原始有效负载中记录的序列号（从 1 开始）。该值是发生错误的列表。
unchangedRecordIds	unchangedRecordIds	array of integer	包含未更改记录 ID 的数组。
updatedRecordIds	updatedRecordIds	array of integer	包含更新的记录 ID 的数组。
totalNumberOfRecordsProcessed	totalNumberOfRecordsProcessed	integer	处理的记录数。包括成功和失败的记录更新。

deleteRecordsResponse

名称	路径	类型	说明
numberDeleted	numberDeleted	integer	已删除的记录数。

runQueryResponse

名称	路径	类型	说明
fields	fields	array of Fields2	一个对象数组，其中包含报表中显示的每个字段的有限元数据。这有助于构建依赖于字段类型和 ID 的逻辑。
数据	data	array of object	表示记录数据或汇总值的对象数组，具体取决于报表类型。
items	data	object
Metadata1	metadata	Metadata1	有关可能有帮助的结果的其他信息。如果指定要跳过的结果数小于可用，或者 API 自动返回的结果更少，则可能需要分页。可以将 numRecords 与 totalRecord 进行比较，以确定是否需要进一步分页。

Fields2

名称	路径	类型	说明
id	id	integer	字段 ID。
标签	label	string	字段标签。
类型	type	string	字段类型。

getTempTokenDBIDResponse

名称	路径	类型	说明
temporaryAuthorization	temporaryAuthorization	string	临时授权令牌。

cloneUserTokenResponse

名称	路径	类型	说明
活跃	active	boolean	用户令牌是否处于活动状态。
apps	apps	array of App	此用户令牌分配到的应用列表。
lastUsed	lastUsed	string	使用此用户令牌的最后一个日期，采用 ISO 8601 时间格式 YYYY-MM-DDThh：mm：ss.sssZ（UTC 时区）。
描述	description	string	用户令牌说明。
id	id	integer	用户令牌 ID。
姓名	name	string	用户令牌名称。
代币	token	string	用户令牌值。

应用程序

名称	路径	类型	说明
id	id	string	此应用程序的唯一标识符。
姓名	name	string	应用程序的名称。

deleteUserTokenResponse

名称	路径	类型	说明
id	id	integer	用户令牌 ID。

deleteFileResponse

名称	路径	类型	说明
versionNumber	versionNumber	integer	已删除的版本数。
fileName	fileName	string	与已删除的版本关联的文件的名称。
上传	uploaded	string	最初上传版本时的时间戳。
Creator	creator	Creator	上传版本的用户。

Creator

上传版本的用户。

名称	路径	类型	说明
姓名	name	string	用户全名。
id	id	string	用户 ID。
电子邮件	email	string	用户电子邮件。
用户名	userName	string	用户属性中更新的用户名。可选，如果与用户电子邮件不同，则显示。

字符串

这是基本数据类型“string”。