Finalcad One Connect 4.0 (预览版)

Finalcad One 是一个建筑管理平台,旨在改进协作、跟踪进度和简化现场作。 使用此连接器,可以将 Finalcad One 与其他数百个应用程序集成,以简化项目跟踪、自动执行重复任务并提高整体效率。

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

服务 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 Finalcad
URL https://www.finalcad.com/contact
Email support@finalcad.com
连接器元数据
发布者 FINALCAD
网站 https://developer.finalcad.com/
隐私策略 https://www.finalcad.com/apps-privacy-policy
类别 生产力

Fc1 连接器

先决条件

To use this connector, you need a Finalcad API key.

Triggers

When a form is created or updated
When an observation is created or updated
When a document is created

行动

Read form details
Read observation details
Read project information
Read current user information

正在创建连接

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

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

违约

适用:所有区域

用于创建连接的参数。

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

Name 类型 Description 必选
API 密钥 securestring 此 API 的 API 密钥 True

限制

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

操作

媒体 - 中止区块上传

取消当前区块上传过程并放弃任何收到的部件。

媒体 - 启动区块上传

启动以区块上传媒体文件的过程。

媒体 - 获取媒体资源 URL

检索用于访问媒体资源的 URL

媒体 - 追加区块部分

将单个区块追加到正在进行的媒体上传会话。

媒体 - 验证区块上传

通过验证是否已正确接收所有区块来确认和完成上传。

安装程序 - 项目

设置项目配置

工作区 - 添加成员

将成员添加到工作区

组织 - 创建项目

创建项目

组织 - 添加成员

将成员添加到组织

组织 - 获取工作区

获取与组织相关的工作区

组织 - 获取建议的模块

获取与组织相关的建议模块

组织 - 获取组织列表

获取你所属的所有组织的列表

组织 - 获取表单状态

获取模板中的表单状态

组织 - 获取角色

获取组织角色

组织 - 获取连接用户

获取用户信息

组织 - 获取项目列表

获取给定组织中所有项目的列表

获取时区列表

获取可用时区的列表

获取语言

获取库和项的所有可用语言

设置 - 语言和时区

设置语言和时区配置

项目 - 创建文档

项目 - 创建文档

项目 - 创建窗体

创建表单

项目 - 创建观察

创建观察

项目 - 添加用户

在项目中添加用户

项目 - 获取公司

获取项目中的公司

项目 - 获取文档或文件夹

获取文档或文件夹

项目 - 获取文档文件夹

获取项目中的文档文件夹

项目 - 获取用户

获取项目中的用户

项目 - 获取表单优先级

获取项目中的表单优先级

项目 - 获取表单模块

获取给定项目的所有现有表单模块的列表

项目 - 获取表单模板

获取表单模板

项目 - 获取表单类别

获取表单类别

项目 - 获取表单详细信息

获取给定表单的详细信息(说明、模板名称、被分配者,...)

项目 - 获取观察优先级

获取项目中的观察优先级

项目 - 获取观察模块

获取给定项目的所有现有观察模块的列表

项目 - 获取观察模型

获取观察模型(该类别以前称为贸易)

项目 - 获取观察状态

获取项目中的观察状态

项目 - 获取观察类别

获取观察类别(以前交易)

项目 - 获取观察详细信息

获取给定观察的详细信息(说明、状态、被分配者,...)

项目 - 获取角色

获取项目角色

项目 - 获取计划或文件夹

获取项目中的计划或文件夹

项目 - 获取讨论组

获取项目中的讨论组

项目 - 获取阶段

获取项目中的阶段

项目 - 获取项目详细信息

获取给定项目的详细信息(时区、语言、更新日期,...)

媒体 - 中止区块上传

取消当前区块上传过程并放弃任何收到的部件。

参数

名称 密钥 必需 类型 说明
媒体 ID
mediaId True string

媒体 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

区块 ID
chunk_id True string

区块 ID

返回

Body
Media

媒体 - 启动区块上传

启动以区块上传媒体文件的过程。

参数

名称 密钥 必需 类型 说明
语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

媒体文件名
file_name True string

媒体文件名

媒体总大小(以字节为单位)
total_bytes True integer

媒体总大小(以字节为单位)

媒体 MD5
md5 string

媒体 MD5

返回

媒体 - 获取媒体资源 URL

检索用于访问媒体资源的 URL

参数

名称 密钥 必需 类型 说明
媒体 ID
mediaId True string

媒体 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

媒体 - 追加区块部分

将单个区块追加到正在进行的媒体上传会话。

参数

名称 密钥 必需 类型 说明
媒体 ID
mediaId True string

媒体 ID

语言
Accept-Language string

语言

区块 ID
chunk_id True string

区块 ID

段号
segment_index True integer

区块号

上次呼叫?
last_chunk boolean

