共用方式為


Morta (預覽版)

Morta API 是以 REST 為基礎。 我們的 API 接受 json 編碼的請求主體並返回 JSON 編碼的回應。 我們使用標準的 HTTP 回應、身份驗證和動詞。 所有 API 要求都必須具有以下格式的授權標頭:{ 'Authorization': 'Bearer <API_KEY>' }

此連接器適用於以下產品和區域:

服務 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://morta.io
Email support@morta.io
連接器中繼資料
Publisher 莫爾塔
網站 https://morta.io
隱私策略 https://morta.io/termsofservice
類別 生產力;內容和文件

Morta 提供基於雲端的解決方案,與您習慣的軟體深度集成,使您能夠有效地數位化、連接和自動化追蹤流程。 Morta 連接器可讓您透過 Microsoft Power Automate 平台與所有 Morta 功能互動。

先決條件

若要使用此連接器,您需要一個 Morta 帳戶

如何取得認證

登錄您的 Morta 帳戶,導航到您的 Morta 集成 ,然後只需添加一個新的 API 密鑰。 然後,您可以在 Microsoft Power Automate 中使用此 API 金鑰。 在 Microsoft Power Automate Platform 上輸入 API 金鑰時,請務必在前面加上「持有人」,以便您輸入的 API 金鑰如下所示:「持有人YOUR_API_KEY_HERE」

開始使用連接器

要開始使用連接器,您可以先從 Morta 平台提取您最喜歡的項目/工作區。 若要這樣做,您可以使用「GetFavouriteProjects」動作。

在此之後,您可以使用「CreateProcess」操作和以下參數在 Morta 上建立流程/文件:

  • 名稱:新建進程
  • 項目編號: <one_of_your_project_public_ids>
  • 類型:自訂

已知問題與限制

None

常見錯誤和補救措施

使用 Morta 連接器時,使用者可能會遇到下列其中一個 HTTP 狀態碼:

  • 401:請求動作未獲授權。 這可能是因為您沒有輸入 API 金鑰,或輸入的 API 金鑰有誤(例如,沒有在複製的 API 金鑰前新增「持有人」)
  • 403:您無法存取所請求的 Morta 資源。 請務必向該資源的擁有者要求所要求資源的許可。
  • 404:莫爾塔資源不存在。 請登入Morta平台,確保您輸入的ID正確無誤。
  • 422:請求中的資料遺失或格式不正確。 請確定您已閱讀請求中所需所有資料的說明,並遵循規範。 例如,您可能需要輸入數字作為欄位,但已輸入字串。
  • 429:一段時間內向莫塔發送了太多請求。 確保您每秒向 Morta 平台發送的請求不超過 10 個。

FAQ

問題:為什麼我的 Morta API 金鑰不起作用? 答:確保您已在 API 金鑰的開頭新增「Bearer」(「Bearer」一詞和空格)。 輸入的最終 API 金鑰應如下所示 (此處使用虛擬 API 金鑰) :「持有者 zSujSa_eXxd3b1yVtTQVMw7Ghn18Ja9sOWvj-O4C908」

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 securestring MotaWord 連接的 API 密鑰

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

下載圖表圖片

根據特定表格視圖中的資料下載圖表的影像檔案。

串流檢視的所有資料列

串流特定表格檢視的所有資料列的資料。

串流資料表的所有資料列

串流特定資料表的所有資料列的資料。

切換專案的收藏狀態

變更專案是否為目前登入使用者的最愛

切換專案的釘選狀態

變更專案是否為目前登入的使用者釘選

刪除 API 金鑰

刪除目前登入使用者的 API 金鑰

刪除單一通知

按識別碼刪除特定通知。

刪除專案

刪除由其UUID識別的特定專案

刪除專案密碼

從專案中刪除特定密碼

刪除專案邀請

刪除專案邀請

刪除流程區段

刪除特定程序區段。

刪除特定資料列

根據資料列 ID 從資料表檢視中刪除特定資料列。

刪除處理程序回應

刪除特定程序回應。

刪除表格列

從表格中刪除所有列或特定列。

刪除表格欄

從表格中刪除特定欄。

刪除表格的檢視

刪除資料表的特定檢視。

刪除表格聯結

從資料表中刪除聯結。

刪除註解

刪除註解討論串中的特定註解

刪除評論線程

刪除註解討論串

刪除資料表

依其 UUID 刪除指定的表格。

刪除資源的許可權

刪除特定資源 (例如資料表、資料表檢視或程序) 的許可權。

刪除進程

刪除由其 UUID 識別的處理程序

刪除頂端專案標題樣式

刪除特定專案的頂端標題樣式

匯出流程

通過其UUID將特定程序導出為不同的格式(PDF或DOCX)

取得使用者專案

取得目前登入使用者所屬的所有專案

取得使用者成就

透過使用者的 Firebase ID 取得使用者的成就徽章

取得使用者擁有和管理的專案

取得使用者為擁有者或系統管理員的所有專案

取得使用者的釘選專案

讓由 Firebase ID 識別的使用者固定專案

取得使用者範本

取得目前登入使用者有權存取的所有範本

取得受邀專案成員

擷取指定專案的所有受邀成員

取得實際資料表檢視資料

擷取特定表格檢視的實際資料。

取得專案中已刪除的資料表

從特定專案擷取所有已刪除的資料表,由其 UUID 識別。 只有專案擁有者才能存取。

取得專案成員

擷取與指定專案相關聯的所有成員

取得專案標籤

擷取與指定專案相關聯的所有標籤

取得專案的已傳送通知

擷取指定專案的所有已傳送通知

取得專案的通知

擷取與特定專案相關聯的所有通知。 此端點僅供具有專案擁有者層級權限的使用者存取。

取得專案秘密

擷取指定專案的所有秘密

取得專案變數

擷取與指定專案相關聯的所有變數

取得專案資料表

擷取與特定專案相關聯的資料表,由其UUID識別

取得專案資源

擷取與其 UUID 所識別之特定專案相關聯的資源

取得專案資訊

擷取其 UUID 所識別之特定專案的詳細資訊

取得已刪除的進程區段

擷取特定程序的所有已刪除區段,並針對特定程序區段使用選用篩選器

取得我的詳細資料

取得目前使用者的資訊

取得所有支援的事件類型清單

擷取通知所有支援的事件類型的清單。

取得所有表格聯結

擷取與資料表相關聯的所有聯結。

取得檢視的圖表資料

擷取資料以根據特定表格檢視產生圖表。

取得流程區段

擷取特定程序區段。

取得流程詳細資料

透過其 UUID 擷取特定進程的詳細資訊

取得特定使用者詳細資料

取得特定使用者的相關資訊

取得表格儲存格的檔案

擷取與表格中特定儲存格相關聯的檔案。

取得表格列

根據提供的查詢參數從資料表擷取資料列。

取得表格及其資料列

根據提供的參數擷取資料表及其資料列

取得表格的所有檢視

擷取與特定資料表相關聯的所有檢視。

取得表格資料行的統計資料

擷取特定表格檢視中資料行的統計資料。

取得表格資料行統計資料

根據指定的參數擷取資料表資料行的統計資料。

取得資料行的唯一值

擷取表格檢視中特定資料行的唯一/相異值。

取得資料行的唯一值

擷取資料表中指定資料行的不同 (唯一) 值清單。

取得資料表的單一檢視

依資料表的識別碼擷取特定檢視。

取得資料表資料行

擷取特定資料表的所有作用中資料行。

取得資源權限

擷取指定資源的許可權,例如資料表、資料表檢視或程序。

取得資源的所有事件

擷取與特定資源相關聯的所有事件,並依各種條件進行篩選。

在專案中搜尋

在特定專案內執行搜尋作業,由其 UUID 識別

在表格欄上建立索引

在資料表的一或多個資料行上建立索引,以改善查詢效能。

將列新增至表格

將新列新增至指定的表格。

將標籤新增至使用者

將標籤新增至特定使用者

將檢視設定為預設檢視

將特定表格視圖指定為表格的預設視圖。

將檢視資料下載為 csv 檔案

以 CSV 格式下載特定表格檢視的資料。

將表格資料下載為 CSV

將指定表格的資料下載為 CSV 檔案。

將資料列新增至表格結尾

在指定表格視圖的結尾插入新列。

將資料行新增至檢視

將新欄新增至特定表格檢視。

建立來源系統的傳遞要求

對外部來源系統進行傳遞 API 呼叫。

建立傳遞下載請求

對外部來源系統進行傳遞 API 呼叫以下載檔案。

建立多個新流程區段

在指定的程序中建立多個新區段,每個區段都有一個選用的父區段

建立新使用者

建立新使用者

建立新專案

使用指定的名稱建立新專案

建立新流程

在指定的專案中建立新流程

建立新流程區段

在指定的程序中建立新區段,並可選擇設定父區段

建立新流程區段

在流程中建立多個新區段

建立新的專案密碼

為指定的專案建立新的密碼

建立新的專案標題樣式

為特定專案建立新的標題樣式

建立新的文件表格

在專案中建立新的文件表格。

建立新的流程回應

為流程區段建立新的回應。

建立新的註解討論串

建立新的註解討論串

建立新註解

在特定註解討論串中建立新註解

建立新通知

為特定專案建立新通知。

建立表格欄

將新資料行新增至現有資料表。

建立表格的新檢視

為特定資料表建立新檢視。

建立表格聯結

在兩個資料表之間建立聯結。

建立資源的許可權

建立特定資源 (例如資料表、資料表檢視或程序) 的許可。

從使用者中刪除標籤

刪除特定使用者的標籤

從專案中刪除使用者

從特定專案中移除使用者 (由專案的 UUID 和使用者的 Firebase ID 識別)

從表格中刪除所有列

從指定的表格中刪除所有資料列。

從表格中刪除整合

從表格中移除特定整合。

從輸入預覽產生的資料列

預覽特定表格視圖中給定輸入的結果列。

提交流程回應

提交程序回應,將其標示為已完成。

提交流程回應草稿

提交流程回應的草稿以供稍後完成。

搜尋使用者

依專案或程序搜尋使用者

擷取專案中已刪除的程序

取得與特定專案相關聯的所有已刪除進程,由其UUID識別

擷取專案內的程序

取得與特定專案相關聯的所有進程,由其 UUID 識別

新增或更新表格中的列

根據指定的資料行更新插入 (新增或更新) 表格檢視中的資料列。

更新 API 金鑰

更新目前登入使用者的 API 金鑰

更新使用者帳戶

更新目前登入使用者的帳戶詳細資料

