Kintone

Entidades, operaciones y acciones

Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección se enumeran las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción AppsDeployStatus

Esta acción obtiene los estados de implementación de aplicaciones.

Parámetros de entrada de la acción AppsDeployStatus

Para ver un ejemplo de cómo configurar la acción AppsDeployStatus, consulta Ejemplos de acciones.

Acción CreateApp

Esta acción crea aplicaciones.

Parámetros de entrada de la acción CreateApp

Para ver un ejemplo de cómo configurar la acción CreateApp, consulta Ejemplos de acciones.

Acción DeleteGuests

Esta acción permite a los usuarios eliminar invitados.

Parámetros de entrada de la acción DeleteGuests

Para ver un ejemplo de cómo configurar la acción DeleteGuests, consulta Ejemplos de acciones.

Acción DeployApps

Esta acción te permite implementar aplicaciones.

Parámetros de entrada de la acción DeployApps

Para ver un ejemplo de cómo configurar la acción DeployApps, consulta Ejemplos de acciones.

Acción DownloadFile

Esta acción permite a los usuarios descargar archivos de un campo de archivo adjunto en una aplicación.

Parámetros de entrada de la acción DownloadFile

Para ver un ejemplo de cómo configurar la acción DownloadFile, consulta Ejemplos de acciones.

Acción UpdateAssignees

Esta acción permite a los usuarios actualizar los asignatarios.

Parámetros de entrada de la acción UpdateAssignees

Para ver un ejemplo de cómo configurar la acción UpdateAssignees, consulta Ejemplos de acciones.

Acción AddGuests

Esta acción permite a los usuarios añadir invitados.

Parámetros de entrada de la acción AddGuests

Para ver un ejemplo de cómo configurar la acción AddGuests, consulta Ejemplos de acciones.

Acción UploadFile

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadFile

Acción AddThreadComment

Esta acción permite a los usuarios añadir comentarios en un hilo

Parámetros de entrada de la acción AddThreadComment

Para ver un ejemplo de cómo configurar la acción AddThreadComment, consulta los ejemplos de acciones.

Acción UpdateThread

Esta acción te permite actualizar una conversación

Parámetros de entrada de la acción UpdateThread

Para ver un ejemplo de cómo configurar la acción UpdateThread, consulte Ejemplos de acciones.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: Obtener el estado de implementación de una aplicación

En este ejemplo se obtiene el estado de implementación de la aplicación.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción AppsDeployStatus y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "AppIds": "4"
   }

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea AppsDeployStatus tendrá un valor similar al siguiente:

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

Ejemplo: crear una aplicación

En este ejemplo se crea una aplicación.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción CreateApp y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Name": "NewApp"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea CreateApp tendrá un valor similar al siguiente:

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

Ejemplo: desplegar una aplicación

En este ejemplo se despliega una aplicación

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DeployApps y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DeployApps tendrá un valor similar al siguiente:

[{
"Success": "true"
}]

Ejemplo: descargar un archivo

En este ejemplo se descarga un archivo presente en una aplicación.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DownloadFile y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DownloadFile tendrá un valor similar al siguiente:

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

Ejemplo: actualizar un asignatario

En este ejemplo se actualiza un asignatario.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UpdateAssignees y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UpdateAssignees tendrá un valor similar al siguiente:

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

Ejemplo: Añadir un invitado

En este ejemplo se añade un invitado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción AddGuests y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo 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\"}]"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea AddGuests tendrá un valor similar al siguiente:

[{
"Success": "true"
}]

Ejemplo: Eliminar un invitado

En este ejemplo se elimina un invitado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DeleteGuests y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DeleteGuests tendrá un valor similar al siguiente:

[{
"Success": "true"
}]

Ejemplo: subir un archivo

En este ejemplo se muestra cómo subir un archivo.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UploadFile y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UploadFile tendrá un valor similar al siguiente:

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

Ejemplo: añadir un comentario a una conversación

En este ejemplo se muestra cómo añadir un comentario en un hilo.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción AddThreadComment y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea AddThreadComment tendrá un valor similar al siguiente:

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

Ejemplo: actualizar una conversación

En este ejemplo se muestra cómo actualizar una conversación.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UpdateThread y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UpdateThread tendrá un valor similar al siguiente:

[{
"Success": "true"
}]

Ejemplos de operaciones de entidades

En esta sección se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: listar todas las aplicaciones

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Apps en la lista Entity.
3. Selecciona la operación List y, a continuación, haz clic en Hecho.
4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el conjunto de resultados especificando una cláusula de filtro. Especifica siempre el valor de la cláusula de filtro entre comillas simples (').

También puedes realizar la operación List en las entidades Record y Comments.

Ejemplo: obtener una aplicación

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Apps en la lista Entity.
3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca 4 en el campo Valor predeterminado.

   En este caso, 4 es un ID de registro único de la entidad Apps.

También puedes realizar la operación Get en las siguientes entidades: Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space, SpaceMembers

Ejemplo: eliminar un registro

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Record en la lista Entity.
3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 6 en el campo Valor predeterminado.

También puedes realizar la operación de eliminación en las entidades de comentarios.

Ejemplo: crear un registro

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Record en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Text": "HelloDemo"
   }

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "RecordId": 29.0
   }

Ejemplo: actualizar un registro

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Record en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Text_area": "updatedemo"
   }

5. Haga clic en entityId y, a continuación, introduzca 22 en el campo Valor predeterminado.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "RecordId": "22"
   }