上次呼叫?

filename
filename True string
内容类型
contentType True string
内容
content True byte

媒体 - 验证区块上传

通过验证是否已正确接收所有区块来确认和完成上传。

参数

名称 密钥 必需 类型 说明
媒体 ID
mediaId True string

媒体 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

区块 ID
chunk_id True string

区块 ID

返回

Body
Media

安装程序 - 项目

设置项目配置

参数

名称 密钥 必需 类型 说明
组织 ID
business_organization_id string

组织 ID

项目标识
project_id string

项目标识

返回

名称 路径 类型 说明
business_organization_id
business_organization_id string
project_id
project_id string

工作区 - 添加成员

将成员添加到工作区

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

工作区 ID
workspaceId True string

工作区 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

用户 ID
user_id string

用户 ID

用户电子邮件
user_email string

用户电子邮件

返回

组织 - 创建项目

创建项目

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

项目名称
name True string

项目名称

项目工作区 ID
workspace_id string

项目工作区 ID

项目模块 ID
module_ids array of string

项目模块 ID

项目说明
description string

项目说明

项目语言
language string

项目语言

项目时区
time_zone string

项目时区

项目参考
case_number string

项目参考

项目地址
address string

项目地址

项目结束日期
end_date string

项目结束日期

返回

组织 - 添加成员

将成员添加到组织

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

角色 ID
role_id string

角色 ID

用户电子邮件
users_info array of string

用户电子邮件

组织 - 获取工作区

获取与组织相关的工作区

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

父工作区 ID
parent_id string

父工作区 ID

包括子级
with_children string

包括子级

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

组织 - 获取建议的模块

获取与组织相关的建议模块

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

工作区 ID
workspace_id string

工作区 ID

最大模块数
limit string

最大模块数

第 N 个模块
offset string

第 N 个模块

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

组织 - 获取组织列表

获取你所属的所有组织的列表

参数

名称 密钥 必需 类型 说明
语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

名称 路径 类型 说明
array of object
id
id string

id

姓名
name string

姓名

组织 - 获取表单状态

获取模板中的表单状态

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

表单模板 ID
formId True string

表单模板 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

组织 - 获取角色

获取组织角色

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetRoles

组织 - 获取连接用户

获取用户信息

参数

名称 密钥 必需 类型 说明
语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

组织 - 获取项目列表

获取给定组织中所有项目的列表

参数

名称 密钥 必需 类型 说明
组织 ID
organizationId True string

组织 ID

工作区 ID
workspace_id string

工作区 ID

包括子工作区
with_workspace_children boolean

包括子工作区

搜索词
search_term string

搜索词

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

获取时区列表

获取可用时区的列表

参数

名称 密钥 必需 类型 说明
要检索的时区的最大数目。
limit string

要检索的时区的最大数目。

第 N 个时区。
offset string

第 N 个时区。

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

获取语言

获取库和项的所有可用语言

参数

名称 密钥 必需 类型 说明
语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

设置 - 语言和时区

设置语言和时区配置

参数

名称 密钥 必需 类型 说明
语言
language string

语言

时区
timezone string

用户的时区(采用 IANA 格式)

返回

名称 路径 类型 说明
语言
language string
timezone
timezone string

项目 - 创建文档

项目 - 创建文档

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

文档名称
name True string

文档名称

文档父 ID
parent_id string

父文件夹的 ID

文档媒体 ID
media_id string

如果未填写字段,将创建一个文件夹

返回

项目 - 创建窗体

创建表单

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

表单模块 ID
module_id True string

表单模块 ID

表单模板
form_id True string

表单模板 ID

表单名称
name True string

窗体名称

窗体类别 ID
category_id string

窗体类别 ID

表单状态 ID
status_id string

表单状态 ID

表单公司 ID
company_id string

表单分配的公司 ID

表单被分配者 ID
assignee_id string

表单分配的用户 ID

表单计划 ID
plan_id string

表单计划 ID

表单 X 位置
position_x decimal

计划 0 到 1 之间的表单 X 位置

窗体 Y 位置
position_y decimal

0 到 1 之间的计划 Y 位置

窗体纬度
latitude decimal

窗体纬度

窗体经度
longitude decimal

窗体经度

表单优先级 ID
priority_id string

表单优先级 ID

表单截止日期
due_date string

表单截止日期

窗体阶段 ID
phase_id string

表单阶段 ID

表单 ID
id string

表单 ID

返回

项目 - 创建观察

创建观察

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

观察模块 ID
module_id True string

观察模块 ID

观察类别 ID
trade_id string

该类别以前称为贸易

观察模型 ID
common_observation_id string

该模型以前称为常见观察

观察说明
description string

观察说明

观察状态 ID
status_id string

观察状态 ID

观察公司 ID
company_id string

观察分配的公司 ID