更新單一通知

依特定通知的識別碼更新。

更新多個流程區段

更新多個現有的流程區段。

更新專案密碼

更新專案中的特定秘密

更新專案標題樣式

更新特定專案的標題樣式

更新專案邀請

更新專案中的現有邀請

更新流程區段順序

更新程序內程序區段的順序。

更新現有專案

依專案識別碼更新現有專案的詳細資料

更新現有流程區段

依流程區段識別碼更新現有流程區段的詳細資料

更新現有流程回應

更新程序區段的現有回應。

更新現有的表格儲存格

更新表格檢視中的特定儲存格。

更新現有程序

依程序識別碼更新現有程序的詳細資料

更新現有資料列

更新指定表格檢視中的現有列。

更新現有資料表

更新現有資料表的屬性。

更新目前使用者設定檔

更新目前登入使用者的設定檔

更新程序回應者

更新其 UUID 所識別之指定程式的回應者清單

更新表格中的現有列

更新指定表格中的現有資料列。

更新表格儲存格

更新表格中的特定儲存格。

更新表格欄

更新資料表中特定資料行的屬性。

更新表格的檢視

更新特定資料表的現有檢視。

更新表格聯結

更新資料表上的現有聯結。

更新視圖中的欄

更新表格檢視中的特定欄。

更新評論

更新註解討論串中的特定註解

更新資源的許可權

更新特定資源 (例如資料表、資料表檢視或程序) 的許可權。

檢查檢視欄是否用於

擷取使用特定資料表資料行的所有檢視。

檢查處理程序表格用於

檢查並傳回處理程序、表格聯結的清單,並選取指定表格的使用位置。

為使用者建立 API 金鑰

為目前登入的使用者建立 API 金鑰

獲取用戶最喜歡的項目

獲取當前登錄用戶所屬的所有最喜歡的項目

獲取用戶的公共項目

取得使用者所屬的所有公用專案

獲取用戶的公開貢獻

取得使用者的公開貢獻 (由使用者的 Firebase ID 識別)

獲取用戶貢獻

取得使用者每天的貢獻次數 (由使用者的 Firebase ID 識別)

獲取評論線程

依識別碼擷取特定註解討論串

獲取評論線程統計

根據參照類型和主要參照 ID 擷取註解執行緒的統計資料

與整合同步表

將資料表與指定的整合同步。

表格中的更新插入列

根據唯一的資料行值,在指定資料表中新增或更新資料列。

複製專案

建立現有專案的副本

複製程序

複製現有流程,可能在不同的專案中

複製表格

建立現有資料表的副本及其資料、設定和選擇性的連結資料表。

複製表格的檢視

為特定表格建立現有檢視的副本。

複製表格的預設檢視

建立特定資料表預設檢視的副本。

複製進程區段

複製特定流程區段。

複製進程區段

以非同步方式複製特定程序區段。

要求資源的許可權

要求特定資源 (例如資料表、資料表檢視或程序) 的許可權。

解決註解線程

解決註解討論串

變更使用者在專案中的角色

變更使用者在特定專案中的角色 (由專案的 UUID 和使用者的 Firebase ID 識別)

通過公共 ID 獲取標籤

依其公用 ID 擷取標籤。

通過公共 ID 獲取用戶詳細信息

透過公用 ID 取得特定使用者的資訊

通過引用獲取評論線程

擷取與特定參考相關聯的所有註解討論串

邀請使用者加入專案

透過電子郵件邀請單一使用者加入專案。 如果使用者已經存在,則會直接新增;否則,會傳送邀請。 需要擁有者或管理員權限。

邀請多個使用者加入專案

透過電子郵件邀請多個使用者加入專案。 如果使用者已存在,則會直接新增使用者,否則會傳送邀請。 需要擁有者或管理員權限。

還原專案

還原先前已刪除的特定專案 (由其 UUID 識別)

還原已刪除的資料表

使用先前刪除的資料表的 UUID 還原。

還原程序

還原其 UUID 所識別的已刪除程序

還原程序區段

還原先前刪除的進程區段。

還原程序回應

還原先前刪除的處理程序回應。

還原表格欄

還原資料表中先前刪除的資料行。

重新傳送專案邀請給使用者

重新傳送專案邀請給使用者。 這適用於新使用者和先前受邀的現有使用者。 需要擁有者或管理員權限。

重新開啟評論討論串

重新開啟先前解決的註解討論串

重複進程

將現有程序複製到不同的專案中

重設處理程序回應

將現有的處理程序回應重設為其初始狀態。

下載圖表圖片

根據特定表格視圖中的資料下載圖表的影像檔案。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

產生圖表影像之表格檢視的 UUID。

圖表類型
chart_type string

正在產生影像的圖表類型。

顯示圖例
show_legend boolean

旗標,以指出是否要在圖表影像中包含圖例。

顯示值
show_values boolean

旗標,指出是否要在圖表影像中包含值。

資料行值識別碼
column_value_id uuid

用作圖表影像值來源的資料行的UUID。

資料行標籤標識符
column_label_id uuid

用作圖表影像標籤來源的資料行的UUID。

傳回

response
binary

串流檢視的所有資料列

串流特定表格檢視的所有資料列的資料。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要求資料串流之表格檢視的 UUID。

Filter
filter string

要套用至串流資料的篩選器。

排序
sort string

串流資料的排序參數。

進程識別碼
process_id uuid

用於過濾資料的進程的選用 UUID。

頁面
page integer

分頁的頁碼

大小
size integer

每頁分頁的項目數

傳回

response
binary

串流資料表的所有資料列

串流特定資料表的所有資料列的資料。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要從中串流資料列的資料表的 UUID。

Filter
filter string

要套用至串流資料的篩選器。

排序
sort string

串流資料的排序參數。

頁面
page integer

分頁的頁碼

大小
size integer

每頁分頁的項目數

傳回

response
binary

切換專案的收藏狀態

變更專案是否為目前登入使用者的最愛

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

專案的公開 ID 以切換我的最愛狀態

傳回

名稱 路徑 類型 Description
資料
data array of object
已刪除
data.isDeleted boolean

指出專案是否已刪除

名稱
data.name string

項目的名稱

專案角色
data.projectRole string

使用者在專案中的角色

publicId
data.publicId uuid

專案的公開 ID

中繼資料
metadata object

其他中繼資料

切換專案的釘選狀態

變更專案是否為目前登入的使用者釘選

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

專案的公開 ID 以切換釘選狀態

傳回

名稱 路徑 類型 Description
資料
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

其他中繼資料

刪除 API 金鑰

刪除目前登入使用者的 API 金鑰

參數

名稱 機碼 必要 類型 Description
API 金鑰 ID
api_key_id True uuid

要刪除的API金鑰的UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

其他中繼資料

刪除單一通知

按識別碼刪除特定通知。

參數

名稱 機碼 必要 類型 Description
Id
id True uuid

要刪除之通知的 UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除專案

刪除由其UUID識別的特定專案

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要刪除的專案的UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除專案密碼

從專案中刪除特定密碼

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

將從中刪除密碼的專案的UUID

秘密 ID
secret_id True uuid

要刪除的密碼的UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除專案邀請

刪除專案邀請

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要從中刪除邀請之專案的UUID

邀請標識碼
invite_id True uuid

要刪除的邀請的UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除流程區段

刪除特定程序區段。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

要刪除的流程區段的UUID。

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

刪除特定資料列

根據資料列 ID 從資料表檢視中刪除特定資料列。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要從中刪除列的表格檢視的 UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除處理程序回應

刪除特定程序回應。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

處理程序回應標識符
process_response_id True uuid

要刪除的處理程序回應的 UUID。

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

刪除表格列

從表格中刪除所有列或特定列。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要從中刪除列的資料表的 UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除表格欄

從表格中刪除特定欄。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

包含資料行的資料表的 UUID

資料行識別碼
column_id True uuid

要刪除的資料行的UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除表格的檢視

刪除資料表的特定檢視。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要刪除之表格檢視的 UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除表格聯結

從資料表中刪除聯結。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

將從中刪除聯結的資料表的 UUID。

加入ID
join_id True uuid

要刪除的聯結的UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除註解

刪除註解討論串中的特定註解

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

包含註解之註解執行緒的UUID

註解 ID
comment_id True uuid

要刪除的註解的UUID

傳回

名稱 路徑 類型 Description
資料
data Comment
change
metadata.change object

對註解所做的變更

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

已刪除註解的UUID

刪除評論線程

刪除註解討論串

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

要刪除的註解線程的UUID

傳回

名稱 路徑 類型 Description
資料
data CommentThread
change
metadata.change object

對評論線程所做的更改

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

已刪除評論線程的 UUID

刪除資料表

依其 UUID 刪除指定的表格。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要刪除的資料表的 UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

刪除資源的許可權

刪除特定資源 (例如資料表、資料表檢視或程序) 的許可權。

參數

名稱 機碼 必要 類型 Description
Id
id True uuid

要刪除的原則的UUID。

刪除進程

刪除由其 UUID 識別的處理程序

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

要刪除的程序的UUID

傳回

名稱 路徑 類型 Description
資料
data MortaProcess
中繼資料
metadata object

刪除頂端專案標題樣式

刪除特定專案的頂端標題樣式

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要刪除頂端標題樣式的專案UUID

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

匯出流程

通過其UUID將特定程序導出為不同的格式(PDF或DOCX)

參數

名稱 機碼 必要 類型 Description
進程識別碼
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

取得使用者專案

取得目前登入使用者所屬的所有專案

傳回

名稱 路徑 類型 Description
資料
data array of HomeProject
中繼資料
metadata object

其他中繼資料

取得使用者成就

透過使用者的 Firebase ID 取得使用者的成就徽章

參數

名稱 機碼 必要 類型 Description
Firebase Id
firebase_id True string

要擷取成就的使用者的 Firebase ID

傳回

名稱 路徑 類型 Description
createdProcesses
data.createdProcesses integer

使用者建立的處理程序數

createdTables
data.createdTables integer

使用者建立的資料表數目

中繼資料
metadata object

中繼資料物件

取得使用者擁有和管理的專案

取得使用者為擁有者或系統管理員的所有專案

傳回

名稱 路徑 類型 Description
資料
data array of HomeProject
中繼資料
metadata object

其他中繼資料

取得使用者的釘選專案

讓由 Firebase ID 識別的使用者固定專案

參數

名稱 機碼 必要 類型 Description
Firebase Id
firebase_id True string

要擷取固定專案的使用者的 Firebase ID

傳回

