Kintone

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

  Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
  • List
  • Get
  • Create
  • Update
  • Delete

  Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Actions

Dans cette section, vous trouverez la liste des actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action AppsDeployStatus

Cette action permet d'obtenir les états de déploiement des applications.

Paramètres d'entrée de l'action AppsDeployStatus

Pour savoir comment configurer l'action AppsDeployStatus, consultez Exemples d'actions.

Action CreateApp

Cette action crée des applications.

Paramètres d'entrée de l'action CreateApp

Pour savoir comment configurer l'action CreateApp, consultez Exemples d'actions.

Action DeleteGuests

Cette action permet aux utilisateurs de supprimer des invités.

Paramètres d'entrée de l'action DeleteGuests

Pour savoir comment configurer l'action DeleteGuests, consultez Exemples d'actions.

Action DeployApps

Cette action permet de déployer des applications.

Paramètres d'entrée de l'action DeployApps

Pour savoir comment configurer l'action DeployApps, consultez Exemples d'actions.

Action DownloadFile

Cette action permet aux utilisateurs de télécharger des fichiers à partir d'un champ d'ajout de pièce jointe dans une application.

Paramètres d'entrée de l'action DownloadFile

Pour savoir comment configurer l'action DownloadFile, consultez Exemples d'actions.

Action UpdateAssignees

Cette action permet aux utilisateurs de modifier les personnes responsables.

Paramètres d'entrée de l'action UpdateAssignees

Pour savoir comment configurer l'action UpdateAssignees, consultez Exemples d'actions.

Action AddGuests

Cette action permet aux utilisateurs d'ajouter des invités.

Paramètres d'entrée de l'action AddGuests

Pour savoir comment configurer l'action AddGuests, consultez Exemples d'actions.

Action UploadFile

Cette action permet d'importer un fichier.

Paramètres d'entrée de l'action UploadFile

Action AddThreadComment

Cette action permet aux utilisateurs d'ajouter des commentaires dans le fil de discussion.

Paramètres d'entrée de l'action AddThreadComment

Pour savoir comment configurer l'action AddThreadComment, consultez Exemples d'actions.

Action UpdateThread

Cette action permet de mettre à jour un fil de discussion.

Paramètres d'entrée de l'action UpdateThread

Pour savoir comment configurer l'action UpdateThread, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Obtenir l'état de déploiement de l'application

Cet exemple obtient l'état de déploiement de l'application.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action AppsDeployStatus, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "AppIds": "4"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche AppsDeployStatus aura une valeur semblable à la suivante :

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

Exemple : Créer une application

Cet exemple crée une application.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CreateApp, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Name": "NewApp"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CreateApp aura une valeur semblable à la suivante :

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

Exemple : Déployer une application

Cet exemple déploie une application.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DeployApps, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DeployApps aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Télécharger un fichier

Cet exemple télécharge un fichier présent dans une application.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DownloadFile, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DownloadFile aura une valeur semblable à la suivante :

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

Exemple : Mettre à jour une personne responsable

Cet exemple met à jour une personne responsable.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UpdateAssignees, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UpdateAssignees aura une valeur semblable à la suivante :

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

Exemple : Ajouter un invité

Cet exemple ajoute un invité.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action AddGuests, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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 l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche AddGuests aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Supprimer un invité

Cet exemple supprime un invité.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DeleteGuests, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DeleteGuests aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Importer un fichier

Cet exemple montre comment importer un fichier.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UploadFile, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UploadFile aura une valeur semblable à la suivante :

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

Exemple : Ajouter un commentaire à un fil de discussion

Cet exemple montre comment ajouter un commentaire à un fil de discussion.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action AddThreadComment, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche AddThreadComment aura une valeur semblable à la suivante :

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

Exemple : Mettre à jour un fil de discussion

Cet exemple montre comment mettre à jour un fil de discussion.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UpdateThread, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UpdateThread aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister toutes les applications

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Apps dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Indiquez toujours la valeur de la clause de filtre entre guillemets simples (').

Vous pouvez également effectuer l'opération List sur les entités "Record" et "Comments".

Exemple : Obtenir une application

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Apps dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 4 dans le champ Valeur par défaut.

   Ici, 4 est un ID d'enregistrement unique dans l'entité Apps.

Vous pouvez également effectuer l'opération Get sur les entités suivantes : Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space et SpaceMembers.

Exemple : Supprimer un enregistrement

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Record dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 6 dans le champ Valeur par défaut.

Vous pouvez également effectuer l'opération Delete sur les entités "Comments".

Exemple : Créer un enregistrement

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Record dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Text": "HelloDemo"
   }

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "RecordId": 29.0
   }

Exemple : Mettre à jour un enregistrement

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Record dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Text_area": "updatedemo"
   }

5. Cliquez sur entityId, puis saisissez 22 dans le champ Valeur par défaut.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "RecordId": "22"
   }