观察被分配者 ID
assignee_id string

观察分配的用户 ID

观察计划 ID
plan_id string

观察计划 ID

对计划观察 X 位置
position_x decimal

观察 X 位置介于 0 和 1 之间

计划中的观察 Y 位置
position_y decimal

观察 Y 位置介于 0 和 1 之间

观察优先级 ID
priority_id string

观察优先级 ID

观察截止日期
due_date string

观察截止日期

观察阶段 ID
phase_id string

观察阶段 ID

观察讨论组 ID
group_id string

在其创建时应共享观察的讨论组

观察纬度
latitude decimal

观察纬度

观察经度
longitude decimal

观察经度

观察 ID
id string

观察 ID

返回

项目 - 添加用户

在项目中添加用户

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

不要向用户发送电子邮件
doNotSendEmail boolean

不要向用户发送电子邮件

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

用户电子邮件
email True string

用户电子邮件

用户角色 ID
project_role_id True string

用户角色 ID

返回

Body
AddMembers

项目 - 获取公司

获取项目中的公司

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续令牌
continuous_token string

连续令牌

要检索的最大公司数
limit integer

要检索的最大公司数

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取文档或文件夹

获取文档或文件夹

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

文档 ID
documentId True string

文档 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
Document

项目 - 获取文档文件夹

获取项目中的文档文件夹

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

父文件夹 ID
parent_id string

父文件夹 ID

筛选内容类型 ÔÇÿfolder“、”documentÔÇÖ 或 nothing”。
type string

筛选内容类型 ÔÇÿfolder“、”documentÔÇÖ 或 nothing”。

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取用户

获取项目中的用户

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续令牌
continuous_token string

连续令牌

要检索的最大成员数
limit integer

要检索的最大成员数

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetMembers

项目 - 获取表单优先级

获取项目中的表单优先级

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续令牌
continuous_token string

连续令牌

要检索的最大优先级数
limit integer

要检索的最大优先级数

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取表单模块

获取给定项目的所有现有表单模块的列表

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续标记
continuous_token string

连续标记

要检索的最大模块数
limit integer

要检索的最大模块数

包括已删除
with_deleted boolean

包括已删除

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取表单模板

获取表单模板

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

模块 ID
module_id string

模块 ID

类别 ID
category_id string

类别 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetForms

项目 - 获取表单类别

获取表单类别

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

模块 ID
module_id string

模块 ID

父类别 ID
category_id string

父类别 ID

包括已禁用
with_disabled string

包括已禁用

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取表单详细信息

获取给定表单的详细信息(说明、模板名称、被分配者,...)

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

表单 ID
formId True string

表单 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取观察优先级

获取项目中的观察优先级

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续令牌
continuous_token string

连续令牌

第 N 个优先级
offset string

第 N 个优先级

要检索的最大 od 优先级数
limit integer

要检索的最大 od 优先级数

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取观察模块

获取给定项目的所有现有观察模块的列表

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续标记
continuous_token string

连续标记

要检索的最大模块数
limit integer

要检索的最大模块数

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetModules

项目 - 获取观察模型

获取观察模型(该类别以前称为贸易)

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

类别 ID
tradeId True string

类别 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取观察状态

获取项目中的观察状态

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续令牌
continuous_token string

连续令牌

要检索的最大状态数
limit integer

要检索的最大状态数

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取观察类别

获取观察类别(以前交易)

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

模块 ID
module_id string

模块 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取观察详细信息

获取给定观察的详细信息(说明、状态、被分配者,...)

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

观察 ID
observationId True string

观察 ID

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取角色

获取项目角色

参数

名称 密钥 必需 类型 说明
项目 ID
projectId True string

项目 ID

要检索的项目角色的最大数目
limit string

要检索的项目角色的最大数目

第 N 个角色
offset string

第 N 个角色

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取计划或文件夹

获取项目中的计划或文件夹

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

文件夹 ID
folder_id string

文件夹 ID

仅包括计划或文件夹
type string

仅包括计划或文件夹

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

项目 - 获取讨论组

获取项目中的讨论组

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

要检索的讨论组的最大数量
limit integer

要检索的讨论组的最大数量

我想从中检索讨论组的第 n 个讨论组
offset integer

我想从中检索讨论组的第 n 个讨论组

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetGroups

项目 - 获取阶段

获取项目中的阶段

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

连续标记
continuous_token string

连续标记

第 N 阶段
offset string

第 N 阶段

要检索的最大阶段数
limit integer

要检索的最大阶段数

包括已删除
with_deleted boolean

包括已删除

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetPhases

项目 - 获取项目详细信息

获取给定项目的详细信息(时区、语言、更新日期,...)

参数

名称 密钥 必需 类型 说明
项目标识
projectId True string

项目标识

语言
Accept-Language string

语言

TimeZone
X-TimeZone string