名稱 路徑 類型 Description
資料
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

中繼資料物件

取得使用者範本

取得目前登入使用者有權存取的所有範本

傳回

名稱 路徑 類型 Description
資料
data array of object
由...創建
data.createdBy SummaryUser
中繼資料
metadata object

取得受邀專案成員

擷取指定專案的所有受邀成員

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取受邀成員之專案的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of InvitedMember
中繼資料
metadata object

取得實際資料表檢視資料

擷取特定表格檢視的實際資料。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要擷取資料之表格檢視的 UUID。

Filter
filter string

要套用至資料擷取的篩選器。

排序
sort string

資料擷取的排序參數。

頁面
page integer

分頁的頁碼。

大小
size integer

每頁用於分頁的項目數。

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
next_page_token
metadata.next_page_token string
size
metadata.size integer
總計
metadata.total integer

取得專案中已刪除的資料表

從特定專案擷取所有已刪除的資料表,由其 UUID 識別。 只有專案擁有者才能存取。

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取已刪除表格之專案的UUID

傳回

名稱 路徑 類型 Description
資料
data array of Table
中繼資料
metadata object

取得專案成員

擷取與指定專案相關聯的所有成員

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取其成員之專案的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of ProjectListWithUserTags
中繼資料
metadata object

取得專案標籤

擷取與指定專案相關聯的所有標籤

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取標籤之專案的UUID

傳回

名稱 路徑 類型 Description
資料
data array of object
細胞
data.cells array of object
名稱
data.cells.column.name string
publicId
data.cells.column.publicId uuid
識別碼
data.cells.id string
value
data.cells.value string
名稱
data.name string
publicId
data.publicId uuid
中繼資料
metadata object

取得專案的已傳送通知

擷取指定專案的所有已傳送通知

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取已傳送通知之專案的UUID

頁面
page integer

通知執行的頁碼

大小
size integer

每頁的通知執行次數

通知標識碼
notification_id uuid

特定通知的UUID,以篩選執行

傳回

名稱 路徑 類型 Description
資料
data array of NotificationExecution
中繼資料
metadata object

取得專案的通知

擷取與特定專案相關聯的所有通知。 此端點僅供具有專案擁有者層級權限的使用者存取。

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取通知之專案的UUID

傳回

名稱 路徑 類型 Description
資料
data array of Notification
中繼資料
metadata object

取得專案秘密

擷取指定專案的所有秘密

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取密碼之專案的UUID

傳回

名稱 路徑 類型 Description
資料
data array of ProjectSecret
中繼資料
metadata object

取得專案變數

擷取與指定專案相關聯的所有變數

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取變數之專案的UUID

傳回

名稱 路徑 類型 Description
資料
data array of object
細胞
data.cells array of object
名稱
data.cells.column.name string
publicId
data.cells.column.publicId uuid
識別碼
data.cells.id string
value
data.cells.value string
名稱
data.name string
publicId
data.publicId uuid
中繼資料
metadata object

取得專案資料表

擷取與特定專案相關聯的資料表,由其UUID識別

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取資料表之專案的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of Table
中繼資料
metadata object

取得專案資源

擷取與其 UUID 所識別之特定專案相關聯的資源

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取其資源之專案的 UUID

admin檢視
adminView boolean
excludeProcesses
excludeProcesses boolean
exclude表格
excludeTables boolean
僅刪除
onlyDeleted boolean
專案權限
projectPermissions boolean
類型Id
typeId string

傳回

名稱 路徑 類型 Description
資料
data array of object
名稱
data.name string

資源名稱

流程
data.process PermissionedProcess
表格
data.table SimpleDocumentTable
型別
data.type string

資源類型 (處理程序或資料表)

中繼資料
metadata object

取得專案資訊

擷取其 UUID 所識別之特定專案的詳細資訊

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取之專案的UUID

傳回

名稱 路徑 類型 Description
資料夾
data.folders array of object
child資料夾
data.folders.childFolders array of object
名稱
data.folders.childFolders.name string
名稱
data.folders.name string
projectDetails
data.projectDetails SimpleProject
角色
data.role string

使用者在專案中的角色

中繼資料
metadata object

取得已刪除的進程區段

擷取特定程序的所有已刪除區段,並針對特定程序區段使用選用篩選器

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

從中擷取已刪除區段的程式UUID

處理區段識別碼
process_section_id uuid

特定程序區段的選用UUID,以篩選已刪除的區段

傳回

取得我的詳細資料

取得目前使用者的資訊

傳回

名稱 路徑 類型 Description
資料
data User
中繼資料
metadata object

中繼資料物件

取得所有支援的事件類型清單

擷取通知所有支援的事件類型的清單。

傳回

名稱 路徑 類型 Description
資料
data array of string
中繼資料
metadata object

取得所有表格聯結

擷取與資料表相關聯的所有聯結。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要擷取聯結之表格的 UUID。

傳回

名稱 路徑 類型 Description
資料
data array of TableJoin
中繼資料
metadata object

取得檢視的圖表資料

擷取資料以根據特定表格檢視產生圖表。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要求圖表資料之表格檢視的 UUID。

圖表類型
chart_type string

擷取資料的圖表類型。

顯示圖例
show_legend boolean

旗標,以指出是否要在圖表中顯示圖例。

顯示值
show_values boolean

旗標以指出是否要在圖表中顯示值。

資料行值識別碼
column_value_id uuid

要用作圖表值來源的欄的UUID。

資料行標籤標識符
column_label_id uuid

要用作圖表標籤來源的欄的UUID。

傳回

名稱 路徑 類型 Description
資料
data array of object
items
data object
中繼資料
metadata object

取得流程區段

擷取特定程序區段。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

主要父區段
main_parent_section boolean

擷取進程區段的主要父區段的旗標

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

取得流程詳細資料

透過其 UUID 擷取特定進程的詳細資訊

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

要擷取的處理程序的UUID

排除兒童
exclude_children boolean

旗標,以從程序回應中排除子元素

傳回

名稱 路徑 類型 Description
資料
data MortaProcess
中繼資料
metadata object

取得特定使用者詳細資料

取得特定使用者的相關資訊

參數

名稱 機碼 必要 類型 Description
Firebase Id
firebase_id True string

要擷取的使用者的 Firebase ID

傳回

名稱 路徑 類型 Description
資料
data User
中繼資料
metadata object

中繼資料物件

取得表格儲存格的檔案

擷取與表格中特定儲存格相關聯的檔案。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

包含檔案的資料表的UUID。

資料行識別碼
column_id True uuid

包含儲存格之欄的UUID。

檔名
filename True string

要擷取的檔案名稱。

傳回

response
binary

取得表格列

根據提供的查詢參數從資料表擷取資料列。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要從中擷取列的資料表的 UUID

頁面
page integer

分頁的頁碼

大小
size integer

每頁分頁的項目數

排序
sort string

表格列的排序準則

Filter
filter string

表格列的篩選條件

最後更新時間
last_updated_at date-time

篩選在此日期之後更新的資料列

上次建立時間
last_created_at date-time

篩選在此日期之後建立的資料列

下一頁代幣
next_page_token string

用於擷取下一頁結果的權杖

Columns
columns array

要包含在回應中的特定資料行

相異資料行
distinct_columns array

要套用不同篩選的欄

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
next_page_token
metadata.next_page_token string
頁面
metadata.page integer
size
metadata.size integer
總計
metadata.total integer

取得表格及其資料列

根據提供的參數擷取資料表及其資料列

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要擷取的資料表的UUID

頁面
page integer

分頁的頁碼

大小
size integer

每頁分頁的項目數

排序
sort string

表格列的排序準則

Filter
filter string

表格列的篩選條件

最後更新時間
last_updated_at date-time

篩選在此日期之後更新的資料列

上次建立時間
last_created_at date-time

篩選在此日期之後建立的資料列

下一頁代幣
next_page_token string

用於擷取下一頁結果的權杖

Columns
columns array

要包含在回應中的特定資料行

相異資料行
distinct_columns array

要套用不同篩選的欄

傳回

名稱 路徑 類型 Description
資料
data Table
頁面
metadata.page integer

目前頁碼

size
metadata.size integer

每頁項目數

總計
metadata.total integer

表格中的列總數

取得表格的所有檢視

擷取與特定資料表相關聯的所有檢視。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要擷取其檢視之表格的 UUID。

忽略欄
ignore_columns boolean

旗標,指出是否要忽略回應中的資料行資料。

傳回

名稱 路徑 類型 Description
資料
data array of TableView
中繼資料
metadata object

取得表格資料行的統計資料

擷取特定表格檢視中資料行的統計資料。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要擷取統計資料之表格檢視的 UUID。

Filter
filter string

要套用至統計資料擷取的篩選器。

總和、平均值、最大值、最小值、計數
sum, avg, max, min, count array

指定要執行總和、平均值、最大值、最小值或計數作業的欄。

進程識別碼
process_id uuid

用於過濾資料的進程的選用 UUID。

傳回

名稱 路徑 類型 Description
資料
data array of TableColumnWithAggregation
中繼資料
metadata object

取得表格資料行統計資料

根據指定的參數擷取資料表資料行的統計資料。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要擷取統計資料之表格的 UUID

Aggregation
aggregation string

要套用至資料行的彙總函式

Filter
filter string

資料行的篩選條件

傳回

名稱 路徑 類型 Description
資料
data array of TableColumnWithAggregation
中繼資料
metadata object

取得資料行的唯一值

擷取表格檢視中特定資料行的唯一/相異值。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

資料表檢視的 UUID。

資料行識別碼
column_id True uuid

要擷取其相異值之直欄的 UUID。

Filter
filter string

要套用至資料擷取的篩選器。

群組欄
group_columns array

選擇性資料行,可將相異值分組。

傳回

名稱 路徑 類型 Description
資料
data array of string
中繼資料
metadata object

取得資料行的唯一值

擷取資料表中指定資料行的不同 (唯一) 值清單。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

包含資料行的資料表的 UUID

資料行識別碼
column_id True uuid

要擷取相異值之資料行的 UUID

Filter
filter string

篩選相異值的準則

群組欄
group_columns array

指定分組值的直欄

傳回

名稱 路徑 類型 Description
資料
data array of string
中繼資料
metadata object

取得資料表的單一檢視

依資料表的識別碼擷取特定檢視。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要擷取之表格檢視的 UUID。

忽略快取選項
ignore_cached_options boolean

旗標,指出是否要忽略回應中快取的選項。

傳回

名稱 路徑 類型 Description
資料
data TableViewWithTable
中繼資料
metadata object

