莫塔（预览版）

Morta API 基于 REST。我们的 API 接受 json 编码的请求正文，并返回 JSON 编码的响应。我们使用标准 HTTP 响应、身份验证和谓词。所有 API 请求都必须具有表单的授权标头：{ 'Authorization'： 'Bearer <API_KEY>' }

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

服务	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	Mort 支持
URL	https://morta.io
Email	support@morta.io

连接器元数据
发布者	Morta
网站	https://morta.io
隐私策略	https://morta.io/termsofservice
类别	生产力;内容和文件

Morta 提供了一种基于云的解决方案，它与你习惯的软件深度集成，使你能够有效地数字化、连接和自动化跟踪过程。 Morta 连接器允许通过 Microsoft Power Automate 平台与所有 Morta 功能进行交互。

先决条件

若要使用此连接器，需要一个 Morta 帐户

如何获取凭据

登录到 Morta 帐户，导航到 Morta 集成，只需添加新的 API 密钥。然后，可以在 power Automate Microsoft使用此 API 密钥。在 Microsoft Power Automate Platform 上输入 API 密钥时，请确保前面添加“Bearer”，以便输入的 API 密钥如下所示：“Bearer YOUR_API_KEY_HERE”

连接器入门

若要开始使用连接器，可以从 Morta 平台拉取你最喜欢的项目/工作区开始。为此，可以使用“GetFavouriteProjects”作。

通过此作，可以使用“CreateProcess”作和以下参数在 Morta 上创建进程/文档：

名称：新建进程
项目 ID： <one_of_your_project_public_ids>
类型：自定义

已知问题和限制

None

常见错误和补救措施

使用 Morta 连接器时，用户可能会遇到以下 HTTP 状态代码之一：

401：请求作未获授权。这可能是因为你没有输入 API 密钥，或者输入 API 密钥不正确（例如，不要在复制的 API 密钥之前添加“Bearer” ）
403：你无权访问请求的 Morta 资源。请确保从该资源的所有者请求对所请求资源的权限。
404：Morta 资源不存在。请登录到 Morta 平台，确保已正确输入 ID。
422：请求中数据缺失或格式不正确。请确保已阅读请求中所需的所有数据的说明，并遵循规范。例如，可能需要输入数字作为字段，但已改为输入字符串。
429：在一段时间内已向莫塔发送了太多请求。确保每秒向 Morta 平台发送的请求数不超过 10 个。

FAQ

问：为什么我的 Morta API 密钥不起作用？答：确保已将“Bearer”添加到 API 密钥开头（单词“Bearer”和空格）。正在输入的最终 API 密钥应如下所示（此处正在使用虚拟 API 密钥）：“Bearer zSujSa_eXxd3b1yVtTQVMw7Ghn18Ja9sOWvj-O4C908”

正在创建连接

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


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

违约

适用：所有区域

用于创建连接的参数。

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

Name	类型	Description	必选
API 密钥	securestring	MotaWord 连接的 API 密钥	True

限制

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

操作

Check Process Table is Used In	检查并返回进程列表、表联接，并选择使用指定表的位置。
“重复进程”部分	复制特定进程部分。
“重复进程”部分	异步复制特定进程节。
下载图表图像	根据特定表视图中的数据下载图表的图像文件。
为用户创建 API 密钥	为当前登录的用户创建 API 密钥
为表创建新视图	为特定表创建新视图。
为资源创建权限	为特定资源（例如表、表视图或进程）创建权限。
为项目重新发送对用户的邀请	为项目重新发送对用户的邀请。这适用于以前受邀的新用户和现有用户。需要所有者或管理员权限。
从用户中删除标记	从特定用户中删除标记
从表中删除所有行	从指定表中删除所有行。
从表中删除集成	从表中删除特定集成。
从项目中删除用户	从特定项目中删除用户，由项目的 UUID 和用户的 Firebase ID 标识
以 csv 文件的形式下载查看数据	下载 CSV 格式的特定表视图的数据。
切换项目的固定状态	更改是否为当前登录的用户固定项目
切换项目的最爱状态	更改项目是否是当前登录用户的热门项目
创建多个新进程部分	在指定的进程中创建多个新节，每个节都有一个可选的父节
创建新批注	在特定批注线程中创建新批注
创建新文档表	在项目中创建新文档表。
创建新流程	在指定项目中创建新进程
创建新流程部分	在指定进程中创建新节，其中包含设置父节的选项
创建新流程部分	在进程中创建多个新节
创建新用户	创建新用户
创建新的批注线程	创建新的批注线程
创建新的进程响应	为进程部分创建新响应。
创建新的项目机密	为指定项目创建新机密
创建新的项目标题样式	为特定项目创建新标题样式
创建新通知	为特定项目创建新通知。
创建新项目	使用指定名称创建新项目
创建源系统的直通请求	对外部源系统进行传递 API 调用。
创建直通下载请求	对外部源系统进行传递 API 调用，以便下载文件。
创建表列	向现有表添加新列。
创建表联接	在两个表之间创建联接。
删除 API 密钥	删除当前登录用户的 API 密钥
删除单个通知	按 ID 删除特定通知。
删除批注	删除批注线程中的特定注释
删除注释线程	删除注释线程
删除特定行	根据行 ID 从表视图中删除特定行。
删除表	按其 UUID 删除指定的表。
删除表列	从表中删除特定列。
删除表的视图	删除表的特定视图。
删除表联接	从表中删除联接。
删除表行	从表中删除所有行或特定行。
删除资源的权限	删除特定资源的权限（例如表、表视图或进程）。
删除进程	删除由其 UUID 标识的进程
删除进程响应	删除特定的进程响应。
删除进程部分	删除特定进程部分。
删除顶部项目标题样式	删除特定项目的顶部标题样式
删除项目	删除由其 UUID 标识的特定项目
删除项目机密	从项目中删除特定机密
删除项目邀请	删除对项目的邀请
向表末尾添加行	在指定表视图的末尾插入新行。
向表添加行	向指定表添加新行。
向视图添加列	向特定表视图添加新列。
在中使用检查视图列	检索使用特定表列的所有视图。
在表中添加或更新行	基于指定列的表视图中的 Upsert （添加或更新）行。
在表列上创建索引	针对表的一个或多个列创建索引以提高查询性能。
在项目中搜索	在特定项目中执行搜索作，由其 UUID 标识
在项目中更改用户的角色	更改特定项目中用户的角色，由项目的 UUID 和用户的 Firebase ID 标识
复制表	创建现有表及其数据、设置和可选链接表的副本。
复制表的视图	为特定表创建现有视图的副本。
复制表的默认视图	为特定表创建默认视图的副本。
复制进程	复制现有进程（可能位于其他项目中）
复制项目	创建现有项目的副本
导出过程	通过将特定进程 UUID 导出为不同的格式（PDF 或 DOCX）
将标记添加到用户	向特定用户添加标记
将表与集成同步	将表与指定的集成同步。
将表数据下载为 CSV	将指定表的数据下载为 CSV 文件。
将视图设置为默认视图	将特定表视图指定为表的默认视图。
按公共 ID 获取标记	按其公共 ID 检索标记。
按公共 ID 获取用户详细信息	按其公共 ID 获取有关特定用户的信息
按引用获取注释线程	检索与特定引用关联的所有注释线程
提交进程响应	提交进程响应，将其标记为已完成。
提交进程响应草稿	提交流程响应草稿，供以后完成。
搜索用户	按项目或流程搜索用户
更新 API 密钥	更新当前登录用户的 API 密钥
更新单个通知	按 ID 更新特定通知。
更新多个进程部分	更新多个现有进程部分。
更新当前用户配置文件	更新当前登录用户的配置文件
更新注释	更新批注线程中的特定注释
更新现有行	更新指定表视图中的现有行。
更新现有表	更新现有表的属性。
更新现有表单元格	更新表格视图中的特定单元格。
更新现有进程	按进程 ID 更新现有进程的详细信息
更新现有进程响应	更新进程节的现有响应。
更新现有进程部分	按进程节 ID 更新现有进程节的详细信息
更新现有项目	按项目 ID 更新现有项目的详细信息
更新用户帐户	更新当前登录用户的帐户详细信息
更新表中的现有行	更新指定表中的现有行。
更新表列	更新表中特定列的属性。
更新表格单元格	更新表中的特定单元格。
更新表的视图	更新特定表的现有视图。
更新表联接	更新表上的现有联接。
更新视图上的列	更新表视图中的特定列。
更新资源的权限	更新特定资源的权限（例如表、表视图或进程）。
更新进程响应程序	更新由其 UUID 标识的给定进程的响应程序列表
更新进程节顺序	更新进程中的进程节的顺序。
更新项目机密	更新项目中的特定机密
更新项目标题样式	更新特定项目的标题样式
更新项目邀请	更新项目中的现有邀请
检索项目中已删除的进程	获取与特定项目关联的所有已删除进程，由其 UUID 标识
检索项目中的进程	获取与特定项目关联的所有进程，由其 UUID 标识
流式传输表的所有行	流式传输特定表的所有行的数据。
流式传输视图的所有行	流式传输特定表视图的所有行的数据。
获取列的唯一值	检索表视图中特定列的唯一/非重复值。
获取列的唯一值	检索表中指定列的非重复值列表。
获取受邀项目成员	检索指定项目的所有受邀成员
获取实际表视图数据	检索特定表视图的实际数据。
获取已删除的进程部分	检索特定进程的所有已删除部分，其中包含特定进程节的可选筛选器
获取所有受支持的事件类型的列表	检索通知支持的所有事件类型的列表。
获取所有表联接	检索与表关联的所有联接。
获取注释线程	按其 ID 检索特定注释线程
获取注释线程统计信息	根据引用类型和主引用 ID 检索注释线程的统计信息
获取特定用户详细信息	获取有关特定用户的信息
获取用户成就	按用户的 Firebase ID 获取用户的成就徽章
获取用户拥有和管理的项目	获取用户是所有者或管理员的所有项目
获取用户最喜欢的项目	获取当前登录用户所属的所有热门项目
获取用户模板	获取当前登录用户有权访问的所有模板
获取用户的公共贡献	获取由用户的 Firebase ID 标识的公共贡献
获取用户的公共项目	获取用户所属的所有公共项目
获取用户的固定项目	获取由其 Firebase ID 标识的用户固定的项目
获取用户贡献	获取由用户的 Firebase ID 标识的每日贡献数
获取用户项目	获取当前登录用户所属的所有项目
获取表列	检索特定表的所有活动列。
获取表列的统计信息	检索特定表视图中列的统计数据。
获取表列统计信息	根据指定的参数检索表列的统计信息。
获取表单元格的文件	检索与表中特定单元格关联的文件。
获取表及其行	根据提供的参数检索表及其行
获取表的单个视图	按表的 ID 检索特定视图。
获取表的所有视图	检索与特定表关联的所有视图。
获取表行	根据提供的查询参数从表中检索行。
获取视图的图表数据	检索基于特定表视图生成图表的数据。
获取详细信息	获取有关当前用户的信息
获取资源权限	检索指定资源的权限，例如表、表视图或进程。
获取资源的所有事件	检索与特定资源关联的所有事件，按各种条件进行筛选。
获取进程详细信息	按其 UUID 检索特定进程的详细信息
获取进程部分	检索特定进程部分。
获取项目中已删除的表	从由其 UUID 标识的特定项目中检索所有已删除的表。只能由项目所有者访问。
获取项目信息	检索其 UUID 标识的特定项目的详细信息
获取项目变量	检索与指定项目关联的所有变量
获取项目成员	检索与指定项目关联的所有成员
获取项目机密	检索指定项目的所有机密
获取项目标记	检索与指定项目关联的所有标记
获取项目的已发送通知	检索指定项目的所有已发送通知
获取项目的通知	检索与特定项目关联的所有通知。只有拥有项目所有者级权限的用户才能访问此终结点。
获取项目表	检索与特定项目关联的表，由其 UUID 标识
获取项目资源	检索与其 UUID 标识的特定项目关联的资源
表中的 Upsert 行	根据唯一的列值添加或更新指定表中的行。
解析注释线程	解析注释线程
请求资源权限	请求特定资源（例如表、表视图或进程）的权限。
还原已删除的表	使用其 UUID 还原以前删除的表。
还原表列	还原表中以前删除的列。
还原过程	还原由其 UUID 标识的已删除进程
还原过程部分	还原以前删除的进程部分。
还原进程响应	还原以前删除的进程响应。
还原项目	还原之前已删除的特定项目（由其 UUID 标识）
邀请多个用户加入项目	通过电子邮件邀请多个用户加入项目。如果用户已存在，则直接添加用户，否则将发送邀请。需要所有者或管理员权限。
邀请用户加入项目	邀请单个用户通过电子邮件加入项目。如果用户已存在，则直接添加用户;否则，将发送邀请。需要所有者或管理员权限。
重复进程	将现有进程（可选）复制到其他项目中
重新打开批注线程	重新打开以前解析的注释线程
重置进程响应	将现有进程响应重置为其初始状态。
预览输入生成的行	预览特定表视图中给定输入生成的行。