TimeZone

返回

Body
GetProject

触发器

触发器 - 创建的观察

创建观察时触发流

触发器 - 已创建文档

创建文档时触发流

触发器 - 已创建窗体

创建窗体时触发流

触发器 - 窗体已更新

更新窗体时触发流

触发器 - 观察更新

更新观察时触发流

触发器 - 创建的观察

创建观察时触发流

参数

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

组织 ID

project_id
project_id True string

项目标识

返回

名称 路径 类型 说明
parent_id
parent_id string

parent_id

事件
event integer

事件

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

触发器 - 已创建文档

创建文档时触发流

参数

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

组织 ID

project_id
project_id True string

项目标识

返回

名称 路径 类型 说明
parent_id
parent_id string

parent_id

事件
event integer

事件

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

触发器 - 已创建窗体

创建窗体时触发流

参数

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

组织 ID

project_id
project_id True string

项目标识

返回

名称 路径 类型 说明
parent_id
parent_id string

parent_id

事件
event integer

事件

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

触发器 - 窗体已更新

更新窗体时触发流

参数

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

组织 ID

project_id
project_id True string

项目标识

返回

名称 路径 类型 说明
parent_id
parent_id string

parent_id

事件
event integer

事件

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

触发器 - 观察更新

更新观察时触发流

参数

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

组织 ID

project_id
project_id True string

项目标识

返回

名称 路径 类型 说明
parent_id
parent_id string

parent_id

事件
event integer

事件

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

定义

AddMembers

名称 路径 类型 说明
用户列表
project_roles array of ProjectRole

用户列表

公司

名称 路径 类型 说明
公司 ID
id string

公司 ID

公司名称
name string

公司名称

已启用公司
enabled boolean

已启用公司

公司成员
user_ids array of string

公司成员

公司参考
reference string

公司参考

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

CreateDocument

名称 路径 类型 说明
文档 ID
id string

文档 ID

文档类型
type string

文档类型

文档名称
name string

文档名称

文档父文件夹 ID
parent_id string

文档父文件夹 ID

media_resource
media_resource Media
文档已启用
enabled boolean

文档已启用

文档类型
file_type string

文档类型

文档源
item_source string

文档源

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

CreateFormInstance

名称 路径 类型 说明
表单 ID
id string

表单 ID

窗体名称
name string

窗体名称

表单模板 ID
form_id string

表单模板 ID

表单状态 ID
status_id string

表单状态 ID

表单优先级 ID
priority_id string

表单优先级 ID

表单计划 ID
plan_id string

表单计划 ID

表单 X 位置
position_x decimal

表单 X 位置

窗体 Y 位置
position_y decimal

窗体 Y 位置

窗体纬度
latitude decimal

窗体纬度

窗体经度
longitude decimal

窗体经度

表单用户 ID
assignee_id string

表单分配的用户 ID

表单公司 ID
company_id string

表单分配的公司 ID

表单截止日期
due_date string

表单截止日期

表单创建日期
client_created_at string

表单创建 ID

表单更新日期
client_updated_at string

表单更新 ID

表单模块 ID
module_id string

表单模块 ID

表单阶段 ID
phase_id string

表单阶段 ID

窗体类别 ID
category_id string

窗体类别 ID

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

CreateObservation

名称 路径 类型 说明
id
id string
project_id
project_id string
描述
description string
status_id
status_id string
priority_id
priority_id string
plan_id
plan_id string
position_x
position_x decimal
position_y
position_y decimal
latitude
latitude decimal
longitude
longitude decimal
assignee_id
assignee_id string
company_id
company_id string
trade_id
trade_id string
common_observation_id
common_observation_id string
due_date
due_date string
client_created_at
client_created_at string
client_updated_at
client_updated_at string
module_id
module_id string
phase_id
phase_id string
创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

CreateProject

名称 路径 类型 说明
项目地址
address string

项目地址

项目时区
time_zone string

项目 IANA 时区

项目语言
language string

项目语言

项目标识
project_id string

项目标识

项目组织 ID
organization_id string

项目组织 ID

项目名称
name string

项目名称

项目案例
case_number string

项目案例

项目工作区 ID
workspace_id string

项目工作区 ID

项目说明
description string

项目说明

项目结束日期
end_date string

项目结束日期

项目成员计数
member_count integer

项目成员计数

项目已存档
is_archived boolean

项目已存档

media_resource
media_resource Media
项目中的当前用户
current_user_in_project boolean

项目中的当前用户是吗?

项目处于活动状态
is_active boolean

项目处于活动状态

项目状态
status string

项目状态

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

文档

名称 路径 类型 说明
文档 ID
id string

文档 ID

文档类型
type string

文档类型

文档名称
name string

文档名称

文档父文件夹 ID
parent_id string

文档父文件夹 ID