取得資料表資料行

擷取特定資料表的所有作用中資料行。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要擷取其資料行的資料表的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of TableColumn
中繼資料
metadata object

取得資源權限

擷取指定資源的許可權,例如資料表、資料表檢視或程序。

參數

名稱 機碼 必要 類型 Description
Resource
resource True string

要擷取權限的資源類型。 有效選項為 'process'、'table' 或 'table_view'。

資源標識碼
resource_id True uuid

要擷取權限之資源的UUID。

傳回

名稱 路徑 類型 Description
資料
data array of AccessPolicy
中繼資料
metadata object

取得資源的所有事件

擷取與特定資源相關聯的所有事件,並依各種條件進行篩選。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resource_id True uuid

要擷取事件之資源的 UUID。

類型
type True string

資源的類型 (例如,使用者、程序、資料表、專案)。

頁面
page integer

分頁的頁碼。

User
user uuid

使用者的選用UUID,用於篩選事件。

動詞
verb array

用於過濾事件的可選動詞清單。

開始日期
start_date date-time

選擇性開始日期,以篩選事件。

結束日期
end_date date-time

選擇性結束日期以篩選事件。

搜尋
search string

選擇性搜尋字詞,以篩選事件。

傳回

名稱 路徑 類型 Description
資料
data array of Event
中繼資料
metadata object

在專案中搜尋

在特定專案內執行搜尋作業,由其 UUID 識別

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要執行搜尋之專案的 UUID

搜尋
search True string

搜尋查詢字串

處理公用標識碼
process_public_id uuid

進程的選用UUID,以限制特定進程內的搜尋

傳回

名稱 路徑 類型 Description
資料
data Answer
中繼資料
metadata object

在表格欄上建立索引

在資料表的一或多個資料行上建立索引,以改善查詢效能。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要為其建立索引的資料表的 UUID。

publicId
publicId True uuid

傳回

名稱 路徑 類型 Description
資料
data array of TableColumn
中繼資料
metadata object

將列新增至表格

將新列新增至指定的表格。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
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 True object
排序順序
sortOrder number

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

將標籤新增至使用者

將標籤新增至特定使用者

參數

名稱 機碼 必要 類型 Description
使用者 ID
user_id True uuid

要新增標籤的使用者的公用UUID

tagReferenceId
tagReferenceId True string

傳回

名稱 路徑 類型 Description
資料
data Tag
中繼資料
metadata object

其他中繼資料

將檢視設定為預設檢視

將特定表格視圖指定為表格的預設視圖。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要設定為預設值的資料表檢視的 UUID。

傳回

名稱 路徑 類型 Description
資料
data TableView
中繼資料
metadata object

將檢視資料下載為 csv 檔案

以 CSV 格式下載特定表格檢視的資料。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要下載為CSV的表格檢視的UUID。

Filter
filter string

要套用至 CSV 資料的篩選器。

排序
sort string

CSV 資料的排序參數。

進程識別碼
process_id uuid

用於過濾資料的進程的選用 UUID。

傳回

response
binary

將表格資料下載為 CSV

將指定表格的資料下載為 CSV 檔案。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要從中下載資料的資料表的UUID

排序
sort string

表格列的排序準則

Filter
filter string

表格列的篩選條件

傳回

response
binary

將資料列新增至表格結尾

在指定表格視圖的結尾插入新列。

參數

名稱 機碼 必要 類型 Description
檢視標識符
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 True object
排序順序
sortOrder number

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

將資料行新增至檢視

將新欄新增至特定表格檢視。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要新增資料行之表格檢視的 UUID。

aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
硬驗證
hardValidation boolean
is索引
isIndexed boolean
已加入
isJoined boolean
類型
kind string
手動選項
manualOptions array of string
表格選項
tableOptions
已鎖定
locked True boolean
morta同步
mortaSynced integer
名稱
name True string
procore同步
procoreSynced integer
publicId
publicId uuid
required
required True boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
排序順序
sortOrder True number
字串驗證
stringValidation string
千分隔符
thousandSeparator boolean
驗證訊息
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNo重複項
validationNoDuplicates boolean
視點同步
viewpointSynced integer
寬度
width integer

傳回

名稱 路徑 類型 Description
資料
data TableViewColumn
中繼資料
metadata object

建立來源系統的傳遞要求

對外部來源系統進行傳遞 API 呼叫。

參數

名稱 機碼 必要 類型 Description
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
資料
data
headers
headers
方法
method True string
onBehalfUserId
onBehalfUserId uuid
路徑
path True string
來源系統
sourceSystem True string

傳回

名稱 路徑 類型 Description
資料
data IntegrationsPassthroughResponse
中繼資料
metadata object

建立傳遞下載請求

對外部來源系統進行傳遞 API 呼叫以下載檔案。

參數

名稱 機碼 必要 類型 Description
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
資料
data
headers
headers
方法
method True string
onBehalfUserId
onBehalfUserId uuid
路徑
path True string
來源系統
sourceSystem True string

傳回

response
binary

建立多個新流程區段

在指定的程序中建立多個新區段,每個區段都有一個選用的父區段

參數

名稱 機碼 必要 類型 Description
進程識別碼
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 string

傳回

名稱 路徑 類型 Description
資料
data string
資源標識碼
metadata.resourceIds array of string

新建立程序區段的UUID清單

建立新使用者

建立新使用者

參數

名稱 機碼 必要 類型 Description
電子郵件
email True email
名稱
name True string
密碼
password True string
projectId
projectId uuid

傳回

名稱 路徑 類型 Description
資料
data User
中繼資料
metadata object

建立新專案

使用指定的名稱建立新專案

參數

名稱 機碼 必要 類型 Description
名稱
name True string

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

建立新流程

在指定的專案中建立新流程

參數

名稱 機碼 必要 類型 Description
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
名稱
name True string
projectId
projectId True uuid
型別
type True string

傳回

名稱 路徑 類型 Description
資料
data Process
change
metadata.change object

在建立程序期間所做的變更

事件
metadata.event string

事件類型,例如 'process.created'

resourceId
metadata.resourceId uuid

新建立進程的UUID

建立新流程區段

在指定的程序中建立新區段,並可選擇設定父區段

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
描述
description
名稱
name True string
parentId
parentId uuid
純文字說明
plaintextDescription string

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

建立新流程區段

在流程中建立多個新區段

參數

名稱 機碼 必要 類型 Description
進程識別碼
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 string

傳回

名稱 路徑 類型 Description
資料
data array of MortaProcessSection
中繼資料
metadata object

建立新的專案密碼

為指定的專案建立新的密碼

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

將建立密碼的專案的UUID

名稱
name True string
value
value True string

傳回

名稱 路徑 類型 Description
資料
data ProjectSecret
中繼資料
metadata object

建立新的專案標題樣式

為特定專案建立新的標題樣式

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要建立標題樣式的專案的UUID

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

建立新的文件表格

在專案中建立新的文件表格。

參數

名稱 機碼 必要 類型 Description
aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
is索引
isIndexed boolean
已加入
isJoined boolean
類型
kind string
手動選項
manualOptions array of string
表格選項
tableOptions
morta同步
mortaSynced integer
名稱
name True string
procore同步
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
千分隔符
thousandSeparator boolean
視點同步
viewpointSynced integer
寬度
width integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string
isOneToMany
isOneToMany boolean
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string
joinTableName
joinTableName string
joinViewId
joinViewId string
joinView名稱
joinViewName string
名稱
name True string
projectId
projectId True uuid
型別
type string

傳回

名稱 路徑 類型 Description
資料
data Table
中繼資料
metadata object

建立新的流程回應

為流程區段建立新的回應。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
型別
type string

傳回

名稱 路徑 類型 Description
資料
data ProcessResponse
中繼資料
metadata object

建立新的註解討論串

建立新的註解討論串

參數

名稱 機碼 必要 類型 Description
評論文字
commentText True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
mainReferenceId
mainReferenceId uuid
參考標識符
referenceId True uuid
referenceType
referenceType True string

傳回

名稱 路徑 類型 Description
資料
data CommentThread
change
metadata.change object

在此作業中所做的變更

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

新建立的註解討論串的UUID

建立新註解

在特定註解討論串中建立新註解

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

要新增註解之註解討論串的UUID

評論文字
commentText True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid

傳回

名稱 路徑 類型 Description
資料
data Comment
change
metadata.change object

在此作業中所做的變更

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

新建立註解的UUID

建立新通知

為特定專案建立新通知。

參數

名稱 機碼 必要 類型 Description
描述
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

傳回

名稱 路徑 類型 Description
資料
data Notification
中繼資料
metadata object

建立表格欄

將新資料行新增至現有資料表。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

將新增資料行之資料表的UUID

aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
is索引
isIndexed boolean
類型
kind string
手動選項
manualOptions array of string
表格選項
tableOptions
morta同步
mortaSynced integer
名稱
name True string
procore同步
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
千分隔符
thousandSeparator boolean
視點同步
viewpointSynced integer
寬度
width integer

傳回

名稱 路徑 類型 Description
資料
data TableColumn
中繼資料
metadata object

建立表格的新檢視

為特定資料表建立新檢視。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要為其建立檢視之表格的 UUID。

允許貢獻者刪除
allowContributorDelete boolean
圖表設定
chartSettings
collapsedGroupView
collapsedGroupView boolean
背景顏色
backgroundColour True string
columnId
columnId uuid
columnName
columnName True string
filterType (過濾器類型)
filterType True string
fontColour
fontColour True string
multiple值
multipleValues array of
value
value
columnId
columnId uuid
columnName
columnName True string
描述
description
已鎖定
locked boolean
required
required boolean
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
描述
description
禁用新行
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
columnId
columnId uuid
columnName
columnName True string
filterType (過濾器類型)
filterType True string
multiple值
multipleValues array of
或群組
orGroup string
value
value
冷凍索引
frozenIndex integer
columnId
columnId uuid
columnName
columnName True string
方向
direction True string
includeAllColumns
includeAllColumns boolean
isDefault
isDefault boolean
名稱
name True string
列高度
rowHeight integer
columnId
columnId uuid
columnName
columnName True string
方向
direction True string
型別
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

傳回

名稱 路徑 類型 Description
資料
data TableView
中繼資料
metadata object

建立表格聯結

在兩個資料表之間建立聯結。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要建立聯結的資料表的UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
資料欄
dataColumns array of string
isOneToMany
isOneToMany boolean
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string
joinViewId
joinViewId string

傳回