Check Process Table is Used In

操作 ID:: GetWhereTableUsed

检查并返回进程列表、表联接，并选择使用指定表的位置。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	用于检查使用情况的表的 UUID

名称	路径	类型	说明
数据	data	array of object
链接	data.link	string	直接链接到进程，加入或选择
姓名	data.name	string	进程的名称、联接或选择使用表的位置
类型	data.type	string	用法类型（process、sourceJoin、targetJoin、sourceSelect 等）
元数据	metadata	object

“重复进程”部分

操作 ID:: DuplicateProcessSection

复制特定进程部分。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	要复制的进程部分的 UUID。

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

“重复进程”部分

操作 ID:: DuplicateProcessSectionAsync

异步复制特定进程节。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	要复制的进程部分的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

下载图表图像

操作 ID:: DownloadTableViewChartImage

根据特定表视图中的数据下载图表的图像文件。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	为其生成图表图像的表视图的 UUID。
图表类型	chart_type		string	要为其生成图像的图表的类型。
显示图例	show_legend		boolean	用于指示是否在图表图像中包含图例的标志。
显示值	show_values		boolean	用于指示是否在图表图像中包含值的标志。
列值 ID	column_value_id		uuid	用作图表图像的值源的列的 UUID。
列标签 ID	column_label_id		uuid	用作图表图像的标签源的列的 UUID。

response: binary

为用户创建 API 密钥

操作 ID:: CreateApiKey

为当前登录的用户创建 API 密钥

参数

名称	密钥	必需	类型	说明
姓名	name		string

名称	路径	类型	说明
数据	data	ApiKey
元数据	metadata	object

为表创建新视图

操作 ID:: CreateTableView

为特定表创建新视图。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其创建视图的表的 UUID。
allowContributorDelete	allowContributorDelete		boolean
chartSettings	chartSettings
collapsedGroupView	collapsedGroupView		boolean
backgroundColour	backgroundColour	True	string
columnId	columnId		uuid
columnName	columnName	True	string
filterType （过滤器类型）	filterType	True	string
fontColour	fontColour	True	string
multipleValues	multipleValues		array of
value	value
columnId	columnId		uuid
columnName	columnName	True	string
描述	description
locked	locked		boolean
required	required		boolean
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
disableNewRow	disableNewRow		boolean
displayCommentRows	displayCommentRows		integer
displayValidationErrorRows	displayValidationErrorRows		integer
columnId	columnId		uuid
columnName	columnName	True	string
filterType （过滤器类型）	filterType	True	string
multipleValues	multipleValues		array of
orGroup	orGroup		string
value	value
frozenIndex	frozenIndex		integer
columnId	columnId		uuid
columnName	columnName	True	string
方向	direction	True	string
includeAllColumns	includeAllColumns		boolean
isDefault	isDefault		boolean
姓名	name	True	string
rowHeight	rowHeight		integer
columnId	columnId		uuid
columnName	columnName	True	string
方向	direction	True	string
类型	type		integer
unpackMultiselectGroupView	unpackMultiselectGroupView		boolean

名称	路径	类型	说明
数据	data	TableView
元数据	metadata	object

为资源创建权限

操作 ID:: CreateResourcePermissions

为特定资源（例如表、表视图或进程）创建权限。

参数

名称	密钥	必需	类型
attributeId	attributeId		uuid
attributeKind	attributeKind	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
resourceId	resourceId	True	uuid
resourceKind	resourceKind	True	string
角色	role	True	integer
tagReferenceId	tagReferenceId		string

名称	路径	类型	说明
数据	data	AccessPolicy
元数据	metadata	object

为项目重新发送对用户的邀请

操作 ID:: ResendInviteToUserForProject

为项目重新发送对用户的邀请。这适用于以前受邀的新用户和现有用户。需要所有者或管理员权限。

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	正在重新发送邀请的项目的 UUID
邀请 ID	invite_id	True	uuid	要重新发送的邀请的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

从用户中删除标记

操作 ID:: UserDeleteTag

从特定用户中删除标记

参数

名称	密钥	必需	类型	说明
用户 ID	user_id	True	uuid	要从中删除标记的用户的公共 UUID
标记 ID	tag_id	True	uuid	要删除的标记的公共 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

从表中删除所有行

操作 ID:: TruncateTable

从指定表中删除所有行。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要从中删除所有行的表的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

从表中删除集成

操作 ID:: DeleteIntegrationFromTable

从表中删除特定集成。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	将从中删除集成的表的 UUID。
集成名称	integration_name	True	string	要删除的集成的名称。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

从项目中删除用户

操作 ID:: RemoveUserFromProject

从特定项目中删除用户，由项目的 UUID 和用户的 Firebase ID 标识

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	项目的 UUID
Firebase Id	firebase_id	True	string	要删除的用户的 Firebase ID

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

以 csv 文件的形式下载查看数据

操作 ID:: DownloadTableViewCSV

下载 CSV 格式的特定表视图的数据。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要下载为 CSV 的表视图的 UUID。
过滤器	filter		string	要应用于 CSV 数据的筛选器。
排序	sort		string	对 CSV 数据的参数进行排序。
进程 ID	process_id		uuid	用于筛选数据的进程的可选 UUID。

response: binary

切换项目的固定状态

操作 ID:: ChangeUserPin

更改是否为当前登录的用户固定项目

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要切换固定状态的项目的公共 ID

名称	路径	类型	说明
数据	data	array of object
贡献	data.contributors	integer	项目的参与者数
姓名	data.name	string	项目的名称
primaryColour	data.primaryColour	string	项目的主要颜色
publicId	data.publicId	uuid	项目的公共 ID
views	data.views	integer	项目的视图数
元数据	metadata	object	其他元数据

切换项目的最爱状态

操作 ID:: ChangeUserFavourite

更改项目是否是当前登录用户的热门项目

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	项目的公共 ID，用于切换最喜欢的状态

名称	路径	类型	说明
数据	data	array of object
isDeleted	data.isDeleted	boolean	指示是否删除项目
姓名	data.name	string	项目的名称
projectRole	data.projectRole	string	项目中的用户角色
publicId	data.publicId	uuid	项目的公共 ID
元数据	metadata	object	其他元数据

创建多个新进程部分

操作 ID:: CreateMultipleProcessSections

在指定的进程中创建多个新节，每个节都有一个可选的父节

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	将在其中创建新分区的过程的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
姓名	name	True	string
parentId	parentId		uuid
plaintextDescription	plaintextDescription		string

名称	路径	类型	说明
数据	data	string
resourceIds	metadata.resourceIds	array of string	新创建的进程部分的 UUID 列表

创建新批注

操作 ID:: CreateComment

在特定批注线程中创建新批注

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	要向其添加批注的注释线程的 UUID
commentText	commentText	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

名称	路径	类型	说明
数据	data	Comment
change	metadata.change	object	此作中所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	新创建的注释的 UUID

创建新文档表

操作 ID:: CreateTable

在项目中创建新文档表。

参数

名称	密钥	必需	类型
aconexSynced	aconexSynced		integer
聚合	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
日期格式	dateFormat		string
decimalPlaces	decimalPlaces		integer
描述	description
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
mortaSynced	mortaSynced		integer
姓名	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
reviztoIssuesSynced	reviztoIssuesSynced		integer
脚本	script		string
scriptEnabled	scriptEnabled		boolean
thousandSeparator	thousandSeparator		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinTableName	joinTableName		string
joinViewId	joinViewId		string
joinViewName	joinViewName		string
姓名	name	True	string
projectId	projectId	True	uuid
类型	type		string

名称	路径	类型	说明
数据	data	Table
元数据	metadata	object

创建新流程

操作 ID:: CreateProcess

在指定项目中创建新进程

参数

名称	密钥	必需	类型
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
姓名	name	True	string
projectId	projectId	True	uuid
类型	type	True	string

名称	路径	类型	说明
数据	data	Process
change	metadata.change	object	在创建过程中所做的更改
事件	metadata.event	string	事件类型，例如“process.created”
resourceId	metadata.resourceId	uuid	新创建的进程的 UUID

创建新流程部分

操作 ID:: CreateProcessSection

在指定进程中创建新节，其中包含设置父节的选项

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要在其中创建新节的过程的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
姓名	name	True	string
parentId	parentId		uuid
plaintextDescription	plaintextDescription		string

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

创建新流程部分

操作 ID:: CreateProcessSections

在进程中创建多个新节

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	将在其中创建新分区的过程的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
姓名	name	True	string
parentId	parentId		uuid
plaintextDescription	plaintextDescription		string

名称	路径	类型	说明
数据	data	array of MortaProcessSection
元数据	metadata	object

创建新用户

操作 ID:: CreateUser

创建新用户

参数

名称	密钥	必需	类型
电子邮件	email	True	email
姓名	name	True	string
密码	password	True	string
projectId	projectId		uuid

名称	路径	类型	说明
数据	data	User
元数据	metadata	object

创建新的批注线程

操作 ID:: CreateCommentThread

创建新的批注线程

参数

名称	密钥	必需	类型
commentText	commentText	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
mainReferenceId	mainReferenceId		uuid
referenceId	referenceId	True	uuid
referenceType	referenceType	True	string

名称	路径	类型	说明
数据	data	CommentThread
change	metadata.change	object	此作中所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	新创建的注释线程的 UUID

创建新的进程响应

操作 ID:: CreateProcessResponse

为进程部分创建新响应。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
类型	type		string

名称	路径	类型	说明
数据	data	ProcessResponse
元数据	metadata	object

创建新的项目机密

操作 ID:: CreateProjectSecret

为指定项目创建新机密

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	将在其中创建机密的项目的 UUID
姓名	name	True	string
value	value	True	string