media_resource
media_resource Media
文档已启用
enabled boolean

文档已启用

文档类型
file_type string

文档类型

文档源
item_source string

文档源

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

FolderContent

名称 路径 类型 说明
文件夹内容 ID
id string

文件夹内容 ID

文件夹内容类型
type string

文件夹内容类型

文件夹内容名称
name string

文件夹内容名称

文件夹内容顺序
order double

文件夹内容顺序

文件夹内容创建日期
created_at string

文件夹内容创建日期

文件夹内容更新日期
updated_at string

文件夹内容更新日期

文件夹内容源
source string

文件夹内容 Isourced

文件夹内容文件夹资源
sources_contained string

文件夹内容文件夹资源

已启用文件夹内容
enabled boolean

已启用文件夹内容

表格

名称 路径 类型 说明
模板编号
id string

模板编号

模板名称
name string

模板名称

已启用模板
enabled boolean

已启用模板是/否

模板版本号
version integer

模板版本号

模板模块 ID
module_id string

模板模块 ID

模板类别 ID
category_id string

模板类别 ID

模板创建日期
created_at string

模板创建日期

模板更新日期
updated_at string

模板更新日期

GetCommonObsByTrade

名称 路径 类型 说明
CommonObs
common_observations array of ObservationCommonObservation

CommonObs

GetCompanies

名称 路径 类型 说明
公司
companies array of Company

公司

列表已完成
need_to_relaunch boolean

列表已完成

连续令牌
continuous_token string

用于获取下一项的令牌

项计数
count integer

项计数

项目总计计数
total_count integer

项目总计计数

GetDocumentsFiltered

名称 路径 类型 说明
文件
documents array of Document
计数
count integer

GetFolderContent

名称 路径 类型 说明
文件夹内容
contents array of FolderContent

文件夹内容

计数
count integer

GetFormFull

名称 路径 类型 说明
表单 ID
id string

表单 ID

表单编号
legacy_id integer

表单编号

已启用表单
enabled boolean

已启用表单

表单模板 ID
form_id string

表单模板 ID

组织 ID
organization_id string

组织 ID

组织名称
organization_name string

组织名称

项目 ID
project_id string

项目标识

项目名称
project_name string

项目名称

表单说明
description string

表单说明

表单模板名称
template_name string

表单模板名称

表单状态 ID
status_id string

表单状态 ID

窗体状态名称
status_name string

窗体状态名称

表单优先级 ID
priority_id string

表单优先级 ID

表单优先级名称
priority_name string

表单优先级名称

表单用户 ID
assignee_id string

表单分配的用户 ID

表单用户名
assignee_name string

表单分配的用户名

表单公司 ID
company_id string

表单公司 ID

表单公司名称
company_name string

表单分配的公司名称

表单截止日期
due_date string

表单截止日期

表单计划 ID
plan_id string

表单计划 ID

表单计划名称
plan_name string

表单计划名称

表单 X 位置
position_x string

表单 X 位置

窗体 Y 位置
position_y string

窗体 Y 位置

窗体纬度
latitude string

窗体纬度

窗体经度
longitude string

窗体经度

表单模块 ID
module_id string

表单模块 ID

窗体模块名称
module_name string

表单模块名称

表单阶段 ID
phase_id string

表单阶段 ID

窗体阶段名称
phase_name string

窗体阶段名称

窗体类别 ID
category_id string

窗体类别 ID

窗体类别名称
category_name string

窗体类别名称

表单删除日期
deleted_at string

表单删除日期

删除的窗体
deleted_by string

用户 ID 删除的表单

表单创建日期
client_created_at string

表单创建日期

表单更新日期
client_updated_at string

表单更新日期

表单 URL
web_url string

表单 URL

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

GetFormStatuses

名称 路径 类型 说明
状态
statuses array of StatusResponseWithoutLanguage

状态

计数
count integer

GetForms

名称 路径 类型 说明
模板列表
forms array of Form

模板列表

计数
count integer

GetGroup

名称 路径 类型 说明
群组标识符
id string

群组标识符

组名称
name string

组名称

GetGroups

名称 路径 类型 说明
Groups
groups array of GetGroup

Groups

计数
count integer
total_count
total_count integer
limit
limit integer
偏移
offset integer

GetLanguage

名称 路径 类型 说明
语言代码
code string

语言代码

语言说明
name string

语言说明

GetLanguages

名称 路径 类型 说明
语言列表
langs array of GetLanguage

语言列表

语言计数
count integer

语言计数

GetMembers

名称 路径 类型 说明
项目成员
project_members array of Member

项目成员

列表已完成
need_to_relaunch boolean

列表已完成

连续令牌
continuous_token string

用于获取下一项的令牌

项计数
count integer

项计数

项目总计计数
total_count integer

项目总计计数

GetModules