名稱 路徑 類型 Description
資料
data Table
中繼資料
metadata object

建立資源的許可權

建立特定資源 (例如資料表、資料表檢視或程序) 的許可。

參數

名稱 機碼 必要 類型 Description
屬性標識
attributeId uuid
屬性種類
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

傳回

名稱 路徑 類型 Description
資料
data AccessPolicy
中繼資料
metadata object

從使用者中刪除標籤

刪除特定使用者的標籤

參數

名稱 機碼 必要 類型 Description
使用者 ID
user_id True uuid

要從中刪除標籤的使用者的公用UUID

標籤 ID
tag_id True uuid

要刪除的標籤的公用UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

從專案中刪除使用者

從特定專案中移除使用者 (由專案的 UUID 和使用者的 Firebase ID 識別)

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

專案的 UUID

Firebase Id
firebase_id True string

要移除之使用者的 Firebase ID

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

從表格中刪除所有列

從指定的表格中刪除所有資料列。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要從中刪除所有列的表格的 UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

從表格中刪除整合

從表格中移除特定整合。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

將從中移除整合的資料表的UUID。

整合名稱
integration_name True string

要移除的整合名稱。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

從輸入預覽產生的資料列

預覽特定表格視圖中給定輸入的結果列。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

產生列預覽之表格檢視的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
行數據
rowData True object

傳回

名稱 路徑 類型 Description
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

提交流程回應

提交程序回應,將其標示為已完成。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

處理程序回應標識符
process_response_id True uuid

要提交的流程回應的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
response
response

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

提交流程回應草稿

提交流程回應的草稿以供稍後完成。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

處理程序回應標識符
process_response_id True uuid

要提交為草稿的流程回應的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
response
response

傳回

名稱 路徑 類型 Description
資料
data ProcessSection
中繼資料
metadata object

搜尋使用者

依專案或程序搜尋使用者

參數

名稱 機碼 必要 類型 Description
專案編號
project_id uuid

限制搜尋的專案 ID

進程識別碼
process_id uuid

限制搜尋的處理程序 ID

資料表檢視識別碼
table_view_id uuid

限制搜尋的表格檢視識別碼

Query
query True string

搜尋使用者的查詢字串

傳回

名稱 路徑 類型 Description
資料
data array of SummaryUser
中繼資料
metadata object

其他中繼資料

擷取專案中已刪除的程序

取得與特定專案相關聯的所有已刪除進程,由其UUID識別

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取已刪除程序之專案的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of SimpleProcess
中繼資料
metadata object

擷取專案內的程序

取得與特定專案相關聯的所有進程,由其 UUID 識別

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要擷取其處理程序之專案的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of SimpleProcess
中繼資料
metadata object

新增或更新表格中的列

根據指定的資料行更新插入 (新增或更新) 表格檢視中的資料列。

參數

名稱 機碼 必要 類型 Description
檢視標識符
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 True object
排序順序
sortOrder number
upsertColumnName
upsertColumnName True string

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

更新 API 金鑰

更新目前登入使用者的 API 金鑰

參數

名稱 機碼 必要 類型 Description
API 金鑰 ID
api_key_id True uuid

要更新的API金鑰的UUID

名稱
name string

傳回

名稱 路徑 類型 Description
apiKey
apiKey string

更新的 API 金鑰詳細資料

更新使用者帳戶

更新目前登入使用者的帳戶詳細資料

參數

名稱 機碼 必要 類型 Description
舊密碼
oldPassword True string
密碼
password True string
密碼確認
passwordConfirm True string
twoFactor代碼
twoFactorCode string

傳回

名稱 路徑 類型 Description
資料
data UserWithToken
中繼資料
metadata object

更新單一通知

依特定通知的識別碼更新。

參數

名稱 機碼 必要 類型 Description
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

傳回

名稱 路徑 類型 Description
資料
data Notification
中繼資料
metadata object

更新多個流程區段

更新多個現有的流程區段。

參數

名稱 機碼 必要 類型 Description
進程識別碼
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
pageBreak之前
pageBreakBefore boolean
pdf包含說明
pdfIncludeDescription boolean
pdfInclude區段
pdfIncludeSection boolean
純文字說明
plaintextDescription string
publicId
publicId True uuid

傳回

名稱 路徑 類型 Description
資料
data array of MortaProcessSection
中繼資料
metadata object

更新專案密碼

更新專案中的特定秘密

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

秘密所在專案的UUID

秘密 ID
secret_id True uuid

要更新的密碼的UUID

名稱
name True string
value
value True string

傳回

名稱 路徑 類型 Description
資料
data ProjectSecret
中繼資料
metadata object

更新專案標題樣式

更新特定專案的標題樣式

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要更新標題樣式的專案 UUID

樣式識別碼
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 integer
開始時間0
startAt0 boolean
下劃線
underline boolean

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

更新專案邀請

更新專案中的現有邀請

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

邀請所在專案的UUID

邀請標識碼
invite_id True uuid

要更新的邀請的UUID

tags
tags array of string

傳回

名稱 路徑 類型 Description
資料
data InvitedMember
中繼資料
metadata object

更新流程區段順序

更新程序內程序區段的順序。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
parentId
parentId uuid
位置
position integer
區段標識符
sectionId uuid

傳回

名稱 路徑 類型 Description
資料
data MortaProcess
中繼資料
metadata object

更新現有專案

依專案識別碼更新現有專案的詳細資料

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要更新之專案的 UUID

defaultProcessId
defaultProcessId uuid
隱藏程序已建立
hideProcessCreated boolean
標誌
logo string
mfa必填
mfaRequired boolean
名稱
name string
primaryColour
primaryColour string
processTitleBold
processTitleBold boolean
processTitleColour
processTitleColour string
processTitleFontSize
processTitleFontSize number
processTitle斜體
processTitleItalic boolean
processTitle底線
processTitleUnderline boolean
公眾
public boolean

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

更新現有流程區段

依流程區段識別碼更新現有流程區段的詳細資料

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

要更新的程式區段的UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
描述
description
名稱
name string
pageBreak之前
pageBreakBefore boolean
pdf包含說明
pdfIncludeDescription boolean
pdfInclude區段
pdfIncludeSection boolean
純文字說明
plaintextDescription string

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

更新現有流程回應

更新程序區段的現有回應。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

處理程序回應標識符
process_response_id True uuid

要更新的處理程序回應的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
截止日期
dueDate date-time
expireResponse 回應
expireResponse boolean
pdfInclude回應
pdfIncludeResponse boolean
resetAfter回應
resetAfterResponse boolean
回應者
responders array of string
型別
type string
類型選項
typeOptions

傳回

名稱 路徑 類型 Description
資料
data MortaProcessResponse
中繼資料
metadata object

更新現有的表格儲存格

更新表格檢視中的特定儲存格。

參數

名稱 機碼 必要 類型 Description
檢視標識符
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

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

更新現有程序

依程序識別碼更新現有程序的詳細資料

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

要更新的程序的UUID

允許註解
allowComments boolean
允許重複
allowDuplication boolean
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
描述
description
依預設展開
expandByDefault boolean
是模板
isTemplate boolean
標誌
logo string
名稱
name string
純文字說明
plaintextDescription string
範本類別
templateCategory string
型別
type string
variables
variables array of string

傳回

名稱 路徑 類型 Description
資料
data SimpleProcess
中繼資料
metadata object

更新現有資料列

更新指定表格檢視中的現有列。

參數

名稱 機碼 必要 類型 Description
檢視標識符
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 True object
排序順序
sortOrder number

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

更新現有資料表

更新現有資料表的屬性。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要更新的資料表的 UUID

允許重複
allowDuplication boolean
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string
isOneToMany
isOneToMany boolean
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string
joinTableName
joinTableName string
joinViewId
joinViewId string
joinView名稱
joinViewName string
publicId
publicId uuid
保持顏色同步
keepColoursInSync boolean
keepValidationsInSync
keepValidationsInSync boolean
標誌
logo string
名稱
name string
syncHourly頻率
syncHourlyFrequency integer
型別
type string
variables
variables array of string

傳回

名稱 路徑 類型 Description
資料
data Table
中繼資料
metadata object

更新目前使用者設定檔

更新目前登入使用者的設定檔

參數

名稱 機碼 必要 類型 Description
簡介
bio string
領英
linkedin string
位置
location string
名稱
name string
組織
organisation string
簡介圖片
profilePicture string
特徵標記
signature string
推特
twitter string
大學
university string
大學學位
universityDegree string
網站
website string

傳回

名稱 路徑 類型 Description
資料
data User
中繼資料
metadata object

更新程序回應者

更新其 UUID 所識別之指定程式的回應者清單

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

要更新其回應者的處理程序的 UUID

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
回應者
responders array of string

傳回

名稱 路徑 類型 Description
資料
data MortaProcess
中繼資料
metadata object

更新表格中的現有列

更新指定表格中的現有資料列。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
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 True object
排序順序
sortOrder number

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

更新表格儲存格

更新表格中的特定儲存格。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
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

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

更新表格欄

更新資料表中特定資料行的屬性。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

包含資料行的資料表的 UUID

資料行識別碼
column_id True uuid

要更新的資料行的UUID

aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
is索引
isIndexed boolean
類型
kind string
手動選項
manualOptions array of string
表格選項
tableOptions
morta同步
mortaSynced integer
名稱
name True string
procore同步
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
千分隔符
thousandSeparator boolean
視點同步
viewpointSynced integer
寬度
width integer

傳回

名稱 路徑 類型 Description
資料
data TableColumn
中繼資料
metadata object

更新表格的檢視

更新特定資料表的現有檢視。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

要更新之表格檢視的 UUID。

允許貢獻者刪除
allowContributorDelete boolean
圖表設定
chartSettings
collapsedGroupView
collapsedGroupView boolean
背景顏色
backgroundColour True string
columnId
columnId uuid
columnName
columnName True string
filterType (過濾器類型)
filterType True string
fontColour
fontColour True string
multiple值
multipleValues array of
value
value
aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
硬驗證
hardValidation boolean
is索引
isIndexed boolean
已加入
isJoined boolean
類型
kind string
手動選項
manualOptions array of string
表格選項
tableOptions
已鎖定
locked boolean
morta同步
mortaSynced integer
名稱
name string
procore同步
procoreSynced integer
publicId
publicId uuid
required
required boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
排序順序
sortOrder number
字串驗證
stringValidation string
千分隔符
thousandSeparator boolean
驗證訊息
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNo重複項
validationNoDuplicates boolean
視點同步
viewpointSynced integer
寬度
width integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
描述
description
禁用新行
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
columnId
columnId uuid
columnName
columnName True string
filterType (過濾器類型)
filterType True string
multiple值
multipleValues array of
或群組
orGroup string
value
value
冷凍索引
frozenIndex integer
columnId
columnId uuid
columnName
columnName True string
方向
direction True string
名稱
name string
列高度
rowHeight integer
columnId
columnId uuid
columnName
columnName True string
方向
direction True string
型別
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

