Cognito 表單

Cognito Forms 是一款線上表單建置器，用於收集和管理提交資料。 此連接器允許自動流程在條目建立、更新或刪除時觸發，並提供建立、更新及檢索條目的動作。 將 Cognito 表單與其他服務整合，以路由資料、處理上傳檔案並自動化業務工作流程。

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

服務 Class Regions
Copilot Studio 標準 除以下部分外，所有Power Automate區域：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government regions
     - Azure中國地區
     - 美國國防部 （DoD）
Power Apps 標準 除以下部分外，所有Power Apps區域
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 標準 除以下部分外，所有Power Automate區域：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
名稱 Cognito 表單支援
URL https://www.cognitoforms.com/support
Email support@cognitoforms.com
連接器中繼資料
Publisher Cognito Forms， LLC
網站 https://www.cognitoforms.com
隱私權原則 https://www.cognitoforms.com/legal/privacy
類別 生產力;通敵

Cognito 表單

Cognito Forms 可讓您輕鬆建立功能強大的線上表單，例如調查、訂單、註冊表等。 免費。 請參閱我們的支援文件或contact us以協助使用我們的公共Power Automate連接器。

Publisher：Cognito Forms

先決條件

需要付費訂閱。

支援的作業

觸發器

觸發器將在訂閱事件發生後不久傳送。

新條目

當為指定的表單建立新項目時，將觸發此操作。 輸出將是輸入資料，包括檔案資料以及檔案、簽名和輸入文件的臨時連結。

參數：
  • form：將訂閱新項目事件的表單名稱。

更新項目

當更新指定表單的條目時，將觸發此操作。 輸出將是輸入資料，包括檔案資料以及檔案、簽名和輸入文件的臨時連結。

參數：
  • form：將訂閱更新項目事件的表單名稱。

條目已刪除

當刪除指定表單的條目時，將觸發此操作。 輸出將是條目數據，不包括鏈接。

參數：
  • form：將訂閱已刪除項目事件的表單名稱。

行動

建立項目

此動作會為指定的表單建立專案。 此動作將包含每個輸入欄位的可設定屬性，但不包括某些欄位類型。 輸出將是條目資料。

參數：
  • form：內部表單名稱或 ID

編輯項目

此動作會更新指定表單的現有項目。 此動作將包含每個輸入欄位的可設定屬性，但不包括某些欄位類型。 如果項目包含已付款訂單或entryId不存在，則此動作將會失敗。 輸出將是更新的條目資料。

參數：
  • form：內部表單名稱或 ID
  • entryId：要更新的項目的項目編號或項目 ID

SetForm可用性

此動作將設定表單的可用性限制設定。 and startend 參數應該為空白，才能讓表單隨時可用。 輸出將是更新的可用性設定。

參數：
  • form：內部表單名稱或 ID
  • start：表單應可供使用的日期時間。
  • end：表單不應再可用的日期時間。
  • message：應向在可用期間之外嘗試存取表單的使用者顯示的訊息。

GetFile

此動作會從儲存體擷取檔案。 輸出將是一個物件，其中包含檔案資料、中繼資料和檔案的臨時連結。

參數：
  • id：要擷取之檔案的檔案 ID。

取得文件

此動作將使用指定的表單、項目和範本產生和擷取項目文件。 輸出將是一個對象，其中包含文件的文件數據、元數據和文檔的臨時鏈接。

參數：
  • form：內部表單名稱或 ID
  • entry：應為其產生文件之項目的項目 ID 或項目編號
  • templateNumber：應用於產生輸入文件的範本編號

取得入口

此動作會取得指定表單的現有專案。 如果項目不存在，此動作將會失敗。 輸出將是條目資料。

參數：
  • form：內部表單名稱或 ID
  • entryId：要擷取的項目的項目編號或項目 ID

刪除項目

此動作將刪除指定表單的現有項目。 如果項目不存在，此動作將會失敗。 不會有輸出。

參數：
  • form：內部表單名稱或 ID
  • entryId：要刪除的項目的項目編號或項目 ID

進口條目

此動作將使用提供的檔案內容（.xlsx 或 .csv）建立、更新或刪除條目。 輸出會是一個包含匯入 ID 和狀態的物件。