名称	路径	类型	说明
数据	data	ProjectSecret
元数据	metadata	object

创建新的项目标题样式

操作 ID:: CreateProjectHeadingStyling

为特定项目创建新标题样式

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其创建标题样式的项目的 UUID

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

创建新通知

操作 ID:: CreateNotification

为特定项目创建新通知。

参数

名称	密钥	必需	类型
描述	description	True	string
processes	processes		array of uuid
projectId	projectId	True	uuid
tables	tables		array of uuid
资源	resource	True	string
谓词	verb	True	string
webhookUrl	webhookUrl	True	string

名称	路径	类型	说明
数据	data	Notification
元数据	metadata	object

创建新项目

操作 ID:: CreateProject

使用指定名称创建新项目

参数

名称	密钥	必需	类型	说明
姓名	name	True	string

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

创建源系统的直通请求

操作 ID:: IntegrationsPassthroughApiCall

对外部源系统进行传递 API 调用。

参数

名称	密钥	必需	类型
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
数据	data
标题	headers
方法	method	True	string
onBehalfUserId	onBehalfUserId		uuid
路径	path	True	string
sourceSystem	sourceSystem	True	string

名称	路径	类型	说明
数据	data	IntegrationsPassthroughResponse
元数据	metadata	object

创建直通下载请求

操作 ID:: IntegrationsPassthroughDownloadApiCall

对外部源系统进行传递 API 调用，以便下载文件。

参数

名称	密钥	必需	类型
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
数据	data
标题	headers
方法	method	True	string
onBehalfUserId	onBehalfUserId		uuid
路径	path	True	string
sourceSystem	sourceSystem	True	string

response: binary

创建表列

操作 ID:: CreateTableColumn

向现有表添加新列。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要向其添加列的表的 UUID
aconexSynced	aconexSynced		integer
聚合	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
日期格式	dateFormat		string
decimalPlaces	decimalPlaces		integer
描述	description
isIndexed	isIndexed		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
mortaSynced	mortaSynced		integer
姓名	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
reviztoIssuesSynced	reviztoIssuesSynced		integer
脚本	script		string
scriptEnabled	scriptEnabled		boolean
thousandSeparator	thousandSeparator		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

名称	路径	类型	说明
数据	data	TableColumn
元数据	metadata	object

创建表联接

操作 ID:: CreateTableJoin

在两个表之间创建联接。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要创建联接的表的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dataColumns	dataColumns		array of string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinViewId	joinViewId		string

名称	路径	类型	说明
数据	data	Table
元数据	metadata	object

删除 API 密钥

操作 ID:: DeleteApiKey

删除当前登录用户的 API 密钥

参数

名称	密钥	必需	类型	说明
API 密钥 ID	api_key_id	True	uuid	要删除的 API 密钥的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object	其他元数据

删除单个通知

操作 ID:: DeleteNotification

按 ID 删除特定通知。

参数

名称	密钥	必需	类型	说明
Id	id	True	uuid	要删除的通知的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除批注

操作 ID:: DeleteComment

删除批注线程中的特定注释

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	包含注释的注释线程的 UUID
注释 ID	comment_id	True	uuid	要删除的注释的 UUID

名称	路径	类型	说明
数据	data	Comment
change	metadata.change	object	对批注所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	已删除注释的 UUID

删除注释线程

操作 ID:: DeleteCommentThread

删除注释线程

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	要删除的注释线程的 UUID

名称	路径	类型	说明
数据	data	CommentThread
change	metadata.change	object	对批注线程所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	已删除的注释线程的 UUID

删除特定行

操作 ID:: DeleteTableRowsInView

根据行 ID 从表视图中删除特定行。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要从中删除行的表视图的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除表

操作 ID:: DeleteTable

按其 UUID 删除指定的表。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要删除的表的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除表列

操作 ID:: DeleteTableColumn

从表中删除特定列。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含列的表的 UUID
列 ID	column_id	True	uuid	要删除的列的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除表的视图

操作 ID:: DeleteTableView

删除表的特定视图。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要删除的表视图的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除表联接

操作 ID:: DeleteTableJoin

从表中删除联接。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	将从中删除联接的表的 UUID。
联接 ID	join_id	True	uuid	要删除的联接的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除表行

操作 ID:: DeleteTableRows

从表中删除所有行或特定行。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要从中删除行的表的 UUID。

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除资源的权限

操作 ID:: DeleteResourcePermissions

删除特定资源的权限（例如表、表视图或进程）。

参数

名称	密钥	必需	类型	说明
Id	id	True	uuid	要删除的策略的 UUID。

删除进程

操作 ID:: DeleteProcess

删除由其 UUID 标识的进程

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要删除的进程 UUID

名称	路径	类型	说明
数据	data	MortaProcess
元数据	metadata	object

删除进程响应

操作 ID:: DeleteProcessResponse

删除特定的进程响应。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
进程响应 ID	process_response_id	True	uuid	要删除的进程响应的 UUID。

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

删除进程部分

操作 ID:: DeleteProcessSection

删除特定进程部分。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	要删除的进程部分的 UUID。

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

删除顶部项目标题样式

操作 ID:: DeleteTopProjectHeadingStyling

删除特定项目的顶部标题样式

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其删除顶部标题样式的项目的 UUID

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

删除项目

操作 ID:: DeleteProject

删除由其 UUID 标识的特定项目

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要删除的项目的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除项目机密

操作 ID:: DeleteProjectSecret

从项目中删除特定机密

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	将从中删除机密的项目的 UUID
机密 ID	secret_id	True	uuid	要删除的机密的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

删除项目邀请

操作 ID:: DeleteProjectInvite

删除对项目的邀请

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要从中删除邀请的项目的 UUID
邀请 ID	invite_id	True	uuid	要删除的邀请的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

向表末尾添加行

操作 ID:: InsertTableRowsInView

在指定表视图的末尾插入新行。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要在其中添加行的表视图的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

向表添加行

操作 ID:: CreateTableRows

向指定表添加新行。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要向其添加行的表的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

向视图添加列

操作 ID:: AddColumnToTableView

向特定表视图添加新列。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要向其添加列的表视图的 UUID。
aconexSynced	aconexSynced		integer
聚合	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
日期格式	dateFormat		string
decimalPlaces	decimalPlaces		integer
描述	description
hardValidation	hardValidation		boolean
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
locked	locked	True	boolean
mortaSynced	mortaSynced		integer
姓名	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
required	required	True	boolean
reviztoIssuesSynced	reviztoIssuesSynced		integer
脚本	script		string
scriptEnabled	scriptEnabled		boolean
sortOrder	sortOrder	True	number
stringValidation	stringValidation		string
thousandSeparator	thousandSeparator		boolean
validationMessage	validationMessage		string
validationNoBlanks	validationNoBlanks		boolean
validationNoDuplicates	validationNoDuplicates		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

名称	路径	类型	说明
数据	data	TableViewColumn
元数据	metadata	object

在 <a0/a0> 中使用检查视图列

操作 ID:: CheckColumnInViews

检索使用特定表列的所有视图。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含列的表的 UUID
列 ID	column_id	True	uuid	用于签入视图的列的 UUID

名称	路径	类型	说明
数据	data	array of TableView
元数据	metadata	object

在表中添加或更新行

操作 ID:: UpsertTableRowsInView

基于指定列的表视图中的 Upsert （添加或更新）行。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要在其中插入行的表视图的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number
upsertColumnName	upsertColumnName	True	string

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

在表列上创建索引

操作 ID:: CreateTableIndexes

针对表的一个或多个列创建索引以提高查询性能。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其创建索引的表的 UUID。
publicId	publicId	True	uuid

名称	路径	类型	说明
数据	data	array of TableColumn
元数据	metadata	object

在项目中搜索

操作 ID:: SearchProject

在特定项目中执行搜索作，由其 UUID 标识

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要在其中执行搜索的项目的 UUID
搜寻	search	True	string	搜索查询字符串
处理公共 ID	process_public_id		uuid	用于限制特定进程中搜索的进程的可选 UUID

名称	路径	类型	说明
数据	data	Answer
元数据	metadata	object

在项目中更改用户的角色

操作 ID:: ChangeUserRoleOnProject

更改特定项目中用户的角色，由项目的 UUID 和用户的 Firebase ID 标识

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	项目的 UUID
Firebase Id	firebase_id	True	string	要更改其角色的用户的 Firebase ID
角色	role	True	string

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

复制表

操作 ID:: DuplicateTable

创建现有表及其数据、设置和可选链接表的副本。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要复制的表的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
duplicateLinkedTables	duplicateLinkedTables		boolean
duplicatePermissions	duplicatePermissions		boolean
targetProjectId	targetProjectId		string

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

复制表的视图

操作 ID:: DuplicateTableView

为特定表创建现有视图的副本。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其复制视图的表的 UUID。
视图 ID	view_id	True	uuid	要复制的视图的 UUID。

名称	路径	类型	说明
数据	data	TableView
元数据	metadata	object

复制表的默认视图

操作 ID:: DuplicateDefaultTableView

为特定表创建默认视图的副本。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其复制默认视图的表的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
姓名	name		string
类型	type		integer

名称	路径	类型	说明
数据	data	TableView
元数据	metadata	object

复制进程

操作 ID:: DuplicateProcessAsync

复制现有进程（可能位于其他项目中）

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要复制的进程 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
duplicateLinkedTables	duplicateLinkedTables		boolean
duplicatePermissions	duplicatePermissions		boolean
targetProjectId	targetProjectId		string

复制项目

操作 ID:: DuplicateProject

创建现有项目的副本

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要复制的项目的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
duplicatePermissions	duplicatePermissions		boolean

导出过程

操作 ID:: ExportProcess

通过将特定进程 UUID 导出为不同的格式（PDF 或 DOCX）

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要导出的进程 UUID
导出格式	export_format		string	导出的格式（PDF 或 DOCX）
表链接	table_links		boolean	在导出中包含表链接
Description	description		boolean	在导出中包含进程说明
页面格式	page_format		string	导出的页面格式
页面方向	page_orientation		string	导出的页面方向
字体类型	font_type		string	导出的字体类型
字号	font_size		integer	导出的字号

response: binary

将标记添加到用户

操作 ID:: UserAddTag

向特定用户添加标记

参数

名称	密钥	必需	类型	说明
用户 ID	user_id	True	uuid	要向其添加标记的用户的公共 UUID
tagReferenceId	tagReferenceId	True	string

名称	路径	类型	说明
数据	data	Tag
元数据	metadata	object	其他元数据

将表与集成同步

操作 ID:: SyncTableWithIntegration

将表与指定的集成同步。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要同步的表的 UUID。
集成名称	integration_name	True	string	要与之同步的集成的名称。
companyId	companyId		string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
enterpriseId	enterpriseId		string
folderId	folderId		string
hubId	hubId		string
licenseId	licenseId		string
projectId	projectId		string
projectIds	projectIds		array of string
topFolderId	topFolderId		string
类型	type		string

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

将表数据下载为 CSV

操作 ID:: DownloadTableAsCSV

将指定表的数据下载为 CSV 文件。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要从中下载数据的表的 UUID
排序	sort		string	表行的排序条件
过滤器	filter		string	筛选表行的条件

response: binary

将视图设置为默认视图

操作 ID:: SetTableViewAsDefault

将特定表视图指定为表的默认视图。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要设置为默认值的表视图的 UUID。