傳回

名稱 路徑 類型 Description
資料
data TableView
中繼資料
metadata object

更新表格聯結

更新資料表上的現有聯結。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

具有要更新的聯結的資料表的UUID。

加入ID
join_id True uuid

要更新的聯結的UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
資料欄
dataColumns array of string
isOneToMany
isOneToMany boolean
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string
joinViewId
joinViewId string

傳回

名稱 路徑 類型 Description
資料
data Table
中繼資料
metadata object

更新視圖中的欄

更新表格檢視中的特定欄。

參數

名稱 機碼 必要 類型 Description
檢視標識符
view_id True uuid

包含要更新之欄之表格檢視的 UUID。

資料行識別碼
column_id True uuid

要更新的資料表檢視中資料行的 UUID。

aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
硬驗證
hardValidation boolean
is索引
isIndexed boolean
已加入
isJoined boolean
類型
kind string
手動選項
manualOptions array of string
表格選項
tableOptions
已鎖定
locked boolean
morta同步
mortaSynced integer
名稱
name string
procore同步
procoreSynced integer
publicId
publicId uuid
required
required boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
排序順序
sortOrder number
字串驗證
stringValidation string
千分隔符
thousandSeparator boolean
驗證訊息
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNo重複項
validationNoDuplicates boolean
視點同步
viewpointSynced integer
寬度
width integer

傳回

名稱 路徑 類型 Description
資料
data TableViewColumn
中繼資料
metadata object

更新評論

更新註解討論串中的特定註解

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

包含註解之註解執行緒的UUID

註解 ID
comment_id True uuid

要更新的註解的UUID

評論文字
commentText True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid

傳回

名稱 路徑 類型 Description
資料
data Comment
change
metadata.change object

對註解所做的變更

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

更新註解的 UUID

更新資源的許可權

更新特定資源 (例如資料表、資料表檢視或程序) 的許可權。

參數

名稱 機碼 必要 類型 Description
Id
id True uuid

要更新的原則的UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
角色
role True integer

傳回

名稱 路徑 類型 Description
資料
data AccessPolicy
中繼資料
metadata object

檢查檢視欄是否用於

擷取使用特定資料表資料行的所有檢視。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

包含資料行的資料表的 UUID

資料行識別碼
column_id True uuid

用於簽入檢視的資料行的UUID

傳回

名稱 路徑 類型 Description
資料
data array of TableView
中繼資料
metadata object

檢查處理程序表格用於

檢查並傳回處理程序、表格聯結的清單,並選取指定表格的使用位置。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

用於檢查使用情況的資料表的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of object
連結
data.link string

直接連結至程序,加入或選取

名稱
data.name string

處理程序的名稱、聯結或選取資料表的使用位置

型別
data.type string

使用類型(進程、sourceJoin、targetJoin、sourceSelect 等)

中繼資料
metadata object

為使用者建立 API 金鑰

為目前登入的使用者建立 API 金鑰

參數

名稱 機碼 必要 類型 Description
名稱
name string

傳回

名稱 路徑 類型 Description
資料
data ApiKey
中繼資料
metadata object

獲取用戶最喜歡的項目

獲取當前登錄用戶所屬的所有最喜歡的項目

傳回

名稱 路徑 類型 Description
資料
data array of object
已刪除
data.isDeleted boolean

指出專案是否已刪除

名稱
data.name string

項目的名稱

專案角色
data.projectRole string

使用者在專案中的角色

publicId
data.publicId uuid

專案的公開 ID

中繼資料
metadata object

其他中繼資料

獲取用戶的公共項目

取得使用者所屬的所有公用專案

傳回

名稱 路徑 類型 Description
資料
data array of HomeProject
中繼資料
metadata object

其他中繼資料

獲取用戶的公開貢獻

取得使用者的公開貢獻 (由使用者的 Firebase ID 識別)

參數

名稱 機碼 必要 類型 Description
Firebase Id
firebase_id True string

要擷取公開貢獻的使用者的 Firebase ID

傳回

名稱 路徑 類型 Description
資料
data array of Event
中繼資料
metadata object

中繼資料物件

獲取用戶貢獻

取得使用者每天的貢獻次數 (由使用者的 Firebase ID 識別)

參數

名稱 機碼 必要 類型 Description
Firebase Id
firebase_id True string

要擷取其貢獻的使用者的 Firebase ID

傳回

名稱 路徑 類型 Description
資料
data object

每天的貢獻,按日期鍵

中繼資料
metadata object

中繼資料物件

獲取評論線程

依識別碼擷取特定註解討論串

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

要擷取的註解執行緒的UUID

傳回

名稱 路徑 類型 Description
資料
data CommentThread
中繼資料
metadata object

獲取評論線程統計

根據參照類型和主要參照 ID 擷取註解執行緒的統計資料

參數

名稱 機碼 必要 類型 Description
參考類型
reference_type True string

要收集統計資料的參照類型 (process_section、表格或table_view)

主要參考 ID
main_reference_id uuid

要收集統計資料的主要參考的 UUID

傳回

名稱 路徑 類型 Description
資料
data array of CommentThreadStats
中繼資料
metadata object

與整合同步表

將資料表與指定的整合同步。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
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 string
folderId
folderId string
hubId
hubId string
licenseId
licenseId string
projectId
projectId string
projectIds
projectIds array of string
topFolderId
topFolderId string
型別
type string

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

表格中的更新插入列

根據唯一的資料行值,在指定資料表中新增或更新資料列。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
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 True object
排序順序
sortOrder number
upsertColumnName
upsertColumnName True string

傳回

名稱 路徑 類型 Description
資料
data array of object
publicId
data.publicId string
行數據
data.rowData object
排序順序
data.sortOrder number
中繼資料
metadata object

複製專案

建立現有專案的副本

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要複製的專案的UUID

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
重複權限
duplicatePermissions boolean

複製程序

複製現有流程,可能在不同的專案中

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

要複製的處理程序的UUID

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
重複連結表格
duplicateLinkedTables boolean
重複權限
duplicatePermissions boolean
targetProjectId
targetProjectId string

複製表格

建立現有資料表的副本及其資料、設定和選擇性的連結資料表。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要複製的資料表的UUID

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
重複連結表格
duplicateLinkedTables boolean
重複權限
duplicatePermissions boolean
targetProjectId
targetProjectId string

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

複製表格的檢視

為特定表格建立現有檢視的副本。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要複製檢視之表格的 UUID。

檢視標識符
view_id True uuid

要複製之檢視的 UUID。

傳回

名稱 路徑 類型 Description
資料
data TableView
中繼資料
metadata object

複製表格的預設檢視

建立特定資料表預設檢視的副本。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要複製預設檢視之表格的 UUID。

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
名稱
name string
型別
type integer

傳回

名稱 路徑 類型 Description
資料
data TableView
中繼資料
metadata object

複製進程區段

複製特定流程區段。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

要複製的程式區段的UUID。

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

複製進程區段

以非同步方式複製特定程序區段。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

要複製的程式區段的UUID。

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

要求資源的許可權

要求特定資源 (例如資料表、資料表檢視或程序) 的許可權。

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

資源所屬專案的 UUID。

類型
type True string

要要求權限的資源類型。 有效的選項是 'project'、'process'、'table' 或 'view'。

Id
id True uuid

要要求許可權之資源的 UUID。

解決註解線程

解決註解討論串

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

要解決的註解線程的UUID

傳回

名稱 路徑 類型 Description
資料
data CommentThread
change
metadata.change object

對評論線程所做的更改

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

已解析註解討論串的 UUID

變更使用者在專案中的角色

變更使用者在特定專案中的角色 (由專案的 UUID 和使用者的 Firebase ID 識別)

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

專案的 UUID

Firebase Id
firebase_id True string

要變更角色之使用者的 Firebase ID

角色
role True string

傳回

名稱 路徑 類型 Description
資料
data SimpleProject
中繼資料
metadata object

通過公共 ID 獲取標籤

依其公用 ID 擷取標籤。

參數

名稱 機碼 必要 類型 Description
標籤公用 ID
tag_id True string

要擷取之標籤的公用 ID。

傳回

名稱 路徑 類型 Description
資料
data Tag
中繼資料
metadata object

通過公共 ID 獲取用戶詳細信息

透過公用 ID 取得特定使用者的資訊

參數

名稱 機碼 必要 類型 Description
公用標識碼
public_id True uuid

要擷取的使用者的公用UUID

傳回

名稱 路徑 類型 Description
資料
data User
中繼資料
metadata object

中繼資料物件

通過引用獲取評論線程

擷取與特定參考相關聯的所有註解討論串

參數

名稱 機碼 必要 類型 Description
參考類型
reference_type True string

與註解串程相關聯的參照類型 (process_section、表格或table_view)

參考標識碼
reference_id True uuid

與註解執行緒相關聯之參考的UUID

主要參考
main_reference string

用於額外過濾的可選主要參考

傳回

名稱 路徑 類型 Description
資料
data array of CommentThread
中繼資料
metadata object

邀請使用者加入專案

透過電子郵件邀請單一使用者加入專案。 如果使用者已經存在,則會直接新增;否則,會傳送邀請。 需要擁有者或管理員權限。

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

邀請使用者加入之專案的 UUID

電子郵件
email True email
tags
tags array of string

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

邀請多個使用者加入專案

透過電子郵件邀請多個使用者加入專案。 如果使用者已存在,則會直接新增使用者,否則會傳送邀請。 需要擁有者或管理員權限。

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

邀請使用者加入之專案的 UUID

電子郵件
emails array of email
tags
tags array of string

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

還原專案

還原先前已刪除的特定專案 (由其 UUID 識別)

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

要還原之專案的 UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

還原已刪除的資料表

使用先前刪除的資料表的 UUID 還原。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

要還原的資料表的 UUID

傳回

名稱 路徑 類型 Description
資料
data Table
中繼資料
metadata object

還原程序

還原其 UUID 所識別的已刪除程序

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

要還原的程序的 UUID

傳回

名稱 路徑 類型 Description
資料
data MortaProcess
中繼資料
metadata object

還原程序區段