參數：
  • form：內部表單名稱或 ID
  • File：包含要匯入的條目（.xlsx 或 .csv）
  • ImportMode：匯入模式（CreateNew、UpdateExisting 或 SyncEntries）
  • Email：接收進口通知的電子郵件地址（可選）
  • MatchEntriesUsing：條目ID替代（可選）

GetImportStatus

此操作會取得匯入的當前狀態，並回傳成功與失敗的輸入數量。 輸出會是一個物件，包含匯入狀態、計數以及錯誤資訊（如適用）。

參數：
  • form：內部表單名稱或 ID
  • importId：用來檢查狀態的匯入 ID

上傳檔案

此操作將上傳檔案至 Cognito Forms。

參數：
  • fileContent：檔案的二進位資料
  • fileName：檔案名稱

GetEntryViewEntries

此動作將取得指定視圖的所有條目。 輸出會是根據視圖設定的輸入資料。

參數：
  • form：內部表單名稱或 ID
  • viewId：景觀的識別
  • $count：包含總條目數（可選）
  • $select： 當指定 $select=Id（可選）時，回傳檢視中的條目 ID 清單

私人運營

這些作業是公用觸發器和動作的啟用器。

取得表格

此操作將回傳包含 Id 和 Name的物件形式列表。 當用於動作和觸發器的參數時 form ，使用者應該會看到 Name，但應該將 傳送 Id 至 API。 已存檔的表單未包含在回應中。

GetFormSchema

此作業會傳回指定表單的結構描述。 對於排除唯讀屬性的動作，參數 input 應該為 true，對於觸發程序包含所有屬性，參數應該為 false。 includeLinks除了 EntryDeleted 之外，所有動作和觸發程式的參數都應該為 true。

參數：
  • form：內部表單名稱或 ID
  • input：布林值，指出傳回的結構描述是否應該排除無法設定的屬性。 False 預設為 False。
  • includeLinks：布林值，指出檔案、簽名和文件的連結屬性是否應包含在結構描述中。 預設為 True。

取消訂閱Webhook

此作業會取消訂閱指定的 Webhook。 傳送所有目前排入佇列的事件之後，Webhook 將不再接收任何事件。

參數：
  • id：應取消訂閱的 Webhook 的 ID。
  • module：Webhook 的模組。 這應該設定為「表單」，因為此連接器僅支援該模組。

取得憑證

組織的擁有者必須登入 Cognito Forms 並授權連線。

已知問題

None

部署指示

Cognito Forms需要有效的 Client id 和 Client secret 才能建立聯結器。 這些屬性可以在金鑰保存庫中找到，而且只能在自訂連接器的驗證設定中設定。

  1. 請執行：

     paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json

  2. 登入 PowerAutomate

  3. 導覽至新的連接器

  4. 在「安全性」下，更新 Client id 和 Client secret

  5. 更新連接器

節流限制

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

動作

上傳檔案

上傳一個檔案用於表單條目。
刪除項目

刪除項目。
取得匯入狀態

取得匯入的當前狀態，並回傳成功與失敗的條目數量。
取得參賽資格

取得專案。
取得文件

取得文件
取得檔案

透過 ID 取得檔案。
建立項目

建立新項目。
更新項目

更新項目。
獲取表單條目

取得指定視圖的所有條目
設定表單可用性

設定表單的可用性。
進口條目

利用提供的檔案內容建立、更新或刪除條目。

上傳檔案

作業識別碼：
UploadFile

上傳一個檔案用於表單條目。

參數

名稱 機碼 必要 類型 Description
File
 File True file

要上傳的檔案。

傳回

名稱 路徑 類型 Description
檔案標識碼
 Id string

檔案的唯一 ID。
檔案名稱
 Name string

檔案名稱
檔案內容類型
 ContentType string

檔案的內容類型。
檔案大小
 Size integer

檔案的大小 (以位元組為單位)。

刪除項目

作業識別碼：
DeleteEntry

刪除項目。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
項目標識碼
 entryId True string

項目標識符

取得匯入狀態

作業識別碼：
GetImportStatus

取得匯入的當前狀態，並回傳成功與失敗的條目數量。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

形式名稱
匯入 ID
 importId True string

進口識別碼

傳回

名稱 路徑 類型 Description
識別碼
 Id string

匯入的 ID
狀態
 Status string

進口狀態
錯誤訊息
 ErrorMessage string

一則說明匯入失敗原因的訊息
成功參賽作品
 SuccessfulEntries integer