名称	路径	类型	说明
数据	data	TableView
元数据	metadata	object

按公共 ID 获取标记

操作 ID:: GetTagByPublicId

按其公共 ID 检索标记。

参数

名称	密钥	必需	类型	说明
标记公共 ID	tag_id	True	string	要检索的标记的公共 ID。

名称	路径	类型	说明
数据	data	Tag
元数据	metadata	object

按公共 ID 获取用户详细信息

操作 ID:: GetUserByPublicId

按其公共 ID 获取有关特定用户的信息

参数

名称	密钥	必需	类型	说明
公共 ID	public_id	True	uuid	要检索的用户的公共 UUID

名称	路径	类型	说明
数据	data	User
元数据	metadata	object	元数据对象

按引用获取注释线程

操作 ID:: GetCommentThreadsByReference

检索与特定引用关联的所有注释线程

参数

名称	密钥	必需	类型	说明
引用类型	reference_type	True	string	与注释线程关联的引用类型（process_section、表或table_view）
引用 ID	reference_id	True	uuid	与注释线程关联的引用的 UUID
主参考	main_reference		string	其他筛选的可选主引用

名称	路径	类型	说明
数据	data	array of CommentThread
元数据	metadata	object

提交进程响应

操作 ID:: SubmitProcessResponse

提交进程响应，将其标记为已完成。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
进程响应 ID	process_response_id	True	uuid	要提交的进程响应的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
response	response

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

提交进程响应草稿

操作 ID:: SubmitProcessResponseDraft

提交流程响应草稿，供以后完成。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
进程响应 ID	process_response_id	True	uuid	要作为草稿提交的进程响应的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
response	response

名称	路径	类型	说明
数据	data	ProcessSection
元数据	metadata	object

搜索用户

操作 ID:: SearchUsers

按项目或流程搜索用户

参数

名称	密钥	必需	类型	说明
项目 ID	project_id		uuid	用于限制搜索的项目 ID
进程 ID	process_id		uuid	用于限制搜索的进程 ID
表视图 ID	table_view_id		uuid	用于限制搜索的表视图 ID
Query	query	True	string	用于搜索用户的查询字符串

名称	路径	类型	说明
数据	data	array of SummaryUser
元数据	metadata	object	其他元数据

更新 API 密钥

操作 ID:: UpdateApiKey

更新当前登录用户的 API 密钥

参数

名称	密钥	必需	类型	说明
API 密钥 ID	api_key_id	True	uuid	要更新的 API 密钥的 UUID
姓名	name		string

名称	路径	类型	说明
apiKey	apiKey	string	更新了 API 密钥详细信息

更新单个通知

操作 ID:: UpdateNotification

按 ID 更新特定通知。

参数

名称	密钥	必需	类型	说明
Id	id	True	uuid	要更新的通知的 UUID。
描述	description		string
processes	processes		array of uuid
tables	tables		array of uuid
publicId	publicId		uuid
资源	resource	True	string
谓词	verb	True	string
webhookUrl	webhookUrl	True	string

名称	路径	类型	说明
数据	data	Notification
元数据	metadata	object

更新多个进程部分

操作 ID:: UpdateMultipleProcessSections

更新多个现有进程部分。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
姓名	name		string
pageBreakBefore	pageBreakBefore		boolean
pdfIncludeDescription	pdfIncludeDescription		boolean
pdfIncludeSection	pdfIncludeSection		boolean
plaintextDescription	plaintextDescription		string
publicId	publicId	True	uuid

名称	路径	类型	说明
数据	data	array of MortaProcessSection
元数据	metadata	object

更新当前用户配置文件

操作 ID:: UpdateCurrentUser

更新当前登录用户的配置文件

参数

名称	密钥	类型
个人简历	bio	string
LinkedIn	linkedin	string
位置	location	string
姓名	name	string
组织	organisation	string
profilePicture	profilePicture	string
签名	signature	string
推特	twitter	string
大学	university	string
universityDegree	universityDegree	string
网站	website	string

名称	路径	类型	说明
数据	data	User
元数据	metadata	object

更新注释

操作 ID:: UpdateComment

更新批注线程中的特定注释

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	包含注释的注释线程的 UUID
注释 ID	comment_id	True	uuid	要更新的注释的 UUID
commentText	commentText	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

名称	路径	类型	说明
数据	data	Comment
change	metadata.change	object	对批注所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	已更新注释的 UUID

更新现有行

操作 ID:: UpdateTableRowsInView

更新指定表视图中的现有行。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要更新行的表视图的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
publicId	publicId	True	uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

更新现有表

操作 ID:: UpdateTable

更新现有表的属性。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要更新的表的 UUID
allowDuplication	allowDuplication		boolean
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinTableName	joinTableName		string
joinViewId	joinViewId		string
joinViewName	joinViewName		string
publicId	publicId		uuid
keepColoursInSync	keepColoursInSync		boolean
keepValidationsInSync	keepValidationsInSync		boolean
徽标	logo		string
姓名	name		string
syncHourlyFrequency	syncHourlyFrequency		integer
类型	type		string
变量	variables		array of string

名称	路径	类型	说明
数据	data	Table
元数据	metadata	object

更新现有表单元格

操作 ID:: UpdateDocumentTableCellsInView

更新表格视图中的特定单元格。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要更新单元格的表视图的 UUID。
columnName	columnName	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowId	rowId	True	string
value	value
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

更新现有进程

操作 ID:: UpdateProcess

按进程 ID 更新现有进程的详细信息

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要更新的过程的 UUID
allowComments	allowComments		boolean
allowDuplication	allowDuplication		boolean
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
expandByDefault	expandByDefault		boolean
isTemplate	isTemplate		boolean
徽标	logo		string
姓名	name		string
plaintextDescription	plaintextDescription		string
templateCategory	templateCategory		string
类型	type		string
变量	variables		array of string

名称	路径	类型	说明
数据	data	SimpleProcess
元数据	metadata	object

更新现有进程响应

操作 ID:: UpdateProcessResponse

更新进程节的现有响应。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
进程响应 ID	process_response_id	True	uuid	要更新的进程响应的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
截止日期	dueDate		date-time
expireResponse	expireResponse		boolean
pdfIncludeResponse	pdfIncludeResponse		boolean
resetAfterResponse	resetAfterResponse		boolean
反应	responders		array of string
类型	type		string
typeOptions	typeOptions

名称	路径	类型	说明
数据	data	MortaProcessResponse
元数据	metadata	object

更新现有进程部分

操作 ID:: UpdateProcessSection

按进程节 ID 更新现有进程节的详细信息

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	要更新的进程部分的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
姓名	name		string
pageBreakBefore	pageBreakBefore		boolean
pdfIncludeDescription	pdfIncludeDescription		boolean
pdfIncludeSection	pdfIncludeSection		boolean
plaintextDescription	plaintextDescription		string

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

更新现有项目

操作 ID:: UpdateProject

按项目 ID 更新现有项目的详细信息

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要更新的项目的 UUID
defaultProcessId	defaultProcessId		uuid
hideProcessCreated	hideProcessCreated		boolean
徽标	logo		string
mfaRequired	mfaRequired		boolean
姓名	name		string
primaryColour	primaryColour		string
processTitleBold	processTitleBold		boolean
processTitleColour	processTitleColour		string
processTitleFontSize	processTitleFontSize		number
processTitleItalic	processTitleItalic		boolean
processTitleUnderline	processTitleUnderline		boolean
公共	public		boolean

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

更新用户帐户

操作 ID:: UpdateUserAccount

更新当前登录用户的帐户详细信息

参数

名称	密钥	必需	类型
oldPassword	oldPassword	True	string
密码	password	True	string
passwordConfirm	passwordConfirm	True	string
twoFactorCode	twoFactorCode		string

名称	路径	类型	说明
数据	data	UserWithToken
元数据	metadata	object

更新表中的现有行

操作 ID:: UpdateTableRows

更新指定表中的现有行。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	将更新行的表的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
publicId	publicId	True	uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

更新表列

操作 ID:: UpdateTableColumn

更新表中特定列的属性。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含列的表的 UUID
列 ID	column_id	True	uuid	要更新的列的 UUID
aconexSynced	aconexSynced		integer
聚合	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
日期格式	dateFormat		string
decimalPlaces	decimalPlaces		integer
描述	description
isIndexed	isIndexed		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
mortaSynced	mortaSynced		integer
姓名	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
reviztoIssuesSynced	reviztoIssuesSynced		integer
脚本	script		string
scriptEnabled	scriptEnabled		boolean
thousandSeparator	thousandSeparator		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

名称	路径	类型	说明
数据	data	TableColumn
元数据	metadata	object

更新表格单元格

操作 ID:: UpdateTableCells

更新表中的特定单元格。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含要更新的单元格的表的 UUID。
columnName	columnName	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowId	rowId	True	string
value	value
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

更新表的视图

操作 ID:: UpdateTableView

更新特定表的现有视图。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要更新的表视图的 UUID。
allowContributorDelete	allowContributorDelete		boolean
chartSettings	chartSettings
collapsedGroupView	collapsedGroupView		boolean
backgroundColour	backgroundColour	True	string
columnId	columnId		uuid
columnName	columnName	True	string
filterType （过滤器类型）	filterType	True	string
fontColour	fontColour	True	string
multipleValues	multipleValues		array of
value	value
aconexSynced	aconexSynced		integer
聚合	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
日期格式	dateFormat		string
decimalPlaces	decimalPlaces		integer
描述	description
hardValidation	hardValidation		boolean
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
locked	locked		boolean
mortaSynced	mortaSynced		integer
姓名	name		string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
required	required		boolean
reviztoIssuesSynced	reviztoIssuesSynced		integer
脚本	script		string
scriptEnabled	scriptEnabled		boolean
sortOrder	sortOrder		number
stringValidation	stringValidation		string
thousandSeparator	thousandSeparator		boolean
validationMessage	validationMessage		string
validationNoBlanks	validationNoBlanks		boolean
validationNoDuplicates	validationNoDuplicates		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
描述	description
disableNewRow	disableNewRow		boolean
displayCommentRows	displayCommentRows		integer
displayValidationErrorRows	displayValidationErrorRows		integer
columnId	columnId		uuid
columnName	columnName	True	string
filterType （过滤器类型）	filterType	True	string
multipleValues	multipleValues		array of
orGroup	orGroup		string
value	value
frozenIndex	frozenIndex		integer
columnId	columnId		uuid
columnName	columnName	True	string
方向	direction	True	string
姓名	name		string
rowHeight	rowHeight		integer
columnId	columnId		uuid
columnName	columnName	True	string
方向	direction	True	string
类型	type		integer
unpackMultiselectGroupView	unpackMultiselectGroupView		boolean

名称	路径	类型	说明
数据	data	TableView
元数据	metadata	object

更新表联接

操作 ID:: UpdateTableJoin

更新表上的现有联接。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要更新联接的表的 UUID。
联接 ID	join_id	True	uuid	要更新的联接的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dataColumns	dataColumns		array of string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinViewId	joinViewId		string

名称	路径	类型	说明
数据	data	Table
元数据	metadata	object

更新视图上的列

操作 ID:: UpdateColumnOnTableView