還原先前刪除的進程區段。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

要還原的處理程序區段的 UUID。

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

還原程序回應

還原先前刪除的處理程序回應。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

處理程序回應標識符
process_response_id True uuid

要還原的處理程序回應的 UUID。

傳回

名稱 路徑 類型 Description
資料
data ProcessResponse
中繼資料
metadata object

還原表格欄

還原資料表中先前刪除的資料行。

參數

名稱 機碼 必要 類型 Description
資料表識別碼
table_id True uuid

包含要還原之資料行的資料表的 UUID

資料行識別碼
column_id True uuid

要還原之欄的UUID

傳回

名稱 路徑 類型 Description
資料
data TableColumn
中繼資料
metadata object

重新傳送專案邀請給使用者

重新傳送專案邀請給使用者。 這適用於新使用者和先前受邀的現有使用者。 需要擁有者或管理員權限。

參數

名稱 機碼 必要 類型 Description
專案編號
project_id True uuid

重新傳送邀請之專案的UUID

邀請標識碼
invite_id True uuid

要重新傳送的邀請的UUID

傳回

名稱 路徑 類型 Description
資料
data string
中繼資料
metadata object

重新開啟評論討論串

重新開啟先前解決的註解討論串

參數

名稱 機碼 必要 類型 Description
註解討論串 ID
comment_thread_id True uuid

重新開啟的註解討論串的UUID

傳回

名稱 路徑 類型 Description
資料
data CommentThread
change
metadata.change object

對評論線程所做的更改

事件
metadata.event string

作業的事件類型

resourceId
metadata.resourceId string

重新開啟的註解討論串的 UUID

重複進程

將現有程序複製到不同的專案中

參數

名稱 機碼 必要 類型 Description
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processId
processId True uuid
projectId
projectId uuid

傳回

名稱 路徑 類型 Description
資料
data MortaProcess
中繼資料
metadata object

重設處理程序回應

將現有的處理程序回應重設為其初始狀態。

參數

名稱 機碼 必要 類型 Description
進程識別碼
process_id True uuid

程序的 UUID。

處理區段識別碼
process_section_id True uuid

程序區段的 UUID。

處理程序回應標識符
process_response_id True uuid

要重設的處理程序回應的 UUID。

傳回

名稱 路徑 類型 Description
資料
data MortaProcessSection
中繼資料
metadata object

定義

存取屬性

名稱 路徑 類型 Description
文件表格
documentTable Table3
類型
kind string
專案
project Project
publicId
publicId uuid
加標籤
tag Tag
使用者
user User3

訪問策略

名稱 路徑 類型 Description
access屬性
accessAttribute AccessAttribute
access資源
accessResource AccessResource
publicId
publicId uuid
角色
role integer
角色標籤
roleLabel string

存取資源

名稱 路徑 類型 Description
文件表格
documentTable Table3
類型
kind string
流程
process Process
publicId
publicId uuid

行動

名稱 路徑 類型 Description
類型
kind string
publicId
publicId uuid
webhookUrl
webhookUrl string

回答

名稱 路徑 類型 Description
answers
answers array of SearchProjectAnswerResources
resources
resources array of SearchProjectResources

API 金鑰 (ApiKey)

名稱 路徑 類型 Description
雜湊
hash string
名稱
name string
prefix
prefix string
publicId
publicId uuid

圖表

名稱 路徑 類型 Description
圖表類型
chartType string
columnLabelId
columnLabelId uuid
columnValueId
columnValueId uuid
顯示圖例
showLegend boolean
顯示值
showValues boolean

顏色

名稱 路徑 類型 Description
背景顏色
backgroundColour string
columnId
columnId uuid
columnName
columnName string
filterType (過濾器類型)
filterType string
fontColour
fontColour string
multiple值
multipleValues array of
value
value

評論

名稱 路徑 類型 Description
評論文字
commentText string
創建於
createdAt date-time
deleted在
deletedAt date-time
是擁有者
isOwner
publicId
publicId uuid
updatedAt
updatedAt date-time
使用者
user SummaryUser

評論線程

名稱 路徑 類型 Description
註解
comments array of Comment
創建於
createdAt date-time
deleted在
deletedAt date-time
isComment發起器
isCommentInitiator
publicId
publicId uuid
已解決時間
resolvedAt date-time
解析器
resolver User1
updatedAt
updatedAt date-time

評論線程統計

名稱 路徑 類型 Description
開啟評論討論串
openCommentThreads integer
參考標識符
referenceId uuid
已解決的評論線程
resolvedCommentThreads integer

草稿

名稱 路徑 類型 Description
內容
content DraftjsContent

Draftjs區塊

名稱 路徑 類型 Description
資料
data
depth integer
實體範圍
entityRanges array of
inlineStyle範圍
inlineStyleRanges array of
Key
key string
收發簡訊
text string
型別
type string

Draftjs內容

名稱 路徑 類型 Description
區塊
blocks array of DraftjsBlock
實體地圖
entityMap

Event

名稱 路徑 類型 Description
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 date-time
projectId
projectId integer
publicId
publicId uuid
資源
resource string
resourcePublicId
resourcePublicId uuid
userId
userId integer
動詞
verb string

Filter

名稱 路徑 類型 Description
columnId
columnId uuid
columnName
columnName string
filterType (過濾器類型)
filterType string
multiple值
multipleValues array of
或群組
orGroup string
value
value

群體

名稱 路徑 類型 Description
columnId
columnId uuid
columnName
columnName string
方向
direction string

標題樣式

名稱 路徑 類型 Description
bold
bold boolean
顏色
colour string
fontSize
fontSize number
斜體
italic boolean
水平儀
level integer
編號樣式
numberingStyle integer
publicId
publicId uuid
開始時間0
startAt0 boolean
下劃線
underline boolean

首頁項目

名稱 路徑 類型 Description
deleted在
deletedAt date-time
隱藏程序已建立
hideProcessCreated boolean
已刪除
isDeleted boolean
mfa必填
mfaRequired boolean
名稱
name string
primaryColour
primaryColour string
publicId
publicId string

整合傳遞回應

名稱 路徑 類型 Description
body
body
內容類型
contentType string
headers
headers
狀態
status string

受邀會員

名稱 路徑 類型 Description
創建於
createdAt date-time
電子郵件
email string
邀請者
invitedBy SummaryUser
publicId
publicId uuid
tags
tags array of Tag

MortaProcess

名稱 路徑 類型 Description
允許註解
allowComments boolean
允許重複
allowDuplication boolean
孩童
children array of ProcessSection1
創建於
createdAt date-time
deleted在
deletedAt date-time
描述
description
依預設展開
expandByDefault boolean
已刪除
isDeleted boolean
是模板
isTemplate boolean
標誌
logo string
名稱
name string
publicId
publicId uuid
範本類別
templateCategory string
型別
type string
updatedAt
updatedAt date-time
變數值
variableValues array of string
variables
variables array of string

MortaProcess回應

名稱 路徑 類型 Description
已批准
approved boolean
創建於
createdAt date-time
deleted在
deletedAt date-time
截止日期
dueDate date-time
expireResponse 回應
expireResponse boolean
已刪除
isDeleted boolean
pdfInclude回應
pdfIncludeResponse boolean
位置
position integer
publicId
publicId uuid
resetAfter回應
resetAfterResponse boolean
回應者
responders array of string
response
response
回應日期
responseDate date-time
型別
type string
類型選項
typeOptions
updatedAt
updatedAt date-time
使用者
user SummaryUser
使用者回應者
userResponders array of SummaryUser

MortaProcess區段

名稱 路徑 類型 Description
孩童
children array of MortaProcessSection
創建於
createdAt date-time
deleted在
deletedAt date-time
描述
description Draftjs
已刪除
isDeleted boolean
名稱
name string
開啟評論討論串
openCommentThreads integer
pageBreak之前
pageBreakBefore boolean
parentId
parentId uuid
pdf包含說明
pdfIncludeDescription boolean
pdfInclude區段
pdfIncludeSection boolean
位置
position integer
publicId
publicId uuid
回應
responses array of ProcessResponse
狀態
status integer

Notification

名稱 路徑 類型 Description
行為
actions array of Action
創建於
createdAt date-time
描述
description string
processes
processes array of Process
publicId
publicId uuid
tables
tables array of Table1
觸發器
triggers array of Trigger
使用者
user SummaryUser

通知1

名稱 路徑 類型 Description
行為
actions array of Action
創建於
createdAt date-time
描述
description string
processes
processes array of Process
publicId
publicId uuid
tables
tables array of Table1
觸發器
triggers array of Trigger

通知執行

名稱 路徑 類型 Description
創建於
createdAt date-time
描述
description string
是否成功
isSuccess boolean
通知
notification Notification1
publicId
publicId uuid
updatedAt
updatedAt date-time

PermissionedProcess

名稱 路徑 類型 Description
創建於
createdAt date-time
deleted在
deletedAt date-time
標誌
logo string
名稱
name string
publicId
publicId uuid
型別
type string
updatedAt
updatedAt date-time

流程

名稱 路徑 類型 Description
名稱
name string
publicId
publicId uuid

處理回應

名稱 路徑 類型 Description
已批准
approved boolean
創建於
createdAt date-time
deleted在
deletedAt date-time
截止日期
dueDate date-time
expireResponse 回應
expireResponse boolean
已刪除
isDeleted boolean
pdfInclude回應
pdfIncludeResponse boolean
位置
position integer
publicId
publicId uuid
resetAfter回應
resetAfterResponse boolean
回應者
responders array of string
response
response
回應日期
responseDate date-time
型別
type string
類型選項
typeOptions
updatedAt
updatedAt date-time
使用者
user SummaryUser
使用者回應者
userResponders array of SummaryUser

Process區段

名稱 路徑 類型 Description
名稱
name string
publicId
publicId uuid
狀態
status integer

程序區段1

名稱 路徑 類型 Description
孩童
children array of ProcessSection1
創建於
createdAt date-time
deleted在
deletedAt date-time
描述
description Draftjs
已刪除
isDeleted boolean
名稱
name string
開啟評論討論串
openCommentThreads integer
pageBreak之前
pageBreakBefore boolean
parentId
parentId uuid
pdf包含說明
pdfIncludeDescription boolean
pdfInclude區段
pdfIncludeSection boolean
位置
position integer
publicId
publicId uuid
回應
responses array of ProcessResponse
狀態
status integer

專案

名稱 路徑 類型 Description
名稱
name string
publicId
publicId string

項目列表

