Kintone

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

• Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

  Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

• Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keine der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Operations-Liste aufgeführt.

• Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Aktionen

In diesem Abschnitt werden die vom Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

Aktion „AppsDeployStatus“

Mit dieser Aktion werden App-Bereitstellungsstatus abgerufen

Eingabeparameter der AppsDeployStatus-Aktion

Beispiele für die Konfiguration der AppsDeployStatus-Aktion finden Sie unter Beispiele für Aktionen.

CreateApp-Aktion

Mit dieser Aktion werden Apps erstellt.

Eingabeparameter der CreateApp-Aktion

Beispiele für die Konfiguration der CreateApp-Aktion finden Sie unter Beispiele für Aktionen.

DeleteGuests-Aktion

Mit dieser Aktion können Nutzer Gäste löschen.

Eingabeparameter der Aktion „DeleteGuests“

Beispiele für die Konfiguration der DeleteGuests-Aktion finden Sie unter Beispiele für Aktionen.

„DeployApps“-Aktion

Mit dieser Aktion können Sie Apps bereitstellen.

Eingabeparameter der Aktion „DeployApps“

Beispiele für die Konfiguration der DeployApps-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „DownloadFile“

Mit dieser Aktion können Nutzer Dateien aus einem Feld für Anhänge in einer App herunterladen.

Eingabeparameter der Aktion „DownloadFile“

Beispiele für die Konfiguration der DownloadFile-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „UpdateAssignees“

Mit dieser Aktion können Nutzer Zuweisungen aktualisieren.

Eingabeparameter der Aktion „UpdateAssignees“

Beispiele für die Konfiguration der UpdateAssignees-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „AddGuests“

Mit dieser Aktion können Nutzer Gäste hinzufügen.

Eingabeparameter der Aktion „AddGuests“

Beispiele für die Konfiguration der AddGuests-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „UploadFile“

Mit dieser Aktion können Sie eine Datei hochladen.

Eingabeparameter der Aktion „UploadFile“

AddThreadComment-Aktion

Durch diese Aktion können Nutzer Kommentare in einem Thread hinzufügen.

Eingabeparameter der Aktion „AddThreadComment“

Beispiele für die Konfiguration der Aktion AddThreadComment finden Sie unter Beispiele für Aktionen.

Aktion „UpdateThread“

Mit dieser Aktion können Sie einen Thread aktualisieren.

Eingabeparameter der Aktion „UpdateThread“

Ein Beispiel für die Konfiguration der UpdateThread-Aktion finden Sie unter Beispiele für Aktionen.

Beispiele für Aktionen

In diesem Abschnitt wird beschrieben, wie Sie einige der Aktionen in diesem Connector ausführen.

Beispiel – App-Bereitstellungsstatus abrufen

In diesem Beispiel wird der App-Bereitstellungsstatus abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion AppsDeployStatus aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "AppIds": "4"
   }

Wenn die Aktion erfolgreich ist, hat der connectorOutputPayload-Antwortparameter der AppsDeployStatus-Aufgabe einen Wert, der dem folgenden ähnelt:

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

Beispiel: App erstellen

In diesem Beispiel wird eine neue App erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CreateApp aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "Name": "NewApp"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des CreateApp-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: App bereitstellen

In diesem Beispiel wird eine App bereitgestellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DeployApps aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des DeployApps-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiel: Datei herunterladen

In diesem Beispiel wird eine Datei heruntergeladen, die in einer App vorhanden ist.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DownloadFile aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des DownloadFile-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Zuständige Person aktualisieren

In diesem Beispiel wird ein Zuweisungsempfänger aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion UpdateAssignees aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des UpdateAssignees-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Einen Gast hinzufügen

In diesem Beispiel wird ein Gast hinzugefügt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion AddGuests aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des AddGuests-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiel: Gast löschen

In diesem Beispiel wird ein Gast gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DeleteGuests aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des DeleteGuests-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiel: Datei hochladen

In diesem Beispiel wird gezeigt, wie Sie eine Datei hochladen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion UploadFile aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des UploadFile-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Kommentar-Thread hinzufügen

In diesem Beispiel wird gezeigt, wie Sie einen Thread-Kommentar hinzufügen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion AddThreadComment aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des AddThreadComment-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Konversation aktualisieren

In diesem Beispiel wird gezeigt, wie ein Thread aktualisiert wird.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion UpdateThread aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des UpdateThread-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Beispiel: Alle Apps auflisten

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Apps aus der Liste Entity aus.
3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors das Ergebnisset filtern, indem Sie eine Filterklausel angeben. Geben Sie den Wert der Filterklausel immer in einfachen Anführungszeichen (') an.

Sie können den List-Vorgang auch für die Einheiten „Record“ und „Comments“ ausführen.

Beispiel: App herunterladen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Apps aus der Liste Entity aus.
3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 4 in das Feld Standardwert ein.

   Dabei ist 4 eine eindeutige Datensatz-ID in der Apps-Entität.

Sie können den Vorgang „Get“ auch für die folgenden Entitäten ausführen: Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space, SpaceMembers

Beispiel: Eintrag löschen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Record aus der Liste Entity aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 6 in das Feld Standardwert ein.

Sie können den Vorgang „Löschen“ auch für die Kommentare-Entitäten ausführen.

Beispiel: Eintrag erstellen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Record aus der Liste Entity aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "Text": "HelloDemo"
   }

   Wenn Sie dieses Beispiel ausführen, wird eine Antwort ähnlich der folgenden in der Ausgabevariable connectorOutputPayload des Connector-Tasks zurückgegeben:

   {
   "RecordId": 29.0
   }

Beispiel: Datensatz aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Record aus der Liste Entity aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "Text_area": "updatedemo"
   }

5. Klicken Sie auf entityId und geben Sie dann 22 in das Feld Standardwert ein.

   Wenn Sie dieses Beispiel ausführen, wird eine Antwort ähnlich der folgenden in der Ausgabevariable connectorOutputPayload des Connector-Tasks zurückgegeben:

   {
   "RecordId": "22"
   }