Finalcad One Connect 4.0 (預覽)
Finalcad One 是一個施工管理平台,旨在改善協作、追蹤進度並簡化現場操作。 使用此連接器,您可以將 Finalcad One 與數百個其他應用程式集成,以簡化專案追蹤、自動執行重複性任務並提高整體效率。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | 最終卡德 |
| URL | https://www.finalcad.com/contact |
| support@finalcad.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 最終卡德 |
| 網站 | https://developer.finalcad.com/ |
| 隱私策略 | https://www.finalcad.com/apps-privacy-policy |
| 類別 | 生產力 |
Fc1 連接器
先決條件
To use this connector, you need a Finalcad API key.
觸發器
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 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 取得時區清單 |
取得可用時區清單 |
| 取得語言種類 |
取得文件庫和項目的所有可用語言 |
| 媒體 - 中止區塊上傳 |
取消目前的區塊上傳程序,並捨棄任何收到的部分。 |
| 媒體 - 取得媒體資源 URL |
擷取存取媒體資源的 URL |
| 媒體 - 開始區塊上傳 |
啟動以區塊形式上傳媒體檔案的過程。 |
| 媒體 - 附加區塊部分 |
將個別區塊附加至進行中的媒體上傳工作階段。 |
| 媒體 - 驗證區塊上傳 |
確認已正確接收所有區塊,以確認並完成上傳。 |
| 專案 - 取得使用者 |
取得專案中的使用者 |
| 專案 - 取得公司 |
將公司納入您的專案 |
| 專案 - 取得專案詳細資料 |
取得指定專案的詳細資料 (時區、語言、更新日期,...) |
| 專案 - 取得文件或資料夾 |
取得文件或資料夾 |
| 專案 - 取得文件資料夾 |
取得專案中的文件資料夾 |
| 專案 - 取得方案或資料夾 |
取得專案中的計劃或資料夾 |
| 專案 - 取得表單優先順序 |
取得專案中的表單優先順序 |
| 專案 - 取得表單模組 |
取得指定專案的所有現有表單模組清單 |
| 專案 - 取得表單範本 |
取得表單範本 |
| 專案 - 取得表單詳細資料 |
取得指定表單的詳細資料 (描述、範本名稱、受指派人,...) |
| 專案 - 取得表單類別 |
取得表單類別 |
| 專案 - 取得觀察優先順序 |
取得專案中的觀察優先順序 |
| 專案 - 取得觀察模型 |
取得觀察模型(該類別以前稱為貿易) |
| 專案 - 取得觀察模組 |
取得指定專案的所有現有觀察模組清單 |
| 專案 - 取得觀察狀態 |
取得專案中的觀察狀態 |
| 專案 - 取得觀察類別 |
取得觀察類別(以前稱為交易) |
| 專案 - 取得角色 |
取得專案角色 |
| 專案 - 取得討論群組 |
取得專案中的討論群組 |
| 專案 - 取得階段 |
取得專案中的階段 |
| 專案 - 建立文件 |
專案 - 建立文件 |
| 專案 - 建立表單 |
建立表單 |
| 專案 - 建立觀察 |
建立觀察 |
| 專案 - 新增使用者 |
在專案中新增使用者 |
| 工作區 - 新增成員 |
將成員新增至工作區 |
| 組織 - 取得專案清單 |
取得指定組織中所有專案的清單 |
| 組織 - 取得工作區 |
取得與貴組織相關的工作區 |
| 組織 - 取得建議的模組 |
取得與您的組織相關的建議模組 |
| 組織 - 取得組織清單 |
取得您所屬的所有組織的清單 |
| 組織 - 取得表單狀態 |
取得範本中的表單狀態 |
| 組織 - 取得角色 |
取得組織角色 |
| 組織 - 取得連線的使用者 |
取得您的使用者資訊 |
| 組織 - 建立專案 |
建立專案 |
| 組織 - 新增成員 |
將成員新增至組織 |
| 設定 - 專案 |
設定專案組態 |
| 設定 - 語言和時區 |
設定語言和時區設定 |
| 項目 - 獲取觀察詳細信息 |
取得指定觀察的詳細資料 (描述、狀態、受指派人,...) |
取得時區清單
取得可用時區清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
最多可取回的時區數量。
|
limit | string |
最多可取回的時區數量。 |
|
|
N 時區。
|
offset | string |
N 時區。 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetTimeZones
取得語言種類
取得文件庫和項目的所有可用語言
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetLanguages
媒體 - 中止區塊上傳
取消目前的區塊上傳程序,並捨棄任何收到的部分。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
媒體 ID
|
mediaId | True | string |
媒體 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
區塊 ID
|
chunk_id | True | string |
區塊 ID |
傳回
- 身體
- Media
媒體 - 取得媒體資源 URL
擷取存取媒體資源的 URL
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
媒體 ID
|
mediaId | True | string |
媒體 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
媒體 - 開始區塊上傳
啟動以區塊形式上傳媒體檔案的過程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
媒體檔案名稱
|
file_name | True | string |
媒體檔案名稱 |
|
媒體總大小(位元組)
|
total_bytes | True | integer |
媒體總大小 (以位元組為單位) |
|
媒體 MD5
|
md5 | string |
媒體 MD5 |
傳回
媒體 - 附加區塊部分
將個別區塊附加至進行中的媒體上傳工作階段。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
媒體 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 |
媒體 - 驗證區塊上傳
確認已正確接收所有區塊,以確認並完成上傳。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
媒體 ID
|
mediaId | True | string |
媒體 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
區塊 ID
|
chunk_id | True | string |
區塊 ID |
傳回
- 身體
- Media
專案 - 取得使用者
取得專案中的使用者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續權杖
|
continuous_token | string |
連續權杖 |
|
|
最多可回收成員數量
|
limit | integer |
最多可回收成員數量 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetMembers
專案 - 取得公司
將公司納入您的專案
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續權杖
|
continuous_token | string |
連續權杖 |
|
|
最多可回收的公司數量
|
limit | integer |
最多可回收的公司數量 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetCompanies
專案 - 取得專案詳細資料
取得指定專案的詳細資料 (時區、語言、更新日期,...)
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetProject
專案 - 取得文件或資料夾
取得文件或資料夾
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
文件 ID
|
documentId | True | string |
文件 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- Document
專案 - 取得文件資料夾
取得專案中的文件資料夾
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
父資料夾 ID
|
parent_id | string |
父資料夾 ID |
|
|
Filter Content Type ÔÇÿfolder', 'documentÔÇÖ 或 nothing.
|
type | string |
Filter Content Type ÔÇÿfolder', 'documentÔÇÖ 或 nothing. |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得方案或資料夾
取得專案中的計劃或資料夾
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
資料夾 ID
|
folder_id | string |
資料夾 ID |
|
|
僅包含圖紙或資料夾
|
type | string |
僅包含圖紙或資料夾 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得表單優先順序
取得專案中的表單優先順序
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續權杖
|
continuous_token | string |
連續權杖 |
|
|
可取回的最高優先順序
|
limit | integer |
可取回的最高優先順序 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得表單模組
取得指定專案的所有現有表單模組清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續令牌
|
continuous_token | string |
連續令牌 |
|
|
最大可取回的模組數量
|
limit | integer |
最大可取回的模組數量 |
|
|
已刪除的包含
|
with_deleted | boolean |
已刪除的包含 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得表單範本
取得表單範本
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
模組 ID
|
module_id | string |
模組 ID |
|
|
類別標識碼
|
category_id | string |
類別標識碼 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetForms
專案 - 取得表單詳細資料
取得指定表單的詳細資料 (描述、範本名稱、受指派人,...)
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
表單 ID
|
formId | True | string |
表單 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetFormFull
專案 - 取得表單類別
取得表單類別
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
模組 ID
|
module_id | string |
模組 ID |
|
|
父類別 ID
|
category_id | string |
父類別 ID |
|
|
包括已停用
|
with_disabled | string |
包括已停用 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得觀察優先順序
取得專案中的觀察優先順序
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續權杖
|
continuous_token | string |
連續權杖 |
|
|
第N優先事項
|
offset | string |
第N優先事項 |
|
|
最大值 或 取回優先權
|
limit | integer |
最大值 或 取回優先權 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得觀察模型
取得觀察模型(該類別以前稱為貿易)
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
類別標識碼
|
tradeId | True | string |
類別標識碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得觀察模組
取得指定專案的所有現有觀察模組清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續令牌
|
continuous_token | string |
連續令牌 |
|
|
最大可檢索的模組數量
|
limit | integer |
最大可檢索的模組數量 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetModules
專案 - 取得觀察狀態
取得專案中的觀察狀態
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續權杖
|
continuous_token | string |
連續權杖 |
|
|
最多可取回的狀態數量
|
limit | integer |
最多可取回的狀態數量 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetStatuses
專案 - 取得觀察類別
取得觀察類別(以前稱為交易)
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
模組 ID
|
module_id | string |
模組 ID |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得角色
取得專案角色
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案ID
|
projectId | True | string |
專案ID |
|
可取得的最大專案角色數量
|
limit | string |
可取得的最大專案角色數量 |
|
|
第N個角色
|
offset | string |
第N個角色 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
專案 - 取得討論群組
取得專案中的討論群組
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
最多可取得的討論群組數量
|
limit | integer |
最多可取得的討論群組數量 |
|
|
第n個討論群組,我想從中取回討論群組
|
offset | integer |
第n個討論群組,我想從中取回討論群組 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetGroups
專案 - 取得階段
取得專案中的階段
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
連續令牌
|
continuous_token | string |
連續令牌 |
|
|
第N階段
|
offset | string |
第N階段 |
|
|
最大可回收相數
|
limit | integer |
最大可回收相數 |
|
|
已刪除的包含
|
with_deleted | boolean |
已刪除的包含 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetPhases
專案 - 建立文件
專案 - 建立文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
文件名稱
|
name | True | string |
文件名稱 |
|
文件父 ID
|
parent_id | string |
父資料夾的識別碼 |
|
|
文件媒體識別碼
|
media_id | string |
若欄位未被填入,將建立一個資料夾 |
傳回
專案 - 建立表單
建立表單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
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 |
表單名稱 |
|
表單類別識別碼
|
category_id | string |
表單類別識別碼 |
|
|
表單狀態識別碼
|
status_id | string |
表單狀態識別碼 |
|
|
公司識別表單
|
company_id | string |
表單指派的公司 ID |
|
|
表單受讓人識別碼
|
assignee_id | string |
表單指派使用者 ID |
|
|
表單計劃識別碼
|
plan_id | string |
表單計劃識別碼 |
|
|
表格 X 位置
|
position_x | decimal |
平面圖 0 與 1 之間的 X 表格 |
|
|
Form Y 位置
|
position_y | decimal |
平面圖中 Form Y 位置介於 0 與 1 之間 |
|
|
表單緯度
|
latitude | decimal |
表單緯度 |
|
|
形式經度
|
longitude | decimal |
形式經度 |
|
|
表單優先識別碼
|
priority_id | string |
表單優先順序 ID |
|
|
表格截止日期
|
due_date | string |
表格截止日期 |
|
|
表單階段識別碼
|
phase_id | string |
表單階段識別碼 |
|
|
表單 ID
|
id | string |
表單 ID |
傳回
專案 - 建立觀察
建立觀察
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
觀測艙識別碼
|
module_id | True | string |
觀察模組 ID |
|
觀測類別識別碼
|
trade_id | string |
這個類別過去稱為貿易 |
|
|
觀測模型識別碼
|
common_observation_id | string |
此模型過去稱為共同觀察 |
|
|
觀測描述
|
description | string |
觀察說明 |
|
|
觀測狀態識別碼
|
status_id | string |
觀察狀態 ID |
|
|
觀測連識別標誌
|
company_id | string |
觀察指派的公司 ID |
|
|
觀察指派者識別碼
|
assignee_id | string |
觀察指派的使用者 ID |
|
|
觀測計畫編號
|
plan_id | string |
觀察計劃 ID |
|
|
平面圖上的觀察X位置
|
position_x | decimal |
觀察 X 位置介於 0 與 1 之間 |
|
|
觀測Y在平面圖上的位置
|
position_y | decimal |
觀測 Y 位置介於 0 與 1 之間 |
|
|
觀測優先識別碼
|
priority_id | string |
觀察優先順序識別碼 |
|
|
觀察截止日期
|
due_date | string |
觀察截止日期 |
|
|
觀測階段識別
|
phase_id | string |
觀察階段 ID |
|
|
觀察討論群組ID
|
group_id | string |
該觀察應在創建時分享的討論群組 |
|
|
觀測緯度
|
latitude | decimal |
觀測緯度 |
|
|
觀測經度
|
longitude | decimal |
觀測經度 |
|
|
觀察 ID
|
id | string |
觀察 ID |
傳回
專案 - 新增使用者
在專案中新增使用者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
請勿寄送電子郵件給使用者
|
doNotSendEmail | boolean |
請勿寄送電子郵件給使用者 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
用戶電子郵件
|
True | string |
用戶電子郵件 |
|
|
使用者角色識別碼
|
project_role_id | True | string |
使用者角色識別碼 |
傳回
- 身體
- AddMembers
工作區 - 新增成員
將成員新增至工作區
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
工作區識別碼
|
workspaceId | True | string |
工作區識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
使用者識別碼
|
user_id | string |
使用者識別碼 |
|
|
用戶電子郵件
|
user_email | string |
用戶電子郵件 |
傳回
組織 - 取得專案清單
取得指定組織中所有專案的清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
工作區識別碼
|
workspace_id | string |
工作區識別碼 |
|
|
包含子工作區
|
with_workspace_children | boolean |
包含子工作區 |
|
|
搜尋字詞
|
search_term | string |
搜尋字詞 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetProjects
組織 - 取得工作區
取得與貴組織相關的工作區
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
父工作區 ID
|
parent_id | string |
父工作區 ID |
|
|
包括兒童
|
with_children | string |
包括兒童 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
組織 - 取得建議的模組
取得與您的組織相關的建議模組
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
工作區識別碼
|
workspace_id | string |
工作區識別碼 |
|
|
模組數量最大
|
limit | string |
模組數量最大 |
|
|
第N模組
|
offset | string |
第N模組 |
|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
組織 - 取得組織清單
取得您所屬的所有組織的清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
識別碼
|
id | string |
識別碼 |
|
名稱
|
name | string |
名稱 |
組織 - 取得表單狀態
取得範本中的表單狀態
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
表單範本 ID
|
formId | True | string |
表單範本 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
組織 - 取得角色
取得組織角色
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetRoles
組織 - 取得連線的使用者
取得您的使用者資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
- 身體
- GetUserInfo
組織 - 建立專案
建立專案
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
專案名稱
|
name | True | string |
專案名稱 |
|
專案工作區識別碼
|
workspace_id | string |
專案工作區識別碼 |
|
|
專案模組識別碼
|
module_ids | array of string |
專案模組識別碼 |
|
|
專案描述
|
description | string |
專案描述 |
|
|
專案語言
|
language | string |
專案語言 |
|
|
專案時區
|
time_zone | string |
專案時區 |
|
|
項目參考
|
case_number | string |
項目參考 |
|
|
項目地址
|
address | string |
項目地址 |
|
|
專案結束日期
|
end_date | string |
專案結束日期 |
傳回
組織 - 新增成員
將成員新增至組織
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
organizationId | True | string |
組織識別碼 |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
角色識別碼
|
role_id | string |
角色識別碼 |
|
|
用戶電子郵件
|
users_info | array of string |
使用者電子郵件 |
設定 - 專案
設定專案組態
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織識別碼
|
business_organization_id | string |
組織識別碼 |
|
|
專案識別碼
|
project_id | string |
專案識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
business_organization_id
|
business_organization_id | string | |
|
project_id
|
project_id | string |
設定 - 語言和時區
設定語言和時區設定
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
language | string |
語言 |
|
|
時區
|
timezone | string |
使用者的時區(以 IANA 格式) |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
語言
|
language | string | |
|
timezone
|
timezone | string |
項目 - 獲取觀察詳細信息
取得指定觀察的詳細資料 (描述、狀態、受指派人,...)
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | True | string |
專案識別碼 |
|
觀察 ID
|
observationId | True | string |
觀察 ID |
|
語言
|
Accept-Language | string |
語言 |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
傳回
觸發程序
| 觸發器 - 已建立觀察 |
建立觀察時觸發流程 |
| 觸發器 - 建立文件 |
建立文件時觸發流程 |
| 觸發器 - 建立表單 |
建立表單時觸發流程 |
| 觸發器 - 表單已更新 |
更新表單時觸發流程 |
| 觸發器 - 觀察已更新 |
更新觀察時觸發流程 |
觸發器 - 已建立觀察
建立觀察時觸發流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
組織識別碼 |
|
project_id
|
project_id | True | string |
專案識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
事件
|
event | integer |
事件 |
|
element_id
|
element_id | string |
element_id |
|
資料1
|
data1 | string |
資料1 |
|
資料2
|
data2 | string |
資料2 |
|
資料3
|
data3 | string |
資料3 |
觸發器 - 建立文件
建立文件時觸發流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
組織識別碼 |
|
project_id
|
project_id | True | string |
專案識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
事件
|
event | integer |
事件 |
|
element_id
|
element_id | string |
element_id |
|
資料1
|
data1 | string |
資料1 |
|
資料2
|
data2 | string |
資料2 |
|
資料3
|
data3 | string |
資料3 |
觸發器 - 建立表單
建立表單時觸發流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
組織識別碼 |
|
project_id
|
project_id | True | string |
專案識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
事件
|
event | integer |
事件 |
|
element_id
|
element_id | string |
element_id |
|
資料1
|
data1 | string |
資料1 |
|
資料2
|
data2 | string |
資料2 |
|
資料3
|
data3 | string |
資料3 |
觸發器 - 表單已更新
更新表單時觸發流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
組織識別碼 |
|
project_id
|
project_id | True | string |
專案識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
事件
|
event | integer |
事件 |
|
element_id
|
element_id | string |
element_id |
|
資料1
|
data1 | string |
資料1 |
|
資料2
|
data2 | string |
資料2 |
|
資料3
|
data3 | string |
資料3 |
觸發器 - 觀察已更新
更新觀察時觸發流程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
組織識別碼 |
|
project_id
|
project_id | True | string |
專案識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
事件
|
event | integer |
事件 |
|
element_id
|
element_id | string |
element_id |
|
資料1
|
data1 | string |
資料1 |
|
資料2
|
data2 | string |
資料2 |
|
資料3
|
data3 | string |
資料3 |
定義
新增成員
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者清單
|
project_roles | array of ProjectRole |
使用者清單 |
公司
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
公司編號
|
id | string |
公司編號 |
|
公司名稱
|
name | string |
公司名稱 |
|
公司已啟用
|
enabled | boolean |
公司已啟用 |
|
公司成員
|
user_ids | array of string |
公司成員 |
|
公司參考
|
reference | string |
公司參考 |
|
建立日期
|
created_at | string |
建立日期 |
|
由...創建
|
created_by | string |
由...創建 |
|
更新日期
|
updated_at | string |
更新日期 |
|
更新者
|
updated_by | string |
更新者 |
建立文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件 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 |
更新者 |
建立形式實例
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
表單 ID
|
id | string |
表單 ID |
|
表單名稱
|
name | string |
表單名稱 |
|
表單範本識別碼
|
form_id | string |
表單範本識別碼 |
|
表單狀態識別碼
|
status_id | string |
表單狀態識別碼 |
|
表單優先順序 ID
|
priority_id | string |
表單優先順序 ID |
|
表單計劃識別碼
|
plan_id | string |
表單計劃識別碼 |
|
表格 X 位置
|
position_x | decimal |
表格 X 位置 |
|
表格 Y 位置
|
position_y | decimal |
Form 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 |
|
表單階段識別碼
|
phase_id | string |
表單階段識別碼 |
|
表單類別識別碼
|
category_id | string |
表單類別識別碼 |
|
建立日期
|
created_at | string |
建立日期 |
|
由...創建
|
created_by | string |
由...創建 |
|
更新日期
|
updated_at | string |
更新日期 |
|
更新者
|
updated_by | string |
更新者 |
創建觀察
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
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 | decimal | |
|
經度
|
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 |
更新者 |
建立專案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
項目地址
|
address | string |
項目地址 |
|
專案時區
|
time_zone | string |
Project IANA 時區 |
|
專案語言
|
language | string |
專案語言 |
|
專案識別碼
|
project_id | string |
專案識別碼 |
|
專案組織識別碼
|
organization_id | string |
專案組織識別碼 |
|
專案名稱
|
name | string |
專案名稱 |
|
項目案例
|
case_number | string |
項目案例 |
|
專案工作區識別碼
|
workspace_id | string |
專案工作區識別碼 |
|
專案描述
|
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 |
更新者 |
文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件 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
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
資料夾內容 ID
|
id | string |
資料夾內容 ID |
|
資料夾內容類型
|
type | string |
資料夾內容類型 |
|
資料夾內容名稱
|
name | string |
資料夾內容名稱 |
|
資料夾內容順序
|
order | double |
資料夾內容順序 |
|
資料夾內容建立日期
|
created_at | string |
資料夾內容建立日期 |
|
資料夾內容更新日期
|
updated_at | string |
資料夾內容更新日期 |
|
資料夾內容來源
|
source | string |
資料夾內容來源 |
|
資料夾內容 foldersource
|
sources_contained | string |
資料夾內容 foldersource |
|
資料夾內容已啟用
|
enabled | boolean |
資料夾內容已啟用 |
Form
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
範本識別碼
|
id | string |
範本識別碼 |
|
範本名稱
|
name | string |
範本名稱 |
|
已啟用範本
|
enabled | boolean |
已啟用範本是/否 |
|
範本版本號碼
|
version | integer |
範本版本號碼 |
|
範本模組ID
|
module_id | string |
範本模組ID |
|
範本類別識別碼
|
category_id | string |
範本類別識別碼 |
|
範本建立日期
|
created_at | string |
範本建立日期 |
|
範本更新日期
|
updated_at | string |
範本更新日期 |
GetCommonObsByTrade
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
普通觀察
|
common_observations | array of ObservationCommonObservation |
普通觀察 |
獲取公司
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
公司
|
companies | array of Company |
公司 |
|
清單不完整
|
need_to_relaunch | boolean |
清單不完整 |
|
連續權杖
|
continuous_token | string |
獲得下一個物品的代幣 |
|
項目計數
|
count | integer |
項目計數 |
|
項目總計數
|
total_count | integer |
項目總計數 |
GetDocuments已篩選
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of Document | |
|
count
|
count | integer |
GetFolderContent
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
資料夾內容
|
contents | array of FolderContent |
資料夾內容 |
|
count
|
count | integer |
取得完整
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
表單 ID
|
id | string |
表單 ID |
|
表單編號
|
legacy_id | integer |
表單編號 |
|
已啟用表單
|
enabled | boolean |
已啟用表單 |
|
表單範本識別碼
|
form_id | string |
表單範本識別碼 |
|
組織識別碼
|
organization_id | string |
組織識別碼 |
|
組織名稱
|
organization_name | string |
組織名稱 |
|
專案編號
|
project_id | string |
專案識別碼 |
|
專案名稱
|
project_name | string |
專案名稱 |
|
表單說明
|
description | string |
表單說明 |
|
表單範本名稱
|
template_name | string |
表單範本名稱 |
|
表單狀態識別碼
|
status_id | string |
表單狀態識別碼 |
|
表單狀態名稱
|
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 |
表格截止日期 |
|
表單計劃識別碼
|
plan_id | string |
表單計劃識別碼 |
|
表單計劃名稱
|
plan_name | string |
表單計劃名稱 |
|
表格 X 倉位
|
position_x | string |
表格 X 位置 |
|
Form Y 位置
|
position_y | string |
Form Y 位置 |
|
表單緯度
|
latitude | string |
表單緯度 |
|
形式經度
|
longitude | string |
形式經度 |
|
表單模組識別碼
|
module_id | string |
表單模組ID |
|
表單模組名稱
|
module_name | string |
表單模組名稱 |
|
表單階段識別碼
|
phase_id | string |
表單階段識別碼 |
|
表單階段名稱
|
phase_name | string |
表單階段名稱 |
|
表單類別識別碼
|
category_id | string |
表單類別識別碼 |
|
表單類別名稱
|
category_name | string |
表單類別名稱 |
|
表單刪除日期
|
deleted_at | string |
表單刪除日期 |
|
表單已刪除
|
deleted_by | string |
由使用者 ID 刪除的表單 |
|
表單建立日期
|
client_created_at | string |
表單建立日期 |
|
表單更新日期
|
client_updated_at | string |
表單更新日期 |
|
表單網址
|
web_url | string |
表單網址 |
|
建立日期
|
created_at | string |
建立日期 |
|
由...創建
|
created_by | string |
由...創建 |
|
更新日期
|
updated_at | string |
更新日期 |
|
更新者
|
updated_by | string |
更新者 |
GetForm狀態
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態
|
statuses | array of StatusResponseWithoutLanguage |
狀態 |
|
count
|
count | integer |
取得表格
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
模板列表
|
forms | array of Form |
模板列表 |
|
count
|
count | integer |
GetGroup
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
群組識別碼
|
id | string |
群組識別碼 |
|
群組名稱
|
name | string |
群組名稱 |
Get群組
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Groups
|
groups | array of GetGroup |
Groups |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
位移
|
offset | integer |
GetLanguage
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
語言代碼
|
code | string |
語言代碼 |
|
語言說明
|
name | string |
語言說明 |
取得語言
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
語言清單
|
langs | array of GetLanguage |
語言清單 |
|
語言很重要
|
count | integer |
語言很重要 |
獲取會員
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
專案成員
|
project_members | array of Member |
專案成員 |
|
清單不完整
|
need_to_relaunch | boolean |
清單不完整 |
|
連續權杖
|
continuous_token | string |
獲得下一個物品的代幣 |
|
項目計數
|
count | integer |
項目計數 |
|
項目總計數
|
total_count | integer |
項目總計數 |
Get模組
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
模組清單
|
modules | array of Module |
專案模組清單 |
|
need_to_relaunch
|
need_to_relaunch | boolean | |
|
continuous_token
|
continuous_token | string | |
|
位移
|
offset | string | |
|
count
|
count | integer |
GetModules類別
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類別
|
categories | array of ModuleCategory |
類別 |
|
count
|
count | integer |
GetModulesForm
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
模組清單
|
modules | array of ModuleForm |
模組清單 |
|
清單不完整
|
need_to_relaunch | boolean |
清單不完整 |
|
連續權杖
|
continuous_token | string |
獲得下一個物品的代幣 |
|
項目計數
|
count | integer |
項目計數 |
|
項目總計數
|
total_count | integer |
項目總計數 |
GetModulesOrga建議
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Suggestions
|
suggestions | array of ModuleOrgaSuggestion |
Suggestions |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
位移
|
offset | integer |
獲取觀察滿
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
觀察 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 |
觀察狀態名稱 |
|
觀察優先順序識別碼
|
priority_id | string |
觀察優先順序識別碼 |
|
觀察優先順序名稱
|
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 |
|
觀測常見名稱
|
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 |
觀測更新日期 |
|
觀察網址
|
web_url | string |
觀察網址 |
|
建立日期
|
created_at | string |
建立日期 |
|
由...創建
|
created_by | string |
由...創建 |
|
更新日期
|
updated_at | string |
更新日期 |
|
更新者
|
updated_by | string |
更新者 |
GetPhases
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
階段
|
phases | array of Phase |
階段 |
|
清單不完整
|
need_to_relaunch | boolean |
清單不完整 |
|
連續權杖
|
continuous_token | string |
獲得下一個物品的代幣 |
|
項目計數
|
count | integer |
項目計數 |
|
項目總計數
|
total_count | integer |
項目總計數 |
取得優先順序
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
優先順序
|
priorities | array of Priority |
優先順序 |
|
清單不完整
|
need_to_relaunch | boolean |
清單不完整 |
|
連續權杖
|
continuous_token | string |
獲得下一個物品的代幣 |
|
項目計數
|
count | integer |
項目計數 |
|
項目總計數
|
total_count | integer |
項目總計數 |
取得專案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
項目地址
|
address | string |
項目地址 |
|
專案時區
|
time_zone | string |
Project IANA 時區 |
|
專案語言
|
language | string |
專案語言 |
|
專案識別碼
|
project_id | string |
專案識別碼 |
|
專案組織識別碼
|
organization_id | string |
專案組織識別碼 |
|
專案名稱
|
name | string |
專案名稱 |
|
項目案例
|
case_number | string |
項目案例 |
|
專案工作區識別碼
|
workspace_id | string |
專案工作區識別碼 |
|
專案描述
|
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
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
project_roles
|
project_roles | array of ProjectRole | |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
位移
|
offset | integer |
取得專案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
專案清單
|
projects | array of Project |
項目列表 |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
位移
|
offset | integer |
GetRole
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
角色識別碼
|
id | string |
角色識別碼 |
|
角色名稱
|
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
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
organization_roles
|
organization_roles | array of GetRole |
取得狀態
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態
|
statuses | array of StatusResponseWithoutFlow |
狀態 |
|
清單不完整
|
need_to_relaunch | boolean |
清單不完整 |
|
連續權杖
|
continuous_token | string |
獲得下一個物品的代幣 |
|
項目計數
|
count | integer |
項目計數 |
|
項目總計數
|
total_count | integer |
項目總計數 |
取得時區
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時區清單
|
time_zones | array of TimeZones |
時區清單 |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
位移
|
offset | integer |
GetTradesBy模組
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
行業
|
trades | array of ProjectTrade |
行業 |
取得使用者資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者識別碼
|
id | string |
使用者識別碼 |
|
使用者名字
|
first_name | string |
使用者名字 |
|
使用者姓氏
|
last_name | string |
使用者姓氏 |
|
使用者電子郵件
|
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 |
使用者地區設定 |
GetWorkspace成員
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
workspace_members
|
workspace_members | array of OrgaMemberResponses | |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
位移
|
offset | integer |
GetWorkspaces
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
工作區
|
workspaces | array of Workspace |
工作區 |
IconType參數
本地化標籤
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
語言
|
language | string | |
|
平移
|
translation | string |
本地化標籤後援
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
translation_fallback
|
translation_fallback | string | |
|
翻譯
|
translations | array of LocalizedLabel |
媒體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
媒體 ID
|
id | string |
媒體 ID |
|
媒體檔案名稱
|
file_name | string |
媒體檔案名稱 |
|
媒體 MIME 類型
|
mime_type | string |
媒體 MIME 類型 |
|
媒體建立日期
|
created_at | string |
媒體建立日期 |
MediaResourceUrl
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
媒體網址
|
url | string |
媒體網址 |
會員
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
會員編號
|
user_id | string |
會員編號 |
|
成員名字
|
first_name | string |
成員名字 |
|
成員姓氏
|
last_name | string |
成員姓氏 |
|
會員電子郵件
|
string |
會員電子郵件 |
|
|
成員角色識別碼
|
project_role_id | string |
成員角色識別碼 |
|
圖片
|
picture | Media | |
|
成員已啟用
|
enabled | boolean |
成員已啟用 |
|
建立日期
|
created_at | string |
建立日期 |
|
由...創建
|
created_by | string |
由...創建 |
|
更新日期
|
updated_at | string |
更新日期 |
|
更新者
|
updated_by | string |
更新者 |
模組
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
模組 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 | ModuleSettings |
模組類別
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類別標識碼
|
id | string |
類別標識碼 |
|
類別模組識別碼
|
module_id | string |
類別模組識別碼 |
|
類別容器識別碼
|
container_id | string |
類別容器識別碼 |
|
類別名稱
|
name | string |
類別名稱 |
|
父類別 ID
|
parent_id | string |
父類別 ID |
|
類別建立日期
|
created_at | string |
類別建立日期 |
|
類別更新日期
|
updated_at | string |
類別更新日期 |
|
類別刪除日期
|
deleted_at | string |
類別刪除日期 |
|
已啟用類別
|
enabled | boolean |
已啟用類別 |
模組形式
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
模組 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 |
模組設定 |
模組Orga建議
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
建議預設值
|
is_default | boolean |
建議預設值 |
|
建議名稱
|
names | array of LocalizedLabel |
建議名稱 |
|
識別碼
|
id | string | |
|
container_id
|
container_id | string | |
|
container_type
|
container_type | string | |
|
建議名稱
|
name | string |
建議名稱 |
|
icon
|
icon | string | |
|
color
|
color | string | |
|
建議類型
|
type | string |
建議類型 |
|
建議可見度
|
visibility | string |
建議可見度 |
|
建立於
|
created_at | string | |
|
updated_at
|
updated_at | string |
模組設定
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
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 |
觀察共同觀察
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
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 |
更新者 |
觀察媒體資源
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
媒體 ID
|
id | string |
媒體 ID |
|
媒體順序
|
position | string |
媒體順序 |
|
媒體 MIME 類型
|
mime_type | string |
媒體 MIME 類型 |
|
媒體檔案名稱
|
file_name | string |
媒體檔案名稱 |
OrgaMember回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
用戶識別碼
|
user_id | string | |
|
電子郵件
|
string | ||
|
first_name
|
first_name | string | |
|
姓氏
|
last_name | string | |
|
is_admin
|
is_admin | boolean | |
|
is_pending
|
is_pending | boolean | |
|
media_resource
|
media_resource | Media |
Phase
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
階段 ID
|
id | string |
階段 ID |
|
階段順序
|
order | double |
階段順序 |
|
階段名稱
|
name | string |
階段名稱 |
|
階段名稱
|
names | array of LocalizedLabel |
階段名稱 |
|
階段已啟用
|
enabled | boolean |
階段已啟用 |
|
階段建立日期
|
created_at | string |
階段建立日期 |
|
階段更新日期
|
updated_at | string |
階段更新日期 |
|
階段刪除日期
|
deleted_at | string |
階段刪除日期 |
Priority
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
優先順序 ID
|
id | string |
優先順序 ID |
|
優先順序名稱
|
name | string |
優先順序名稱 |
|
優先順序
|
position | integer |
優先順序 |
|
優先顏色
|
color | string |
優先顏色 |
|
icon
|
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 |
更新者 |
專案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
專案識別碼
|
project_id | string |
專案識別碼 |
|
專案組織識別碼
|
organization_id | string |
專案組織識別碼 |
|
專案名稱
|
name | string |
專案名稱 |
|
項目案例
|
case_number | string |
項目案例 |
|
專案工作區識別碼
|
workspace_id | string |
專案工作區識別碼 |
|
專案描述
|
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 |
更新者 |
專案角色
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者清單
|
user_ids | array of string |
使用者清單 |
|
角色識別碼
|
id | string |
角色識別碼 |
|
角色名稱
|
name | string |
角色名稱 |
|
角色名稱
|
names | array of LocalizedLabel |
角色名稱 |
|
角色描述
|
descriptions | array of LocalizedLabel |
角色描述 |
|
建立日期
|
created_at | string |
建立日期 |
|
由...創建
|
created_by | string |
由...創建 |
|
更新日期
|
updated_at | string |
更新日期 |
|
更新者
|
updated_by | string |
更新者 |
項目貿易
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
行業編號
|
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 |
更新者 |
狀態回應無流程
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態識別碼
|
id | string |
狀態識別碼 |
|
狀態名稱
|
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 |
更新者 |
狀態回應無語言
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態識別碼
|
id | string |
狀態識別碼 |
|
狀態名稱
|
name | string |
狀態名稱 |
|
狀態順序
|
position | integer |
狀態順序 |
|
狀態顏色
|
color | string |
狀態顏色 |
|
狀態已啟用
|
enabled | boolean |
狀態已啟用 |
TimeZones
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時區 ID
|
id | string |
時區 ID |
|
時區名稱
|
display_name | string |
時區名稱 |
|
時區標準名稱
|
standard_name | string |
時區標準名稱 |
|
時區 UTC 偏移
|
utc_offset | string |
時區 UTC 偏移 |
上傳ChunkInit
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
上傳到期延遲
|
expires_after_secs | double |
上傳到期延遲 |
|
區塊 ID
|
chunk_id | string |
區塊 ID |
|
媒體 ID
|
media_id | string |
媒體 ID |
|
區塊大小下限
|
min_chunk_size | integer |
區塊大小下限 |
工作空間
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
工作區識別碼
|
workspace_id | string |
工作區識別碼 |
|
工作區名稱
|
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 |
更新者 |