Kintone

實體、作業和動作

所有 Integration Connectors 都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化存取應用程式的物件。抽象化會以實體、作業和動作的形式向您公開。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義與連接器對連接器不同。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱連線器工作中的實體作業。 不過，如果連接器不支援任何實體作業，Operations 清單就不會列出這類不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，在這種情況下，Actions 清單會是空白。

動作

本節列出連接器支援的動作。如要瞭解如何設定動作，請參閱「動作範例」。

AppsDeployStatus 動作

這項動作會取得應用程式部署狀態

AppsDeployStatus 動作的輸入參數

如要瞭解如何設定 AppsDeployStatus 動作，請參閱動作範例。

CreateApp 動作

這項操作會建立應用程式。

CreateApp 動作的輸入參數

如要瞭解如何設定 CreateApp 動作，請參閱動作範例。

DeleteGuests 動作

這項操作可讓使用者刪除邀請對象。

DeleteGuests 動作的輸入參數

如要瞭解如何設定 DeleteGuests 動作，請參閱動作範例。

DeployApps 動作

這項操作可讓您部署應用程式。

DeployApps 動作的輸入參數

如要瞭解如何設定 DeployApps 動作，請參閱動作範例。

DownloadFile 動作

這項動作可讓使用者從應用程式的附件欄位下載檔案。

DownloadFile 動作的輸入參數

如要瞭解如何設定 DownloadFile 動作，請參閱動作範例。

UpdateAssignees 動作

使用者可透過這項操作更新指派對象。

「UpdateAssignees」動作的輸入參數

如要瞭解如何設定 UpdateAssignees 動作，請參閱動作範例。

AddGuests 動作

這項操作可讓使用者新增邀請對象。

AddGuests 動作的輸入參數

如要瞭解如何設定 AddGuests 動作，請參閱動作範例。

UploadFile 動作

這項操作可讓你上傳檔案。

UploadFile 動作的輸入參數

AddThreadComment 動作

使用者可透過這項操作在討論串中新增留言

AddThreadComment 動作的輸入參數

如要瞭解如何設定 AddThreadComment 動作，請參閱動作範例。

UpdateThread 動作

這項動作可讓您更新執行緒

UpdateThread 動作的輸入參數

如要瞭解如何設定 UpdateThread 動作，請參閱動作範例。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 取得應用程式部署狀態

這個範例會取得應用程式部署狀態。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「AppsDeployStatus」動作，然後按一下「完成」。
3. 在「連線器」任務的「任務輸入內容」部分，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "AppIds": "4"
   }

如果動作成功，AppsDeployStatus 工作的 connectorOutputPayload 回應參數會包含類似以下內容的值：

{
"AppId": "4",   "Status": "SUCCESS",   "success": "true"
}

範例 - 建立應用程式

這個範例會建立新的應用程式。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「CreateApp」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Name": "NewApp"
   }

如果動作成功，CreateApp 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"AppId": "20",   "Revision": "2",   "Success": "true"
}]

範例 - 部署應用程式

這個範例會部署應用程式

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「DeployApps」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "AppId": "19",   "Revision": "2"
   }

如果動作成功，DeployApps 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

範例 - 下載檔案

這個範例會下載應用程式中的檔案。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「DownloadFile」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

如果動作成功，DownloadFile 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

範例 - 更新指派對象

這個範例會更新指派對象。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「UpdateAssignees」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

如果動作成功，UpdateAssignees 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

範例 - 新增邀請對象

這個範例會新增邀請對象。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「AddGuests」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "GuestsAggregate": "[{\"name\":\"Testuser\",\"code\":\"testuser1@test.com\",
   \"password\":\"test@123\",\"timezone\":\"America/Los_Angeles\",
   \"company\":\"Company Name\",\"division\": \"Sales\",
   \"callto\":\"SkypeCallTo\",\"locale\":\"en\"}]"
   }

如果動作成功，AddGuests 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

範例 - 刪除邀請對象

這個範例會刪除訪客。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「DeleteGuests」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Guests": "[\"testuser1@test.com\"]"
   }

如果動作成功，DeleteGuests 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

範例 - 上傳檔案

這個範例說明如何上傳檔案。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「UploadFile」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "FileName": "GoogleCloud_Upload_File.txt",
   "AppId": "9",
   "Content": "Hello"
   }

如果動作成功，UploadFile 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"FileKey": "4e3b6ca9-0028-41c6-9662-53b151ef9b35",
"Success": "true",
"Id": null,
"Revision": null
}]

範例 - 新增討論串留言

這個範例說明如何新增討論串留言。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「AddThreadComment」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "SpaceId": 1.0,
   "ThreadId": 1.0,
   "Text": "Test Comment"
   }

如果動作成功，AddThreadComment 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Id": "3",
"Success": "true"
}]

範例 - 更新對話串

這個範例說明如何更新執行緒。

1. 在 Configure connector task 對話方塊中，按一下 Actions。
2. 選取「UpdateThread」動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "ThreadId": 1.0,
   "Name": "updated thread"
   }

如果動作成功，UpdateThread 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

實體作業範例

本節說明如何在這個連接器中執行部分實體作業。

範例 - 列出所有應用程式

1. 在 Configure connector task 對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Apps。
3. 選取 List 作業，然後按一下「完成」。
4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句，篩選結果集。請一律在單引號 (') 內指定篩選子句值。

您也可以對「記錄」和「註解」實體執行「列出」作業。

範例 - 取得應用程式

1. 在 Configure connector task 對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Apps。
3. 選取 Get 作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，按一下「EntityId」，然後在「預設值」欄位中輸入 4。

   其中 4 是 Apps 實體中的專屬記錄 ID。

您也可以對下列實體執行 Get 作業： Deploy、Record、FormFields、FormLayout、Views、GeneralSettings、ProcessManagement、AppPermission、RecordPermission、FieldPermission、GeneralNotification、PerRecordNotification、ReminderNotification、GraphSettings、ActionSettings、Space、SpaceMembers

範例 - 刪除記錄

1. 在 Configure connector task 對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Record。
3. 選取 Delete 作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下「entityId」，然後在「Default Value」(預設值) 欄位中輸入 6。

您也可以對 Comments 實體執行 Delete 作業。

範例 - 建立記錄

1. 在 Configure connector task 對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Record。
3. 選取 Create 作業，然後按一下「完成」。
4. 在「連線器」任務的「任務輸入內容」部分，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Text": "HelloDemo"
   }

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "RecordId": 29.0
   }

範例 - 更新記錄

1. 在 Configure connector task 對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Record。
3. 選取 Update 作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Text_area": "updatedemo"
   }

5. 按一下「entityId」，然後在「Default Value」欄位中輸入 22。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "RecordId": "22"
   }