Kintone

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

AppsDeployStatus action

This action gets app deployment statuses

Input parameters of the AppsDeployStatus action

For example on how to configure the AppsDeployStatus action, see Action examples.

CreateApp action

This action creates apps.

Input parameters of the CreateApp action

For example on how to configure the CreateApp action, see Action examples.

DeleteGuests action

This action let users Delete Guests.

Input parameters of the DeleteGuests action

For example on how to configure the DeleteGuests action, see Action examples.

DeployApps action

This action lets you deploy apps.

Input parameters of the DeployApps action

For example on how to configure the DeployApps action, see Action examples.

DownloadFile action

This action let users download files from an attachment field in an app.

Input parameters of the DownloadFile action

For example on how to configure the DownloadFile action, see Action examples.

UpdateAssignees action

This action let users update assignees.

Input parameters of the UpdateAssignees action

For example on how to configure the UpdateAssignees action, see Action examples.

AddGuests action

This action let users add Guests.

Input parameters of the AddGuests action

For example on how to configure the AddGuests action, see Action examples.

UploadFile action

This action lets you upload a file.

Input parameters of the UploadFile action

AddThreadComment action

This action let users add comments in thread

Input parameters of the AddThreadComment action

For example on how to configure the AddThreadComment action, see Action examples.

UpdateThread action

This action let you update a thread

Input parameters of the UpdateThread action

For example on how to configure the UpdateThread action, see Action examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Get app deployment status

This example gets the app deployment status.

1. In the Configure connector task dialog, click Actions.
2. Select the AppsDeployStatus action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "AppIds": "4"
   }
   

If the action is successful, the AppsDeployStatus task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Create an app

This example creates a new app.

1. In the Configure connector task dialog, click Actions.
2. Select the CreateApp action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Name": "NewApp"
   }

If the action is successful, the CreateApp task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Deploy an app

This example deploys an app

1. In the Configure connector task dialog, click Actions.
2. Select the DeployApps action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the DeployApps task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Download a file

This example downloads a file present in an app.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadFile action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

If the action is successful, the DownloadFile task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Update an assignee

This example updates an assignee.

1. In the Configure connector task dialog, click Actions.
2. Select the UpdateAssignees action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

If the action is successful, the UpdateAssignees task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Add a guest

This example adds a guest.

1. In the Configure connector task dialog, click Actions.
2. Select the AddGuests action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the AddGuests task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Delete a guest

This example deletes a guest.

1. In the Configure connector task dialog, click Actions.
2. Select the DeleteGuests action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the DeleteGuests task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Upload a file

This example shows how to upload a file.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadFile action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the UploadFile task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Add a thread comment

This example shows how to add a thread comment.

1. In the Configure connector task dialog, click Actions.
2. Select the AddThreadComment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the AddThreadComment task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Update a thread

This example shows how to update a thread.

1. In the Configure connector task dialog, click Actions.
2. Select the UpdateThread action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the UpdateThread task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all apps

1. In the Configure connector task dialog, click Entities.
2. Select Apps from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').

Example - Get an app

1. In the Configure connector task dialog, click Entities.
2. Select Apps from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 4 in the Default Value field.

   Here, 4 is a unique record ID in the Apps entity.

Example - Delete a record

1. In the Configure connector task dialog, click Entities.
2. Select Record from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 6 in the Default Value field.

Example - Create a record

1. In the Configure connector task dialog, click Entities.
2. Select Record from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Text": "HelloDemo"
   }

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
   "RecordId": 29.0
   }

Example - Update a record

1. In the Configure connector task dialog, click Entities.
2. Select Record from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Text_area": "updatedemo"
   }

5. Click entityId, and then enter 22 in the Default Value field.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
   "RecordId": "22"
   }