名稱 路徑 類型 Description
創建於
createdAt date-time
收藏夾
favourite boolean
專案角色
projectRole string
updatedAt
updatedAt date-time
使用者
user User4

ProjectListWithUser標籤

名稱 路徑 類型 Description
創建於
createdAt date-time
收藏夾
favourite boolean
專案角色
projectRole string
updatedAt
updatedAt date-time
使用者
user User2

專案秘密

名稱 路徑 類型 Description
創建於
createdAt date-time
名稱
name string
publicId
publicId uuid
updatedAt
updatedAt date-time
value
value string

SearchProjectAnswer資源

名稱 路徑 類型 Description
標籤
label string
連結
link string
原文
originalText string
相似性
similarity number
收發簡訊
text string

搜尋專案資源

名稱 路徑 類型 Description
連結
link string
收發簡訊
text string
型別
type string

選取選項查閱

名稱 路徑 類型 Description
手動選項
manualOptions array of string
表格選項
tableOptions

SimpleDocumentTable

名稱 路徑 類型 Description
創建於
createdAt date-time
defaultViewId
defaultViewId string
deleted在
deletedAt date-time
已刪除
isDeleted boolean
加入
joins array of TableJoin
標誌
logo string
名稱
name string
publicId
publicId uuid
型別
type string
updatedAt
updatedAt date-time

簡單流程

名稱 路徑 類型 Description
允許註解
allowComments boolean
允許重複
allowDuplication boolean
孩童
children array of ProcessSection
創建於
createdAt date-time
deleted在
deletedAt date-time
描述
description
依預設展開
expandByDefault boolean
已刪除
isDeleted boolean
是模板
isTemplate boolean
標誌
logo string
名稱
name string
publicId
publicId uuid
範本類別
templateCategory string
型別
type string
updatedAt
updatedAt date-time
變數值
variableValues array of string
variables
variables array of string

簡單項目

名稱 路徑 類型 Description
admin限制
adminLimit integer
自動化限制
automationLimit integer
創建於
createdAt date-time
defaultProcessId
defaultProcessId string
deleted在
deletedAt date-time
標題樣式
headingStyles array of HeadingStyle
隱藏程序已建立
hideProcessCreated boolean
圖片
image string
已刪除
isDeleted boolean
標誌
logo string
mfa必填
mfaRequired boolean
名稱
name string
無管理員
noOfAdmins integer
primaryColour
primaryColour string
processTitleBold
processTitleBold boolean
processTitleColour
processTitleColour string
processTitleFontSize
processTitleFontSize number
processTitle斜體
processTitleItalic boolean
processTitle底線
processTitleUnderline boolean
專案清單
projectList array of ProjectList
公眾
public boolean
publicId
publicId string
updatedAt
updatedAt date-time

排序

名稱 路徑 類型 Description
columnId
columnId uuid
columnName
columnName string
方向
direction string

摘要使用者

名稱 路徑 類型 Description
電子郵件
email string
firebaseUserId
firebaseUserId string
名稱
name string
簡介圖片
profilePicture string
publicId
publicId uuid

Table

名稱 路徑 類型 Description
允許重複
allowDuplication boolean
columns
columns array of TableColumn
創建於
createdAt date-time
defaultViewId
defaultViewId string
deleted在
deletedAt date-time
isAconex同步
isAconexSynced boolean
是AutodeskBim360Synced
isAutodeskBim360Synced boolean
已刪除
isDeleted boolean
isMortaProjectsSynced
isMortaProjectsSynced boolean
isMorta資源同步
isMortaResourcesSynced boolean
isMorta同步
isMortaSynced boolean
isMortaUsers已同步
isMortaUsersSynced boolean
isProcore同步
isProcoreSynced boolean
isReviztoIssuesSynced
isReviztoIssuesSynced boolean
是同步的
isSynced boolean
isViewpoint同步
isViewpointSynced boolean
加入
joins array of TableJoin
保持顏色同步
keepColoursInSync boolean
keepValidationsInSync
keepValidationsInSync boolean
最後同步
lastSync date-time
標誌
logo string
名稱
name string
projects
projects array of Project
publicId
publicId uuid
syncHourly頻率
syncHourlyFrequency integer
型別
type string
updatedAt
updatedAt date-time
variables
variables array of string

表1

名稱 路徑 類型 Description
defaultViewId
defaultViewId string
名稱
name string
publicId
publicId uuid

表2

名稱 路徑 類型 Description
創建於
createdAt date-time
名稱
name string
publicId
publicId uuid
型別
type string
updatedAt
updatedAt date-time

表3

名稱 路徑 類型 Description
名稱
name string
publicId
publicId uuid

表格欄

名稱 路徑 類型 Description
aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
is索引
isIndexed boolean
已加入
isJoined boolean
類型
kind string
種類選項
kindOptions SelectOptionsLookup
morta同步
mortaSynced integer
名稱
name string
procore同步
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
千分隔符
thousandSeparator boolean
視點同步
viewpointSynced integer
寬度
width integer

TableColumnAggregation結果

名稱 路徑 類型 Description
名稱
name string
value
value number

TableColumnJoin

名稱 路徑 類型 Description
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string

TableColumnWithAggregation

名稱 路徑 類型 Description
彙總
aggregation TableColumnAggregationResult
名稱
name string
publicId
publicId uuid

表格聯結

名稱 路徑 類型 Description
資料欄
dataColumns array of TableJoinImportedColumns
isOneToMany
isOneToMany boolean
joinColumns
joinColumns array of TableColumnJoin
joinTableId
joinTableId string
joinViewId
joinViewId string
publicId
publicId uuid

TableJoinImportedColumns

名稱 路徑 類型 Description
來源資料欄 ID
sourceColumnId string
targetColumnId
targetColumnId string

表格視圖

名稱 路徑 類型 Description
允許貢獻者刪除
allowContributorDelete boolean
圖表設定
chartSettings Chart
collapsedGroupView
collapsedGroupView boolean
顏色設定
colourSettings array of Colour
columns
columns array of TableViewColumn
描述
description Draftjs
禁用新行
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
filterSettings
filterSettings array of Filter
冷凍索引
frozenIndex integer
群組設定
groupSettings array of Group
isDefault
isDefault boolean
名稱
name string
publicId
publicId uuid
列高度
rowHeight integer
排序設定
sortSettings array of Sort
型別
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

TableView資料行

名稱 路徑 類型 Description
aconex同步
aconexSynced integer
彙總
aggregate integer
alter選項
alterOptions
autodeskBim360同步
autodeskBim360Synced integer
dateFormat
dateFormat string
小數點位數
decimalPlaces integer
描述
description
硬驗證
hardValidation boolean
is索引
isIndexed boolean
已加入
isJoined boolean
類型
kind string
種類選項
kindOptions SelectOptionsLookup
已鎖定
locked boolean
morta同步
mortaSynced integer
名稱
name string
procore同步
procoreSynced integer
publicId
publicId uuid
required
required boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
指令
script string
script啟用
scriptEnabled boolean
排序順序
sortOrder number
字串驗證
stringValidation string
千分隔符
thousandSeparator boolean
驗證訊息
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNo重複項
validationNoDuplicates boolean
視點同步
viewpointSynced integer
寬度
width integer

TableViewWithTable

名稱 路徑 類型 Description
允許貢獻者刪除
allowContributorDelete boolean
圖表設定
chartSettings Chart
collapsedGroupView
collapsedGroupView boolean
顏色設定
colourSettings array of Colour
columns
columns array of TableViewColumn
描述
description Draftjs
禁用新行
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
文件表格
documentTable Table2
filterSettings
filterSettings array of Filter
冷凍索引
frozenIndex integer
群組設定
groupSettings array of Group
isDefault
isDefault boolean
名稱
name string
publicId
publicId uuid
列高度
rowHeight integer
排序設定
sortSettings array of Sort
型別
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

標記

名稱 路徑 類型 Description
文件表格Id
documentTableId string
專案PublicId
projectPublicId uuid
publicId
publicId uuid
參考PublicId
referencePublicId string
value
value

觸發程序

名稱 路徑 類型 Description
publicId
publicId uuid
資源
resource string
動詞
verb string

User

名稱 路徑 類型 Description
aconex連接
aconexConnected boolean
apiKeys
apiKeys array of ApiKey
autodesk連接
autodeskConnected boolean
簡介
bio string
建設軟件
constructionSoftware array of string
電子郵件
email string
firebaseUserId
firebaseUserId string
類型
kind string
領英
linkedin string
位置
location string
名稱
name string
組織
organisation string
phone
phone string
procore連線
procoreConnected boolean
簡介圖片
profilePicture string
專案WorkedOn
projectsWorkedOn array of string
publicId
publicId uuid
reviztoConnected
reviztoConnected boolean
特徵標記
signature string
專長
specialisms array of string
tags
tags
推特
twitter string
大學
university string
大學學位
universityDegree string
觀點連接
viewpointConnected boolean
網站
website string

User1

名稱 路徑 類型 Description
名稱
name string

User2

名稱 路徑 類型 Description
電子郵件
email string
firebaseUserId
firebaseUserId string
類型
kind string
名稱
name string
簡介圖片
profilePicture string
publicId
publicId uuid
tags
tags

User3

名稱 路徑 類型 Description
firebaseUserId
firebaseUserId string
名稱
name string
publicId
publicId uuid

User4

名稱 路徑 類型 Description
電子郵件
email string
firebaseUserId
firebaseUserId string
類型
kind string
名稱
name string
publicId
publicId uuid

使用者與權杖

名稱 路徑 類型 Description
aconex連接
aconexConnected boolean
apiKeys
apiKeys array of ApiKey
authToken 認證
authToken string
autodesk連接
autodeskConnected boolean
簡介
bio string
建設軟件
constructionSoftware array of string
電子郵件
email string
firebaseUserId
firebaseUserId string
has密碼
hasPassword
識別碼
id integer
is2Fa啟用
is2FaEnabled
是超級管理員
isSuperAdmin boolean
類型
kind string
lastLoginAt
lastLoginAt date-time
領英
linkedin string
位置
location string
名稱
name string
組織
organisation string
phone
phone string
procore連線
procoreConnected boolean
簡介圖片
profilePicture string
專案WorkedOn
projectsWorkedOn array of string
publicId
publicId uuid
reviztoConnected
reviztoConnected boolean
特徵標記
signature string
專長
specialisms array of string
tags
tags
推特
twitter string
大學
university string
大學學位
universityDegree string
觀點連接
viewpointConnected boolean
網站
website string

二進位

這是基本數據類型 『binary』。