成功進口的參賽作品數量
未成功參賽作品
 UnsuccessfulEntries integer

未能匯入的條目數量
總計項
 TotalEntries integer

匯入項目總數
ImportLink
 ImportLink string

下載註解檔案的條目頁面連結

取得參賽資格

作業識別碼：
GetEntry

取得專案。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
項目標識碼
 entryId True string

項目標識符

傳回

此作業會輸出隨機的結果。

取得文件

作業識別碼：
GetDocument

取得文件

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
項目標識碼
 entry True string

項目標識符
範本編號
 templateNumber True integer

範本編號

傳回

包含檔案資料和中繼資料的檔案參考

身體
FileDataRef

取得檔案

作業識別碼：
GetFile

透過 ID 取得檔案。

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

檔案的唯一識別碼

傳回

包含檔案資料和中繼資料的檔案參考

身體
FileDataRef

建立項目

作業識別碼：
CreateEntry

建立新項目。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
Entry
 entry True dynamic

要為表單建立的項目

傳回

此作業會輸出隨機的結果。

更新項目

作業識別碼：
EditEntry

更新項目。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
項目標識碼
 entryId True string

項目標識符
Entry
 entry True dynamic

更新後的條目數據

傳回

此作業會輸出隨機的結果。

獲取表單條目

作業識別碼：
GetEntryViewEntries

取得指定視圖的所有條目

參數

名稱 機碼 必要 類型 Description
Form
 form True string

形式名稱
檢視表識別碼
 viewId True string

景觀的識別
包含計數
 $count string

包含總條目數量
選擇識別碼
 $select string

當指定 $select=Id 時，會在檢視中回傳條目 ID 清單

傳回

response
object

設定表單可用性

作業識別碼：
SetFormAvailability

設定表單的可用性。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
可用性開始
 start date-time

可用性開始日期
可用性結束
 end date-time

可用性結束日期
無法使用訊息
 message string

無法使用訊息

傳回

表單可用性資訊，例如開始/結束可用性和無法使用訊息。

身體
FormAvailability

進口條目

作業識別碼：
ImportEntries

利用提供的檔案內容建立、更新或刪除條目。

參數

名稱 機碼 必要 類型 Description
Form
 form True string

表單的名稱
匯入檔案
 File True file

包含要匯入的條目（.xlsx 或 .csv）檔案。
匯入模式
 ImportMode True string

匯入模式
通知電子郵件
 Email email

接收進口通知的電子郵件地址
比賽場地
 MatchEntriesUsing string

一個入口 ID 替代

傳回

名稱 路徑 類型 Description
識別碼
 Id string

匯入的 ID
狀態
 Status string

進口狀態
錯誤訊息
 ErrorMessage string

一則說明匯入失敗原因的訊息

觸發程序

刪除項目時

當有人刪除項目時觸發。
建立新項目時

當有人建立新項目時觸發。
更新項目時

當有人更新項目時觸發。

刪除項目時

作業識別碼：
EntryDeleted

當有人刪除項目時觸發。

參數

名稱 機碼 必要 類型 Description
Form
 publisher True string

表單的名稱

傳回

此作業會輸出隨機的結果。

建立新項目時

作業識別碼：
NewEntry

當有人建立新項目時觸發。

參數

名稱 機碼 必要 類型 Description
Form
 publisher True string

表單的名稱

傳回

此作業會輸出隨機的結果。

更新項目時

作業識別碼：
UpdateEntry

當有人更新項目時觸發。

參數

名稱 機碼 必要 類型 Description
Form
 publisher True string

表單的名稱

傳回

此作業會輸出隨機的結果。

定義

檔案資料參考

包含檔案資料和中繼資料的檔案參考

名稱 路徑 類型 Description
檔案標識碼
 Id string

檔案的唯一 ID。
檔案名稱
 Name string

檔案名稱
檔案內容類型
 ContentType string

檔案的內容類型。
檔案大小
 Size integer

檔案的大小。
檔案網址
 File string

檔案的 URL。
檔案內容
 Content byte

檔案內容

表格可用性

表單可用性資訊，例如開始/結束可用性和無法使用訊息。

名稱 路徑 類型 Description
表單可用性開始
 availabilityStart date-time

表單可用性開始
表單可用性結束
 availabilityEnd date-time

表單可用性結束
無法使用訊息
 notAvailableMessage string

無法使用訊息

物件

這是類型 'object'。