更新表视图中的特定列。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	包含要更新的列的表视图的 UUID。
列 ID	column_id	True	uuid	要更新的表视图中列的 UUID。
aconexSynced	aconexSynced		integer
聚合	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
日期格式	dateFormat		string
decimalPlaces	decimalPlaces		integer
描述	description
hardValidation	hardValidation		boolean
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
locked	locked		boolean
mortaSynced	mortaSynced		integer
姓名	name		string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
required	required		boolean
reviztoIssuesSynced	reviztoIssuesSynced		integer
脚本	script		string
scriptEnabled	scriptEnabled		boolean
sortOrder	sortOrder		number
stringValidation	stringValidation		string
thousandSeparator	thousandSeparator		boolean
validationMessage	validationMessage		string
validationNoBlanks	validationNoBlanks		boolean
validationNoDuplicates	validationNoDuplicates		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

名称	路径	类型	说明
数据	data	TableViewColumn
元数据	metadata	object

更新资源的权限

操作 ID:: UpdateResourcePermissions

更新特定资源的权限（例如表、表视图或进程）。

参数

名称	密钥	必需	类型	说明
Id	id	True	uuid	要更新的策略的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
角色	role	True	integer

名称	路径	类型	说明
数据	data	AccessPolicy
元数据	metadata	object

更新进程响应程序

操作 ID:: UpdateProcessResponders

更新由其 UUID 标识的给定进程的响应程序列表

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要更新其响应者的进程的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
反应	responders		array of string

名称	路径	类型	说明
数据	data	MortaProcess
元数据	metadata	object

更新进程节顺序

操作 ID:: UpdateProcessSectionOrder

更新进程中的进程节的顺序。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
parentId	parentId		uuid
位置	position		integer
sectionId	sectionId		uuid

名称	路径	类型	说明
数据	data	MortaProcess
元数据	metadata	object

更新项目机密

操作 ID:: UpdateProjectSecret

更新项目中的特定机密

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	机密所在的项目的 UUID
机密 ID	secret_id	True	uuid	要更新的机密的 UUID
姓名	name	True	string
value	value	True	string

名称	路径	类型	说明
数据	data	ProjectSecret
元数据	metadata	object

更新项目标题样式

操作 ID:: UpdateProjectHeadingStyling

更新特定项目的标题样式

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其更新标题样式的项目的 UUID
样式 ID	style_id	True	uuid	要更新的样式的 UUID
bold	bold		boolean
颜色	colour		string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
fontSize	fontSize		number
斜体	italic		boolean
numberingStyle	numberingStyle		integer
startAt0	startAt0		boolean
下划线	underline		boolean

名称	路径	类型	说明
数据	data	SimpleProject
元数据	metadata	object

更新项目邀请

操作 ID:: UpdateProjectInvite

更新项目中的现有邀请

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	邀请所在的项目的 UUID
邀请 ID	invite_id	True	uuid	要更新的邀请的 UUID
tags	tags		array of string

名称	路径	类型	说明
数据	data	InvitedMember
元数据	metadata	object

检索项目中已删除的进程

操作 ID:: GetProjectDeletedProcesses

获取与特定项目关联的所有已删除进程，由其 UUID 标识

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索已删除进程的项目的 UUID

名称	路径	类型	说明
数据	data	array of SimpleProcess
元数据	metadata	object

检索项目中的进程

操作 ID:: GetProjectProcesses

获取与特定项目关联的所有进程，由其 UUID 标识

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索进程的项目的 UUID

名称	路径	类型	说明
数据	data	array of SimpleProcess
元数据	metadata	object

流式传输表的所有行

操作 ID:: StreamTableRows

流式传输特定表的所有行的数据。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要从中流式传输行的表的 UUID。
过滤器	filter		string	要应用于流数据的筛选器。
排序	sort		string	对流数据的参数进行排序。
页	page		integer	分页的页码
尺寸	size		integer	分页的每页项数

response: binary

流式传输视图的所有行

操作 ID:: StreamTableViewRows

流式传输特定表视图的所有行的数据。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	请求数据流的表视图的 UUID。
过滤器	filter		string	要应用于流数据的筛选器。
排序	sort		string	对流数据的参数进行排序。
进程 ID	process_id		uuid	用于筛选数据的进程的可选 UUID。
页	page		integer	分页的页码
尺寸	size		integer	分页的每页项数

response: binary

获取列的唯一值

操作 ID:: GetTableViewDistinctValues

检索表视图中特定列的唯一/非重复值。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	表视图的 UUID。
列 ID	column_id	True	uuid	要为其检索非重复值的列的 UUID。
过滤器	filter		string	要应用于数据检索的筛选器。
对列进行分组	group_columns		array	用于对非重复值的分组的可选列。

名称	路径	类型	说明
数据	data	array of string
元数据	metadata	object

获取列的唯一值

操作 ID:: GetDistinctValuesForColumn

检索表中指定列的非重复值列表。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含列的表的 UUID
列 ID	column_id	True	uuid	要为其检索非重复值的列的 UUID
过滤器	filter		string	非重复值的筛选条件
对列进行分组	group_columns		array	指定用于分组值的列

名称	路径	类型	说明
数据	data	array of string
元数据	metadata	object

获取受邀项目成员

操作 ID:: GetInvitedProjectMembers

检索指定项目的所有受邀成员

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索受邀成员的项目的 UUID

名称	路径	类型	说明
数据	data	array of InvitedMember
元数据	metadata	object

获取实际表视图数据

操作 ID:: GetTableViewRows

检索特定表视图的实际数据。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要为其检索数据的表视图的 UUID。
过滤器	filter		string	要应用于数据检索的筛选器。
排序	sort		string	对数据检索的参数进行排序。
页	page		integer	分页的页码。
尺寸	size		integer	分页的每页项数。

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
next_page_token	metadata.next_page_token	string
size	metadata.size	integer
总	metadata.total	integer

获取已删除的进程部分

操作 ID:: GetDeletedProcessSections

检索特定进程的所有已删除部分，其中包含特定进程节的可选筛选器

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	从中检索已删除节的过程的 UUID
进程节 ID	process_section_id		uuid	用于筛选已删除节的特定进程节的可选 UUID

response: array of MortaProcessSection

获取所有受支持的事件类型的列表

操作 ID:: GetNotificationEventTypes

检索通知支持的所有事件类型的列表。

名称	路径	类型	说明
数据	data	array of string
元数据	metadata	object

获取所有表联接

操作 ID:: GetTableJoins

检索与表关联的所有联接。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其检索联接的表的 UUID。

名称	路径	类型	说明
数据	data	array of TableJoin
元数据	metadata	object

获取注释线程

操作 ID:: GetCommentThread

按其 ID 检索特定注释线程

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	要检索的注释线程的 UUID

名称	路径	类型	说明
数据	data	CommentThread
元数据	metadata	object

获取注释线程统计信息

操作 ID:: GetCommentThreadStatsByReference

根据引用类型和主引用 ID 检索注释线程的统计信息

参数

名称	密钥	必需	类型	说明
引用类型	reference_type	True	string	要为其收集统计信息的引用类型（process_section、表或table_view）
主引用 ID	main_reference_id		uuid	要为其收集统计信息的主要引用的 UUID

名称	路径	类型	说明
数据	data	array of CommentThreadStats
元数据	metadata	object

获取特定用户详细信息

操作 ID:: GetUser

获取有关特定用户的信息

参数

名称	密钥	必需	类型	说明
Firebase Id	firebase_id	True	string	要检索的用户的 Firebase ID

名称	路径	类型	说明
数据	data	User
元数据	metadata	object	元数据对象

获取用户成就

操作 ID:: GetUserAchievements

按用户的 Firebase ID 获取用户的成就徽章

参数

名称	密钥	必需	类型	说明
Firebase Id	firebase_id	True	string	要检索其成就的用户的 Firebase ID

名称	路径	类型	说明
createdProcesses	data.createdProcesses	integer	用户创建的进程数
createdTables	data.createdTables	integer	用户创建的表数
元数据	metadata	object	元数据对象

获取用户拥有和管理的项目

操作 ID:: GetUserOwnerProjects

获取用户是所有者或管理员的所有项目

名称	路径	类型	说明
数据	data	array of HomeProject
元数据	metadata	object	其他元数据

获取用户最喜欢的项目

操作 ID:: GetFavouriteProjects

获取当前登录用户所属的所有热门项目

名称	路径	类型	说明
数据	data	array of object
isDeleted	data.isDeleted	boolean	指示是否删除项目
姓名	data.name	string	项目的名称
projectRole	data.projectRole	string	项目中的用户角色
publicId	data.publicId	uuid	项目的公共 ID
元数据	metadata	object	其他元数据

获取用户模板

操作 ID:: GetUserTemplates

获取当前登录用户有权访问的所有模板

名称	路径	类型
数据	data	array of object
createdBy	data.createdBy	SummaryUser
元数据	metadata	object

获取用户的公共贡献

操作 ID:: GetUserPublicContributions

获取由用户的 Firebase ID 标识的公共贡献

参数

名称	密钥	必需	类型	说明
Firebase Id	firebase_id	True	string	要检索其公共贡献的用户的 Firebase ID

名称	路径	类型	说明
数据	data	array of Event
元数据	metadata	object	元数据对象

获取用户的公共项目

操作 ID:: GetUserPublicProjects

获取用户所属的所有公共项目

名称	路径	类型	说明
数据	data	array of HomeProject
元数据	metadata	object	其他元数据

获取用户的固定项目

操作 ID:: GetUserPinnedProjects

获取由其 Firebase ID 标识的用户固定的项目

参数

名称	密钥	必需	类型	说明
Firebase Id	firebase_id	True	string	要检索固定项目的用户的 Firebase ID

名称	路径	类型	说明
数据	data	array of object
贡献	data.contributors	integer	项目的参与者数
姓名	data.name	string	项目的名称
primaryColour	data.primaryColour	string	项目的主要颜色
publicId	data.publicId	uuid	项目的公共 ID
views	data.views	integer	项目的视图数
元数据	metadata	object	元数据对象

获取用户贡献

操作 ID:: GetUserContributions

获取由用户的 Firebase ID 标识的每日贡献数

参数

名称	密钥	必需	类型	说明
Firebase Id	firebase_id	True	string	要检索其贡献的用户的 Firebase ID

名称	路径	类型	说明
数据	data	object	每天的捐款数，按日期键
元数据	metadata	object	元数据对象

获取用户项目

操作 ID:: GetUserProjects

获取当前登录用户所属的所有项目

名称	路径	类型	说明
数据	data	array of HomeProject
元数据	metadata	object	其他元数据

获取表列

操作 ID:: GetTableColumns

检索特定表的所有活动列。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要检索其列的表的 UUID

名称	路径	类型	说明
数据	data	array of TableColumn
元数据	metadata	object

获取表列的统计信息

操作 ID:: GetTableViewStats

检索特定表视图中列的统计数据。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要为其检索统计信息的表视图的 UUID。
过滤器	filter		string	要应用于统计数据检索的筛选器。
Sum、avg、max、min、count	sum, avg, max, min, count		array	指定要执行总和、平均值、最大值、最小值或计数作的列。
进程 ID	process_id		uuid	用于筛选数据的进程的可选 UUID。

名称	路径	类型	说明
数据	data	array of TableColumnWithAggregation
元数据	metadata	object

获取表列统计信息

操作 ID:: GetTableColumnStats

根据指定的参数检索表列的统计信息。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其检索统计信息的表的 UUID
集合体	aggregation		string	要应用于列的聚合函数
过滤器	filter		string	列的筛选条件