名称 路径 类型 说明
模块列表
modules array of Module

项目模块列表

need_to_relaunch
need_to_relaunch boolean
continuous_token
continuous_token string
偏移
offset string
计数
count integer

GetModulesCategories

名称 路径 类型 说明
类别
categories array of ModuleCategory

类别

计数
count integer

GetModulesForm

名称 路径 类型 说明
模块列表
modules array of ModuleForm

模块列表

列表已完成
need_to_relaunch boolean

列表已完成

连续令牌
continuous_token string

用于获取下一项的令牌

项计数
count integer

项计数

项目总计计数
total_count integer

项目总计计数

GetModulesOrgaSuggestion

名称 路径 类型 说明
建议
suggestions array of ModuleOrgaSuggestion

建议

计数
count integer
total_count
total_count integer
limit
limit integer
偏移
offset integer

GetObservationFull

名称 路径 类型 说明
观察 ID
id string

观察 ID

观察数字
legacy_id integer

观察数字

已启用观察
enabled boolean

已启用观察

观察项目 ID
project_id string

观察项目 ID

观察项目名称
project_name string

观察项目名称

观察组织 ID
organization_id string

观察组织 ID

观察组织名称
organization_name string

观察组织名称

观察说明
description string

观察说明

观察状态 ID
status_id string

观察状态 ID

观察状态名称
status_name string

观察状态名称

观察优先级 ID
priority_id string

观察优先级 ID

观察优先级名称
priority_name string

观察优先级名称

观察计划 ID
plan_id string

观察计划 ID

观察计划名称
plan_name string

观察计划名称

观察 X 位置
position_x decimal

观察 X 位置

观察 Y 位置
position_y decimal

观察 Y 位置

观察纬度
latitude decimal

观察纬度

观察经度
longitude decimal

观察经度

观察用户 ID
assignee_id string

观察分配的用户 ID

观察用户名
assignee_name string

观察分配的用户名

观察公司 ID
company_id string

观察分配的公司 ID

观察公司名称
company_name string

观察分配的公司名称

观察贸易 ID
trade_id string

观察贸易 ID

观察贸易名称
trade_name string

观察贸易名称

观察 commonobs ID
common_observation_id string

观察常见观察 ID

观察 commonobs 名称
common_observation_name string

观察常见观察名称

观察截止日期
due_date string

观察截止日期

观察模块 ID
module_id string

观察模块 ID

观察模块名称
module_name string

观察模块名称

deleted_at
deleted_at string
deleted_by
deleted_by string
观察阶段 ID
phase_id string

观察阶段 ID

观察阶段名称
phase_name string

观察阶段名称

观察图像
photos array of ObservationMediaResource

观察图像

观察创建日期
client_created_at string

观察创建日期

观察更新日期
client_updated_at string

观察更新日期

观察 URL
web_url string

观察 URL

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

GetPhases

名称 路径 类型 说明
阶段
phases array of Phase

阶段

列表已完成
need_to_relaunch boolean

列表已完成

连续令牌
continuous_token string

用于获取下一项的令牌

项计数
count integer

项计数

项目总计计数
total_count integer

项目总计计数

GetPriorities

名称 路径 类型 说明
优先 级
priorities array of Priority

优先 级

列表已完成
need_to_relaunch boolean

列表已完成

连续令牌
continuous_token string

用于获取下一项的令牌

项计数
count integer

项计数

项目总计计数
total_count integer

项目总计计数

GetProject

名称 路径 类型 说明
项目地址
address string

项目地址

项目时区
time_zone string

项目 IANA 时区

项目语言
language string

项目语言

项目标识
project_id string

项目标识

项目组织 ID
organization_id string

项目组织 ID

项目名称
name string

项目名称

项目案例
case_number string

项目案例

项目工作区 ID
workspace_id string

项目工作区 ID

项目说明
description string

项目说明

项目结束日期
end_date string

项目结束日期

项目成员计数
member_count integer

项目成员计数

项目已存档
is_archived boolean

项目已存档

media_resource
media_resource Media
项目中的当前用户
current_user_in_project boolean

项目中的当前用户是吗?

项目处于活动状态
is_active boolean

项目处于活动状态

项目状态
status string

项目状态

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

GetProjectRoles

名称 路径 类型 说明
project_roles
project_roles array of ProjectRole
计数
count integer
total_count
total_count integer
limit
limit integer
偏移
offset integer

GetProjects

名称 路径 类型 说明
项目列表
projects array of Project

项目列表

计数
count integer
total_count
total_count integer
limit
limit integer
偏移
offset integer

GetRole

名称 路径 类型 说明
角色 ID
id string

角色 ID

角色名称
name string

角色名称

角色说明
description string

角色说明

names
names LocalizedLabelFallback
描述
descriptions LocalizedLabelFallback
角色为默认值
is_default boolean

