Kintone

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，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. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Name": "NewApp"
   }

如果操作成功，CreateApp 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

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

示例 - 部署应用

此示例部署了一个应用

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DeployApps 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

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

如果操作成功，DeployApps 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Success": "true"
}]

示例 - 下载文件

此示例会下载应用中存在的文件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DownloadFile 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 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. 在连接器任务的任务输入部分中，点击 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. 在连接器任务的任务输入部分中，点击 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. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

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

如果操作成功，DeleteGuests 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Success": "true"
}]

示例 - 上传文件

此示例展示了如何上传文件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UploadFile 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 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. 在连接器任务的任务输入部分中，点击 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. 在连接器任务的任务输入部分中，点击 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. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 6。

您也可以对 Comments 实体执行删除操作。

示例 - 创建记录

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. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Text_area": "updatedemo"
   }

5. 点击 entityId，然后在默认值字段中输入 22。

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
   "RecordId": "22"
   }