名称	路径	类型	说明
数据	data	array of TableColumnWithAggregation
元数据	metadata	object

获取表单元格的文件

操作 ID:: GetFileForTableCell

检索与表中特定单元格关联的文件。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含文件的表的 UUID。
列 ID	column_id	True	uuid	包含单元格的列的 UUID。
Filename	filename	True	string	要检索的文件的名称。

response: binary

获取表及其行

操作 ID:: GetTable

根据提供的参数检索表及其行

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要检索的表的 UUID
页	page		integer	分页的页码
尺寸	size		integer	分页的每页项数
排序	sort		string	表行的排序条件
过滤器	filter		string	筛选表行的条件
上次更新时间	last_updated_at		date-time	筛选此日期后更新的行
上次创建时间	last_created_at		date-time	筛选在此日期之后创建的行
下一页令牌	next_page_token		string	用于提取下一页结果的令牌
列	columns		array	要在响应中包含的特定列
非重复列	distinct_columns		array	要应用非重复筛选的列

名称	路径	类型	说明
数据	data	Table
页面	metadata.page	integer	当前页码
size	metadata.size	integer	每页项数
总	metadata.total	integer	表中的行总数

获取表的单个视图

操作 ID:: GetTableView

按表的 ID 检索特定视图。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	要检索的表视图的 UUID。
忽略缓存选项	ignore_cached_options		boolean	用于指示是否忽略响应中缓存的选项的标志。

名称	路径	类型	说明
数据	data	TableViewWithTable
元数据	metadata	object

获取表的所有视图

操作 ID:: GetTableViews

检索与特定表关联的所有视图。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要为其检索视图的表的 UUID。
忽略列	ignore_columns		boolean	用于指示是否忽略响应中的列数据的标志。

名称	路径	类型	说明
数据	data	array of TableView
元数据	metadata	object

获取表行

操作 ID:: GetTableRows

根据提供的查询参数从表中检索行。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要从中检索行的表的 UUID
页	page		integer	分页的页码
尺寸	size		integer	分页的每页项数
排序	sort		string	表行的排序条件
过滤器	filter		string	筛选表行的条件
上次更新时间	last_updated_at		date-time	筛选此日期后更新的行
上次创建时间	last_created_at		date-time	筛选在此日期之后创建的行
下一页令牌	next_page_token		string	用于提取下一页结果的令牌
列	columns		array	要在响应中包含的特定列
非重复列	distinct_columns		array	要应用非重复筛选的列

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
next_page_token	metadata.next_page_token	string
页面	metadata.page	integer
size	metadata.size	integer
总	metadata.total	integer

获取视图的图表数据

操作 ID:: GetTableViewChartData

检索基于特定表视图生成图表的数据。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	为其请求图表数据的表视图的 UUID。
图表类型	chart_type		string	要为其提取数据的图表的类型。
显示图例	show_legend		boolean	用于指示是否在图表中显示图例的标志。
显示值	show_values		boolean	用于指示是否在图表中显示值的标志。
列值 ID	column_value_id		uuid	要用作图表的值源的列的 UUID。
列标签 ID	column_label_id		uuid	要用作图表标签源的列的 UUID。

名称	路径	类型
数据	data	array of object
items	data	object
元数据	metadata	object

获取详细信息

操作 ID:: GetMe

获取有关当前用户的信息

名称	路径	类型	说明
数据	data	User
元数据	metadata	object	元数据对象

获取资源权限

操作 ID:: GetResourcePermissions

检索指定资源的权限，例如表、表视图或进程。

参数

名称	密钥	必需	类型	说明
Resource	resource	True	string	要为其检索权限的资源类型。有效选项为“process”、“table”或“table_view”。
资源 ID	resource_id	True	uuid	要为其检索权限的资源的 UUID。

名称	路径	类型	说明
数据	data	array of AccessPolicy
元数据	metadata	object

获取资源的所有事件

操作 ID:: GetEvents

检索与特定资源关联的所有事件，按各种条件进行筛选。

参数

名称	密钥	必需	类型	说明
资源 ID	resource_id	True	uuid	要为其检索事件的资源的 UUID。
类型	type	True	string	资源的类型（例如用户、进程、表、项目）。
页	page		integer	分页的页码。
用户	user		uuid	用于筛选事件的用户的可选 UUID。
动词	verb		array	用于筛选事件的可选谓词列表。
开始日期	start_date		date-time	可选开始日期以筛选事件。
结束日期	end_date		date-time	用于筛选事件的可选结束日期。
搜寻	search		string	用于筛选事件的可选搜索词。

名称	路径	类型	说明
数据	data	array of Event
元数据	metadata	object

获取进程详细信息

操作 ID:: GetProcess

按其 UUID 检索特定进程的详细信息

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要检索的进程 UUID
排除子级	exclude_children		boolean	从进程响应中排除子元素的标志

名称	路径	类型	说明
数据	data	MortaProcess
元数据	metadata	object

获取进程部分

操作 ID:: GetProcessSection

检索特定进程部分。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
主父部分	main_parent_section		boolean	用于检索进程节的主父部分的标志

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

获取项目中已删除的表

操作 ID:: GetProjectDeletedTables

从由其 UUID 标识的特定项目中检索所有已删除的表。只能由项目所有者访问。

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索已删除表的项目的 UUID

名称	路径	类型	说明
数据	data	array of Table
元数据	metadata	object

获取项目信息

操作 ID:: GetProject

检索其 UUID 标识的特定项目的详细信息

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要检索的项目的 UUID

名称	路径	类型	说明
文件夹	data.folders	array of object
childFolders	data.folders.childFolders	array of object
姓名	data.folders.childFolders.name	string
姓名	data.folders.name	string
projectDetails	data.projectDetails	SimpleProject
角色	data.role	string	项目中的用户角色
元数据	metadata	object

获取项目变量

操作 ID:: GetProjectVariables

检索与指定项目关联的所有变量

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索变量的项目的 UUID

名称	路径	类型
数据	data	array of object
细胞	data.cells	array of object
姓名	data.cells.column.name	string
publicId	data.cells.column.publicId	uuid
id	data.cells.id	string
value	data.cells.value	string
姓名	data.name	string
publicId	data.publicId	uuid
元数据	metadata	object

获取项目成员

操作 ID:: GetProjectMembers

检索与指定项目关联的所有成员

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索成员的项目的 UUID

名称	路径	类型	说明
数据	data	array of ProjectListWithUserTags
元数据	metadata	object

获取项目机密

操作 ID:: GetProjectSecrets

检索指定项目的所有机密

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索机密的项目的 UUID

名称	路径	类型	说明
数据	data	array of ProjectSecret
元数据	metadata	object

获取项目标记

操作 ID:: GetProjectTags

检索与指定项目关联的所有标记

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索标记的项目的 UUID

名称	路径	类型
数据	data	array of object
细胞	data.cells	array of object
姓名	data.cells.column.name	string
publicId	data.cells.column.publicId	uuid
id	data.cells.id	string
value	data.cells.value	string
姓名	data.name	string
publicId	data.publicId	uuid
元数据	metadata	object

获取项目的已发送通知

操作 ID:: GetProjectSentNotifications

检索指定项目的所有已发送通知

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索已发送通知的项目的 UUID
页	page		integer	通知执行的页码
尺寸	size		integer	每页的通知执行数
通知 ID	notification_id		uuid	用于筛选执行的特定通知的 UUID

名称	路径	类型	说明
数据	data	array of NotificationExecution
元数据	metadata	object

获取项目的通知

操作 ID:: GetProjectNotifications

检索与特定项目关联的所有通知。只有拥有项目所有者级权限的用户才能访问此终结点。

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索通知的项目的 UUID

名称	路径	类型	说明
数据	data	array of Notification
元数据	metadata	object

获取项目表

操作 ID:: GetProjectTables

检索与特定项目关联的表，由其 UUID 标识

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要为其检索表的项目的 UUID

名称	路径	类型	说明
数据	data	array of Table
元数据	metadata	object

获取项目资源

操作 ID:: GetProjectResources

检索与其 UUID 标识的特定项目关联的资源

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要检索其资源的项目的 UUID
adminView	adminView		boolean
excludeProcesses	excludeProcesses		boolean
excludeTables	excludeTables		boolean
onlyDeleted	onlyDeleted		boolean
projectPermissions	projectPermissions		boolean
类型 Id	typeId		string

名称	路径	类型	说明
数据	data	array of object
姓名	data.name	string	资源的名称
进程	data.process	PermissionedProcess
表	data.table	SimpleDocumentTable
类型	data.type	string	资源类型（进程或表）
元数据	metadata	object

表中的 Upsert 行

操作 ID:: UpsertTableRows

根据唯一的列值添加或更新指定表中的行。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要向上插入行的表的 UUID
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number
upsertColumnName	upsertColumnName	True	string

名称	路径	类型
数据	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

解析注释线程

操作 ID:: ResolveCommentThread

解析注释线程

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	要解析的注释线程的 UUID

名称	路径	类型	说明
数据	data	CommentThread
change	metadata.change	object	对批注线程所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	已解析注释线程的 UUID

请求资源权限

操作 ID:: RequestResourcePermissions

请求特定资源（例如表、表视图或进程）的权限。

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	资源所属项目的 UUID。
类型	type	True	string	要为其请求权限的资源类型。有效选项为“project”、“process”、“table”或“view”。
Id	id	True	uuid	要为其请求权限的资源的 UUID。

还原已删除的表

操作 ID:: RestoreTable

使用其 UUID 还原以前删除的表。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	要还原的表的 UUID

名称	路径	类型	说明
数据	data	Table
元数据	metadata	object

还原表列

操作 ID:: RestoreTableColumn

还原表中以前删除的列。

参数

名称	密钥	必需	类型	说明
表 ID	table_id	True	uuid	包含要还原的列的表的 UUID
列 ID	column_id	True	uuid	要还原的列的 UUID

名称	路径	类型	说明
数据	data	TableColumn
元数据	metadata	object

还原过程

操作 ID:: RestoreProcess

还原由其 UUID 标识的已删除进程

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	要还原的进程 UUID

名称	路径	类型	说明
数据	data	MortaProcess
元数据	metadata	object

还原过程部分

操作 ID:: RestoreProcessSection

还原以前删除的进程部分。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	要还原的进程部分的 UUID。

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

还原进程响应

操作 ID:: RestoreProcessResponse

还原以前删除的进程响应。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
进程响应 ID	process_response_id	True	uuid	要还原的进程响应的 UUID。

名称	路径	类型	说明
数据	data	ProcessResponse
元数据	metadata	object

还原项目

操作 ID:: RestoreProject

还原之前已删除的特定项目（由其 UUID 标识）

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要还原的项目的 UUID

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

邀请多个用户加入项目

操作 ID:: InviteMultipleUsersToProject

通过电子邮件邀请多个用户加入项目。如果用户已存在，则直接添加用户，否则将发送邀请。需要所有者或管理员权限。

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要向其邀请用户的项目的 UUID
电子邮件	emails		array of email
tags	tags		array of string

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

邀请用户加入项目

操作 ID:: InviteUserToProject

邀请单个用户通过电子邮件加入项目。如果用户已存在，则直接添加用户;否则，将发送邀请。需要所有者或管理员权限。

参数

名称	密钥	必需	类型	说明
项目 ID	project_id	True	uuid	要向其邀请用户的项目的 UUID
电子邮件	email	True	email
tags	tags		array of string