角色为默认值

is_default_invitation_role
is_default_invitation_role boolean
user_count
user_count integer
位置
position integer
authorization_role_id
authorization_role_id string
higher_role_id
higher_role_id string
is_lower_role
is_lower_role boolean

GetRoles

名称 路径 类型 说明
organization_roles
organization_roles array of GetRole

GetStatuses

名称 路径 类型 说明
状态
statuses array of StatusResponseWithoutFlow

状态

列表已完成
need_to_relaunch boolean

列表已完成

连续令牌
continuous_token string

用于获取下一项的令牌

项计数
count integer

项计数

项目总计计数
total_count integer

项目总计计数

GetTimeZones

名称 路径 类型 说明
时区列表
time_zones array of TimeZones

时区列表

计数
count integer
total_count
total_count integer
limit
limit integer
偏移
offset integer

GetTradesByModule

名称 路径 类型 说明
行业
trades array of ProjectTrade

行业

GetUserInfo

名称 路径 类型 说明
用户 ID
id string

用户 ID

用户名
first_name string

用户名

用户名
last_name string

用户名

用户电子邮件
email string

用户电子邮件

用户公司名称
company string

用户公司名称

处于活动状态
is_active string

处于活动状态

email_validated
email_validated string
用户创建日期
created_at string

用户创建日期

updated_at
updated_at string
deleted_at
deleted_at string
media_resource
media_resource Media
用户区域设置
locale string

用户区域设置

GetWorkspaceMembers

名称 路径 类型 说明
workspace_members
workspace_members array of OrgaMemberResponses
计数
count integer
total_count
total_count integer
limit
limit integer
偏移
offset integer

GetWorkspaces

名称 路径 类型 说明
工作区
workspaces array of Workspace

工作区

IconTypeParameters

LocalizedLabel

名称 路径 类型 说明
语言
language string
翻译
translation string

LocalizedLabelFallback

名称 路径 类型 说明
translation_fallback
translation_fallback string
翻译
translations array of LocalizedLabel

媒体

名称 路径 类型 说明
媒体 ID
id string

媒体 ID

媒体文件名
file_name string

媒体文件名

媒体 MIME 类型
mime_type string

媒体 MIME 类型

媒体创建日期
created_at string

媒体创建日期

MediaResourceUrl

名称 路径 类型 说明
媒体 URL
url string

媒体 URL

成员

名称 路径 类型 说明
成员 ID
user_id string

成员 ID

成员名字
first_name string

成员名字

成员姓氏
last_name string

成员姓氏

成员电子邮件
email string

成员电子邮件

成员角色 ID
project_role_id string

成员角色 ID

图片
picture Media
已启用成员
enabled boolean

已启用成员

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

模块

名称 路径 类型 说明
模块 ID
id string

模块 ID

project_id
project_id string
模块名称
name string

模块名称

模块显示顺序
order double

模块显示顺序

模块图标
icon string

模块图标

模块颜色
color string

模块颜色

模块类型
type string

模块类型

names
names array of LocalizedLabel
模块创建日期
created_at string

模块创建日期

模块更新日期
updated_at string

模块更新日期

已启用模块
enabled boolean

已启用模块

settings
settings ModuleSettings

ModuleCategory

名称 路径 类型 说明
类别 ID
id string

类别 ID

类别模块 ID
module_id string

类别模块 ID

类别容器 ID
container_id string

类别容器 ID

类别名称
name string

类别名称

父类别 ID
parent_id string

父类别 ID

类别创建日期
created_at string

类别创建日期

类别更新日期
updated_at string

类别更新日期

类别删除日期
deleted_at string

类别删除日期

已启用类别
enabled boolean

已启用类别

ModuleForm

名称 路径 类型 说明
模块 ID
id string

模块 ID

项目标识
project_id string

项目标识

模块名称
name string

模块名称

模块顺序
order double

模块显示顺序

模块图标
icon string

模块图标

模块颜色
color string

模块颜色

模块类型
type string

模块类型

names
names array of LocalizedLabel
模块创建日期
created_at string

模块设置

模块更新日期
updated_at string

模块设置

已启用模块
enabled boolean

模块设置

ModuleOrgaSuggestion

名称 路径 类型 说明
建议默认值
is_default boolean

建议默认值

建议名称
names array of LocalizedLabel

建议名称

id
id string
container_id
container_id string
container_type
container_type string
建议名称
name string

建议名称

图标
icon string
color
color string
建议类型
type string

建议类型

建议可见性
visibility string

建议可见性

创建时间
created_at string
updated_at
updated_at string

ModuleSettings

名称 路径 类型 说明
is_observation_library_mandatory
is_observation_library_mandatory boolean
is_description_mandatory
is_description_mandatory boolean
is_photo_mandatory
is_photo_mandatory boolean
is_company_mandatory
is_company_mandatory boolean
is_group_mandatory
is_group_mandatory boolean
due_date_days_offset
due_date_days_offset string