名称	路径	类型	说明
数据	data	string
元数据	metadata	object

重复进程

操作 ID:: DuplicateProcess

将现有进程（可选）复制到其他项目中

参数

名称	密钥	必需	类型
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processId	processId	True	uuid
projectId	projectId		uuid

名称	路径	类型	说明
数据	data	MortaProcess
元数据	metadata	object

重新打开批注线程

操作 ID:: ReopenCommentThread

重新打开以前解析的注释线程

参数

名称	密钥	必需	类型	说明
注释线程 ID	comment_thread_id	True	uuid	要重新打开的注释线程的 UUID

名称	路径	类型	说明
数据	data	CommentThread
change	metadata.change	object	对批注线程所做的更改
事件	metadata.event	string	作的事件类型
resourceId	metadata.resourceId	string	重新打开的注释线程的 UUID

重置进程响应

操作 ID:: ResetProcessResponse

将现有进程响应重置为其初始状态。

参数

名称	密钥	必需	类型	说明
进程 ID	process_id	True	uuid	进程的 UUID。
进程节 ID	process_section_id	True	uuid	进程部分的 UUID。
进程响应 ID	process_response_id	True	uuid	要重置的进程响应的 UUID。

名称	路径	类型	说明
数据	data	MortaProcessSection
元数据	metadata	object

预览输入生成的行

操作 ID:: PreviewTableRowInView

预览特定表视图中给定输入生成的行。

参数

名称	密钥	必需	类型	说明
视图 ID	view_id	True	uuid	为其生成行预览的表视图的 UUID。
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object

名称	路径	类型
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
元数据	metadata	object

定义

AccessAttribute

名称	路径	类型
documentTable	documentTable	Table3
kind	kind	string
项目	project	Project
publicId	publicId	uuid
标签	tag	Tag
用户	user	User3

访问策略

名称	路径	类型
accessAttribute	accessAttribute	AccessAttribute
accessResource	accessResource	AccessResource
publicId	publicId	uuid
角色	role	integer
roleLabel	roleLabel	string

AccessResource

名称	路径	类型
documentTable	documentTable	Table3
kind	kind	string
进程	process	Process
publicId	publicId	uuid

Action

名称	路径	类型
kind	kind	string
publicId	publicId	uuid
webhookUrl	webhookUrl	string

答案

名称	路径	类型	说明
answers	answers	array of SearchProjectAnswerResources
资源	resources	array of SearchProjectResources

ApiKey（应用程序密钥）

名称	路径	类型
哈希	hash	string
姓名	name	string
prefix	prefix	string
publicId	publicId	uuid

图表

名称	路径	类型
chartType	chartType	string
columnLabelId	columnLabelId	uuid
columnValueId	columnValueId	uuid
showLegend	showLegend	boolean
showValues	showValues	boolean

颜色

名称	路径	类型
backgroundColour	backgroundColour	string
columnId	columnId	uuid
columnName	columnName	string
filterType （过滤器类型）	filterType	string
fontColour	fontColour	string
multipleValues	multipleValues	array of
value	value

注释

名称	路径	类型
commentText	commentText	string
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
isOwner	isOwner
publicId	publicId	uuid
updatedAt	updatedAt	date-time
用户	user	SummaryUser

CommentThread

名称	路径	类型
comments	comments	array of Comment
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
isCommentInitiator	isCommentInitiator
publicId	publicId	uuid
resolvedAt	resolvedAt	date-time
解析器	resolver	User1
updatedAt	updatedAt	date-time

CommentThreadStats

名称	路径	类型
openCommentThreads	openCommentThreads	integer
referenceId	referenceId	uuid
resolvedCommentThreads	resolvedCommentThreads	integer

Draftjs

名称	路径	类型	说明
内容	content	DraftjsContent

DraftjsBlock

名称	路径	类型
数据	data
深度	depth	integer
entityRanges	entityRanges	array of
inlineStyleRanges	inlineStyleRanges	array of
关键值	key	string
文本消息	text	string
类型	type	string

DraftjsContent

名称	路径	类型	说明
块	blocks	array of DraftjsBlock
entityMap	entityMap

事件 / 活动

名称	路径	类型
change	change
更改 ID	changeId	string
上下文	context
contextProcessId	contextProcessId	integer
contextProcessResponseId	contextProcessResponseId	integer
contextProcessSectionId	contextProcessSectionId	integer
contextTableColumnId	contextTableColumnId	integer
contextTableId	contextTableId	integer
contextTableViewId	contextTableViewId	integer
createdAt	createdAt	date-time
projectId	projectId	integer
publicId	publicId	uuid
资源	resource	string
resourcePublicId	resourcePublicId	uuid
userId	userId	integer
谓词	verb	string

过滤器

名称	路径	类型
columnId	columnId	uuid
columnName	columnName	string
filterType （过滤器类型）	filterType	string
multipleValues	multipleValues	array of
orGroup	orGroup	string
value	value

组

名称	路径	类型
columnId	columnId	uuid
columnName	columnName	string
方向	direction	string

HeadingStyle

名称	路径	类型
bold	bold	boolean
颜色	colour	string
fontSize	fontSize	number
斜体	italic	boolean
水平仪	level	integer
numberingStyle	numberingStyle	integer
publicId	publicId	uuid
startAt0	startAt0	boolean
下划线	underline	boolean

HomeProject

名称	路径	类型
deletedAt	deletedAt	date-time
hideProcessCreated	hideProcessCreated	boolean
isDeleted	isDeleted	boolean
mfaRequired	mfaRequired	boolean
姓名	name	string
primaryColour	primaryColour	string
publicId	publicId	string

IntegrationsPassthroughResponse

名称	路径	类型
身体	body
内容类型	contentType	string
标题	headers
状态	status	string

InvitedMember

名称	路径	类型
createdAt	createdAt	date-time
电子邮件	email	string
invitedBy	invitedBy	SummaryUser
publicId	publicId	uuid
tags	tags	array of Tag

MortaProcess

名称	路径	类型
allowComments	allowComments	boolean
allowDuplication	allowDuplication	boolean
children	children	array of ProcessSection1
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
描述	description
expandByDefault	expandByDefault	boolean
isDeleted	isDeleted	boolean
isTemplate	isTemplate	boolean
徽标	logo	string
姓名	name	string
publicId	publicId	uuid
templateCategory	templateCategory	string
类型	type	string
updatedAt	updatedAt	date-time
variableValues	variableValues	array of string
变量	variables	array of string

MortaProcessResponse

名称	路径	类型
批准	approved	boolean
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
截止日期	dueDate	date-time
expireResponse	expireResponse	boolean
isDeleted	isDeleted	boolean
pdfIncludeResponse	pdfIncludeResponse	boolean
位置	position	integer
publicId	publicId	uuid
resetAfterResponse	resetAfterResponse	boolean
反应	responders	array of string
response	response
responseDate	responseDate	date-time
类型	type	string
typeOptions	typeOptions
updatedAt	updatedAt	date-time
用户	user	SummaryUser
userResponders	userResponders	array of SummaryUser

MortaProcessSection

名称	路径	类型
children	children	array of MortaProcessSection
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
描述	description	Draftjs
isDeleted	isDeleted	boolean
姓名	name	string
openCommentThreads	openCommentThreads	integer
pageBreakBefore	pageBreakBefore	boolean
parentId	parentId	uuid
pdfIncludeDescription	pdfIncludeDescription	boolean
pdfIncludeSection	pdfIncludeSection	boolean
位置	position	integer
publicId	publicId	uuid
回应	responses	array of ProcessResponse
状态	status	integer

通知

名称	路径	类型
行动	actions	array of Action
createdAt	createdAt	date-time
描述	description	string
processes	processes	array of Process
publicId	publicId	uuid
tables	tables	array of Table1
触发器	triggers	array of Trigger
用户	user	SummaryUser

Notification1

名称	路径	类型
行动	actions	array of Action
createdAt	createdAt	date-time
描述	description	string
processes	processes	array of Process
publicId	publicId	uuid
tables	tables	array of Table1
触发器	triggers	array of Trigger

NotificationExecution

名称	路径	类型
createdAt	createdAt	date-time
描述	description	string
是否成功	isSuccess	boolean
通知	notification	Notification1
publicId	publicId	uuid
updatedAt	updatedAt	date-time

PermissionedProcess

名称	路径	类型
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
徽标	logo	string
姓名	name	string
publicId	publicId	uuid
类型	type	string
updatedAt	updatedAt	date-time

流程

名称	路径	类型	说明
姓名	name	string
publicId	publicId	uuid

ProcessResponse

名称	路径	类型
批准	approved	boolean
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
截止日期	dueDate	date-time
expireResponse	expireResponse	boolean
isDeleted	isDeleted	boolean
pdfIncludeResponse	pdfIncludeResponse	boolean
位置	position	integer
publicId	publicId	uuid
resetAfterResponse	resetAfterResponse	boolean
反应	responders	array of string
response	response
responseDate	responseDate	date-time
类型	type	string
typeOptions	typeOptions
updatedAt	updatedAt	date-time
用户	user	SummaryUser
userResponders	userResponders	array of SummaryUser

ProcessSection

名称	路径	类型
姓名	name	string
publicId	publicId	uuid
状态	status	integer

ProcessSection1

名称	路径	类型
children	children	array of ProcessSection1
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
描述	description	Draftjs
isDeleted	isDeleted	boolean
姓名	name	string
openCommentThreads	openCommentThreads	integer
pageBreakBefore	pageBreakBefore	boolean
parentId	parentId	uuid
pdfIncludeDescription	pdfIncludeDescription	boolean
pdfIncludeSection	pdfIncludeSection	boolean
位置	position	integer
publicId	publicId	uuid
回应	responses	array of ProcessResponse
状态	status	integer

项目

名称	路径	类型	说明
姓名	name	string
publicId	publicId	string

ProjectList

名称	路径	类型
createdAt	createdAt	date-time
喜欢	favourite	boolean
projectRole	projectRole	string
updatedAt	updatedAt	date-time
用户	user	User4

ProjectListWithUserTags

名称	路径	类型
createdAt	createdAt	date-time
喜欢	favourite	boolean
projectRole	projectRole	string
updatedAt	updatedAt	date-time
用户	user	User2

ProjectSecret

名称	路径	类型
createdAt	createdAt	date-time
姓名	name	string
publicId	publicId	uuid
updatedAt	updatedAt	date-time
value	value	string

SearchProjectAnswerResources

名称	路径	类型
标签	label	string
链接	link	string
originalText	originalText	string
相似	similarity	number
文本消息	text	string

SearchProjectResources

名称	路径	类型
链接	link	string
文本消息	text	string
类型	type	string

SelectOptionsLookup

名称	路径	类型	说明
manualOptions	manualOptions	array of string
tableOptions	tableOptions

SimpleDocumentTable

名称	路径	类型
createdAt	createdAt	date-time
defaultViewId	defaultViewId	string
deletedAt	deletedAt	date-time
isDeleted	isDeleted	boolean
加入	joins	array of TableJoin
徽标	logo	string
姓名	name	string
publicId	publicId	uuid
类型	type	string
updatedAt	updatedAt	date-time

SimpleProcess