ObservationCommonObservation

名称 路径 类型 说明
CommonObs Id
id string

CommonObs Id

CommonObs 贸易 ID
trade_id string

CommonObs 贸易 ID

CommonObs 名称
name string

CommonObs 名称

CommonObs 名称
names array of LocalizedLabel

CommonObs 名称

CommonObs 已启用
enabled boolean

CommonObs 已启用

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

ObservationMediaResource

名称 路径 类型 说明
媒体 ID
id string

媒体 ID

媒体顺序
position string

媒体顺序

媒体 MIME 类型
mime_type string

媒体 MIME 类型

媒体文件名
file_name string

媒体文件名

OrgaMemberResponses

名称 路径 类型 说明
用户ID
user_id string
电子邮件
email string
first_name
first_name string
姓氏
last_name string
is_admin
is_admin boolean
is_pending
is_pending boolean
media_resource
media_resource Media

阶段

名称 路径 类型 说明
阶段 ID
id string

阶段 ID

阶段顺序
order double

阶段顺序

阶段名称
name string

阶段名称

阶段名称
names array of LocalizedLabel

阶段名称

已启用阶段
enabled boolean

已启用阶段

阶段创建日期
created_at string

阶段创建日期

阶段更新日期
updated_at string

阶段更新日期

阶段删除日期
deleted_at string

阶段删除日期

Priority

名称 路径 类型 说明
优先级 ID
id string

优先级 ID

优先级名称
name string

优先级名称

优先级顺序
position integer

优先级顺序

优先级颜色
color string

优先级颜色

图标
icon IconTypeParameters
优先级 ID
is_default boolean

优先级 ID

优先级为默认值
names array of LocalizedLabel

优先级为默认值

优先级已启用
enabled boolean

优先级已启用

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

项目

名称 路径 类型 说明
项目标识
project_id string

项目标识

项目组织 ID
organization_id string

项目组织 ID

项目名称
name string

项目名称

项目案例
case_number string

项目案例

项目工作区 ID
workspace_id string

项目工作区 ID

项目说明
description string

项目说明

项目结束日期
end_date string

项目结束日期

项目成员计数
member_count integer

项目成员计数

项目已存档
is_archived boolean

项目已存档

media_resource
media_resource Media
项目中的当前用户
current_user_in_project boolean

项目中的当前用户是吗?

项目处于活动状态
is_active boolean

项目处于活动状态

项目状态
status string

项目状态

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

ProjectRole

名称 路径 类型 说明
用户列表
user_ids array of string

用户列表

角色 ID
id string

角色 ID

角色名称
name string

角色名称

角色名称
names array of LocalizedLabel

角色名称

角色说明
descriptions array of LocalizedLabel

角色说明

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

ProjectTrade

名称 路径 类型 说明
贸易 ID
id string

交易 ID

已启用
enabled boolean

已启用

商品名
name string

商品名

贸易名称
names array of LocalizedLabel

贸易名称

模块 ID
module_id string

模块 ID

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

StatusResponseWithoutFlow

名称 路径 类型 说明
状态 ID
id string

状态 ID

状态名称
name string

状态名称

状态顺序
position integer

状态顺序

状态颜色
color string

状态颜色

状态为默认值
is_default boolean

状态为默认值

状态已启用
enabled boolean

状态已启用

状态名称
names array of LocalizedLabel

状态名称

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据

StatusResponseWithoutLanguage

名称 路径 类型 说明
状态 ID
id string

状态 ID

状态名称
name string

状态名称

状态顺序
position integer

状态顺序

状态颜色
color string

状态颜色

状态已启用
enabled boolean

状态已启用

TimeZones

名称 路径 类型 说明
时区 ID
id string

时区 ID

时区名称
display_name string

时区名称

时区标准名称
standard_name string

时区标准名称

时区 UTC 偏移量
utc_offset string

时区 UTC 偏移量

UploadChunkInit

名称 路径 类型 说明
上传过期延迟
expires_after_secs double

上传过期延迟

区块 ID
chunk_id string

区块 ID

媒体 ID
media_id string

媒体 ID

最小区块大小
min_chunk_size integer

最小区块大小

工作空间

名称 路径 类型 说明
工作区 ID
workspace_id string

工作区 ID

工作区名称
name string

工作区名称

工作区父 ID
parent_id string

工作区父 ID

工作区参考
client_reference string

工作区参考

media_resource
media_resource Media
工作区删除日期
deleted_by string

工作区删除日期

删除的工作区
deleted_at string

删除的工作区

创建日期
created_at string

创建日期

创建者
created_by string

创建者

更新日期
updated_at string

更新日期

更新者
updated_by string

更新依据