名称	路径	类型
allowComments	allowComments	boolean
allowDuplication	allowDuplication	boolean
children	children	array of ProcessSection
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
描述	description
expandByDefault	expandByDefault	boolean
isDeleted	isDeleted	boolean
isTemplate	isTemplate	boolean
徽标	logo	string
姓名	name	string
publicId	publicId	uuid
templateCategory	templateCategory	string
类型	type	string
updatedAt	updatedAt	date-time
variableValues	variableValues	array of string
变量	variables	array of string

SimpleProject

名称	路径	类型
adminLimit	adminLimit	integer
automationLimit	automationLimit	integer
createdAt	createdAt	date-time
defaultProcessId	defaultProcessId	string
deletedAt	deletedAt	date-time
headingStyles	headingStyles	array of HeadingStyle
hideProcessCreated	hideProcessCreated	boolean
图像	image	string
isDeleted	isDeleted	boolean
徽标	logo	string
mfaRequired	mfaRequired	boolean
姓名	name	string
noOfAdmins	noOfAdmins	integer
primaryColour	primaryColour	string
processTitleBold	processTitleBold	boolean
processTitleColour	processTitleColour	string
processTitleFontSize	processTitleFontSize	number
processTitleItalic	processTitleItalic	boolean
processTitleUnderline	processTitleUnderline	boolean
projectList	projectList	array of ProjectList
公共	public	boolean
publicId	publicId	string
updatedAt	updatedAt	date-time

排序

名称	路径	类型
columnId	columnId	uuid
columnName	columnName	string
方向	direction	string

SummaryUser

名称	路径	类型
电子邮件	email	string
firebaseUserId	firebaseUserId	string
姓名	name	string
profilePicture	profilePicture	string
publicId	publicId	uuid

Table

名称	路径	类型
allowDuplication	allowDuplication	boolean
columns	columns	array of TableColumn
createdAt	createdAt	date-time
defaultViewId	defaultViewId	string
deletedAt	deletedAt	date-time
isAconexSynced	isAconexSynced	boolean
isAutodeskBim360Synced	isAutodeskBim360Synced	boolean
isDeleted	isDeleted	boolean
isMortaProjectsSynced	isMortaProjectsSynced	boolean
isMortaResourcesSynced	isMortaResourcesSynced	boolean
isMortaSynced	isMortaSynced	boolean
isMortaUsersSynced	isMortaUsersSynced	boolean
isProcoreSynced	isProcoreSynced	boolean
isReviztoIssuesSynced	isReviztoIssuesSynced	boolean
isSynced	isSynced	boolean
isViewpointSynced	isViewpointSynced	boolean
加入	joins	array of TableJoin
keepColoursInSync	keepColoursInSync	boolean
keepValidationsInSync	keepValidationsInSync	boolean
lastSync	lastSync	date-time
徽标	logo	string
姓名	name	string
projects	projects	array of Project
publicId	publicId	uuid
syncHourlyFrequency	syncHourlyFrequency	integer
类型	type	string
updatedAt	updatedAt	date-time
变量	variables	array of string

Table1

名称	路径	类型
defaultViewId	defaultViewId	string
姓名	name	string
publicId	publicId	uuid

Table2

名称	路径	类型
createdAt	createdAt	date-time
姓名	name	string
publicId	publicId	uuid
类型	type	string
updatedAt	updatedAt	date-time

Table3

名称	路径	类型	说明
姓名	name	string
publicId	publicId	uuid

TableColumn

名称	路径	类型
aconexSynced	aconexSynced	integer
聚合	aggregate	integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced	integer
日期格式	dateFormat	string
decimalPlaces	decimalPlaces	integer
描述	description
isIndexed	isIndexed	boolean
isJoined	isJoined	boolean
kind	kind	string
kindOptions	kindOptions	SelectOptionsLookup
mortaSynced	mortaSynced	integer
姓名	name	string
procoreSynced	procoreSynced	integer
publicId	publicId	uuid
reviztoIssuesSynced	reviztoIssuesSynced	integer
脚本	script	string
scriptEnabled	scriptEnabled	boolean
thousandSeparator	thousandSeparator	boolean
viewpointSynced	viewpointSynced	integer
width	width	integer

TableColumnAggregationResult

名称	路径	类型	说明
姓名	name	string
value	value	number

TableColumnJoin

名称	路径	类型	说明
sourceColumnId	sourceColumnId	string
targetColumnId	targetColumnId	string

TableColumnWithAggregation

名称	路径	类型
聚合	aggregation	TableColumnAggregationResult
姓名	name	string
publicId	publicId	uuid

TableJoin

名称	路径	类型
dataColumns	dataColumns	array of TableJoinImportedColumns
isOneToMany	isOneToMany	boolean
joinColumns	joinColumns	array of TableColumnJoin
joinTableId	joinTableId	string
joinViewId	joinViewId	string
publicId	publicId	uuid

TableJoinImportedColumns

名称	路径	类型	说明
sourceColumnId	sourceColumnId	string
targetColumnId	targetColumnId	string

表格视图

名称	路径	类型
allowContributorDelete	allowContributorDelete	boolean
chartSettings	chartSettings	Chart
collapsedGroupView	collapsedGroupView	boolean
colourSettings	colourSettings	array of Colour
columns	columns	array of TableViewColumn
描述	description	Draftjs
disableNewRow	disableNewRow	boolean
displayCommentRows	displayCommentRows	integer
displayValidationErrorRows	displayValidationErrorRows	integer
filterSettings	filterSettings	array of Filter
frozenIndex	frozenIndex	integer
groupSettings	groupSettings	array of Group
isDefault	isDefault	boolean
姓名	name	string
publicId	publicId	uuid
rowHeight	rowHeight	integer
sortSettings	sortSettings	array of Sort
类型	type	integer
unpackMultiselectGroupView	unpackMultiselectGroupView	boolean

TableViewColumn

名称	路径	类型
aconexSynced	aconexSynced	integer
聚合	aggregate	integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced	integer
日期格式	dateFormat	string
decimalPlaces	decimalPlaces	integer
描述	description
hardValidation	hardValidation	boolean
isIndexed	isIndexed	boolean
isJoined	isJoined	boolean
kind	kind	string
kindOptions	kindOptions	SelectOptionsLookup
locked	locked	boolean
mortaSynced	mortaSynced	integer
姓名	name	string
procoreSynced	procoreSynced	integer
publicId	publicId	uuid
required	required	boolean
reviztoIssuesSynced	reviztoIssuesSynced	integer
脚本	script	string
scriptEnabled	scriptEnabled	boolean
sortOrder	sortOrder	number
stringValidation	stringValidation	string
thousandSeparator	thousandSeparator	boolean
validationMessage	validationMessage	string
validationNoBlanks	validationNoBlanks	boolean
validationNoDuplicates	validationNoDuplicates	boolean
viewpointSynced	viewpointSynced	integer
width	width	integer

TableViewWithTable

名称	路径	类型
allowContributorDelete	allowContributorDelete	boolean
chartSettings	chartSettings	Chart
collapsedGroupView	collapsedGroupView	boolean
colourSettings	colourSettings	array of Colour
columns	columns	array of TableViewColumn
描述	description	Draftjs
disableNewRow	disableNewRow	boolean
displayCommentRows	displayCommentRows	integer
displayValidationErrorRows	displayValidationErrorRows	integer
documentTable	documentTable	Table2
filterSettings	filterSettings	array of Filter
frozenIndex	frozenIndex	integer
groupSettings	groupSettings	array of Group
isDefault	isDefault	boolean
姓名	name	string
publicId	publicId	uuid
rowHeight	rowHeight	integer
sortSettings	sortSettings	array of Sort
类型	type	integer
unpackMultiselectGroupView	unpackMultiselectGroupView	boolean

标记

名称	路径	类型
documentTableId	documentTableId	string
projectPublicId	projectPublicId	uuid
publicId	publicId	uuid
referencePublicId	referencePublicId	string
value	value

Trigger

名称	路径	类型
publicId	publicId	uuid
资源	resource	string
谓词	verb	string

用户

名称	路径	类型
aconexConnected	aconexConnected	boolean
apiKeys	apiKeys	array of ApiKey
autodeskConnected	autodeskConnected	boolean
个人简历	bio	string
constructionSoftware	constructionSoftware	array of string
电子邮件	email	string
firebaseUserId	firebaseUserId	string
kind	kind	string
LinkedIn	linkedin	string
位置	location	string
姓名	name	string
组织	organisation	string
phone	phone	string
procoreConnected	procoreConnected	boolean
profilePicture	profilePicture	string
projectsWorkedOn	projectsWorkedOn	array of string
publicId	publicId	uuid
reviztoConnected	reviztoConnected	boolean
签名	signature	string
专业	specialisms	array of string
tags	tags
推特	twitter	string
大学	university	string
universityDegree	universityDegree	string
viewpointConnected	viewpointConnected	boolean
网站	website	string

User1

名称	路径	类型	说明
姓名	name	string

User2

名称	路径	类型
电子邮件	email	string
firebaseUserId	firebaseUserId	string
kind	kind	string
姓名	name	string
profilePicture	profilePicture	string
publicId	publicId	uuid
tags	tags

User3

名称	路径	类型
firebaseUserId	firebaseUserId	string
姓名	name	string
publicId	publicId	uuid

User4

名称	路径	类型
电子邮件	email	string
firebaseUserId	firebaseUserId	string
kind	kind	string
姓名	name	string
publicId	publicId	uuid

UserWithToken

名称	路径	类型
aconexConnected	aconexConnected	boolean
apiKeys	apiKeys	array of ApiKey
authToken 认证	authToken	string
autodeskConnected	autodeskConnected	boolean
个人简历	bio	string
constructionSoftware	constructionSoftware	array of string
电子邮件	email	string
firebaseUserId	firebaseUserId	string
hasPassword	hasPassword
id	id	integer
is2FaEnabled	is2FaEnabled
isSuperAdmin	isSuperAdmin	boolean
kind	kind	string
lastLoginAt	lastLoginAt	date-time
LinkedIn	linkedin	string
位置	location	string
姓名	name	string
组织	organisation	string
phone	phone	string
procoreConnected	procoreConnected	boolean
profilePicture	profilePicture	string
projectsWorkedOn	projectsWorkedOn	array of string
publicId	publicId	uuid
reviztoConnected	reviztoConnected	boolean
签名	signature	string
专业	specialisms	array of string
tags	tags
推特	twitter	string
大学	university	string
universityDegree	universityDegree	string
viewpointConnected	viewpointConnected	boolean
网站	website	string

二进制

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

通过

莫塔 （预览版）

先决条件

如何获取凭据

连接器入门

已知问题和限制

常见错误和补救措施

FAQ

正在创建连接

违约

限制

操作

Check Process Table is Used In

参数

返回

“重复进程”部分

参数

返回

“重复进程”部分

参数

返回

下载图表图像

参数

返回

为用户创建 API 密钥

参数

返回

为表创建新视图

参数

返回

为资源创建权限

参数

返回

为项目重新发送对用户的邀请

参数

返回

从用户中删除标记

参数

返回

从表中删除所有行

参数

返回

从表中删除集成

参数

返回

从项目中删除用户

参数

返回

以 csv 文件的形式下载查看数据

参数

返回

切换项目的固定状态

参数

返回

切换项目的最爱状态

参数

返回

创建多个新进程部分

参数

返回

创建新批注

参数

返回

创建新文档表

参数

返回

创建新流程

参数

返回

创建新流程部分

参数

返回

创建新流程部分

参数

返回

创建新用户

参数

返回

创建新的批注线程

参数

莫塔（预览版）