Box

Beispiele für Verbindungskonfigurationen

In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder aufgeführt, die Sie beim Erstellen der Verbindung konfigurieren.

Verbindungstyp für die Methode „OAuth-JWT-Token“

Sie können über das Box-Konto auf die Client-ID, den Clientschlüssel, die Box-Anwendung-Zugriffsebene und die Unternehmens-ID/Nutzer-ID zugreifen.

Sie können über die heruntergeladene Datei Private keypair.json auf den privaten Schlüssel und das Passwort für den privaten Schlüssel zugreifen. Weitere Informationen finden Sie unter Informationen zu öffentlichen und privaten Schlüsselpaaren. Bevor Sie das Passwort für den privaten Schlüssel übergeben, ersetzen Sie das \n in der Datei json durch eine neue Zeile.

Verbindungstyp „OAuth-Autorisierungscode“

Informationen zur Box-OAuth-Konfiguration finden Sie unter OAuth-Anwendung erstellen.

Box-JSON für den Verbindungstyp „JWT-Authentifizierung“

Sie können das Box-Konto verwenden, um Box Json für die JWT-Authentifizierung einzurichten. Informationen zum Einrichten von Box Json für JWT finden Sie unter Schritte zum Erstellen von JWT-Tokens .

Rufen Sie den Wert für die JWT-Authentifizierung für Box aus der heruntergeladenen Datei Private keypair.json ab. Weitere Informationen finden Sie unter Informationen zu öffentlichen und privaten Schlüsselpaaren. Sie müssen den gesamten Inhalt der Datei .json im Feld Box Json for JWT Auth (Box-JSON für JWT-Authentifizierung) übergeben.

Verbindungstyp „OAuth-Clientanmeldedaten“

Sie können über das Box-Konto auf die Client-ID, das Client-Secret, die Zugriffsebene der Box-Anwendung und die Unternehmens-ID/Nutzer-ID zugreifen.

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 alle Aktionen aufgeführt, die von der Box-Verbindung unterstützt werden.

Aktion „DownloadFile“

Mit dieser Aktion können Sie eine Datei aus Ihrer Box-Instanz herunterladen.

Eingabeparameter der Aktion „DownloadFile“

Ausgabeparameter der Aktion „DownloadFile“

Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.

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

Aktion „UploadFile“

Mit dieser Aktion können Sie eine Datei in Ihre Box-Instanz hochladen.

Eingabeparameter der Aktion „UploadFile“

Ausgabeparameter der Aktion „UploadFile“

Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.

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

Aktion „CopyFile“

Mit dieser Aktion können Sie eine Datei aus Ihrer Box-Instanz kopieren.

Eingabeparameter der Aktion „CopyFile“

Ausgabeparameter der Aktion „CopyFile“

Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.

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

Aktion „CopyFolder“

Mit dieser Aktion können Sie einen gesamten Ordner aus Ihrer Box-Instanz kopieren.

Eingabeparameter der Aktion „CopyFolder“

Ausgabeparameter der Aktion „CopyFolder“

Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.

Beispiele für die Konfiguration der CopyFolder-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: Datei herunterladen

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:

   {
   "FileID": "1283194869422", 
   "HasBytes": true
   }

In diesem Beispiel wird eine Datei als Base64-codierter String heruntergeladen. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

Beispiel: 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:

   {
   "ParentId": "0",
   "Content": "12345"
   }

In diesem Beispiel werden String-Inhalte als Datei hochgeladen. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

Beispiel: Datei kopieren

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CopyFile 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 das Feld Default Value ein:

   {
   "FileID": "1288751886061",
   "DestinationFolderId": "219105724517", 
   "NewName": "NewCopiedFile"
   }

In diesem Beispiel wird die Datei mit der ID 1288751886061 in den Ordner mit der ID 219105724517 kopiert. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"ID": "1308006018536"
}]

Beispiel: Ordner kopieren

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CopyFolder 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:

   {
   "FolderID": "218475301279",
   "DestinationFolderId": "0", 
   "NewName": "NewCopiedFolder"
   }

In diesem Beispiel wird der Ordner mit der ID 218475301279 in den Ordner mit der ID 219105724517 kopiert. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"ID": "226312444517"
}]

Beispiele für Entitätsvorgänge

Beispiel: Alle Dateien auflisten

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Entity-Liste „Dateien“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.

Sie können den LIST-Vorgang für die folgenden Entitäten ausführen: Folders, TrashedItems, SharedItems, Collaborations, TaskAssignments und Tasks.

Beispiel: Dateien abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Dateien“ aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Legen Sie die Entitäts-ID auf 1262397830475 fest. Das ist der Schlüssel, der übergeben werden soll. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 1262397830475 in das Feld Standardwert ein.

Der Wert für die Entitäts-ID muss direkt übergeben werden, z. B. 1262397830475. Dabei ist 1262397830475 der eindeutige Primärschlüsselwert.

Sie können den GET-Vorgang für die folgenden Entitäten ausführen: Folders, SharedItems, Collaborations, TaskAssignments und Tasks.

Beispiel: Dateien löschen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Dateien“ aus.
3. Wählen Sie den Vorgang DELETE aus und klicken Sie auf Fertig.
4. Legen Sie die Entitäts-ID auf 1258725940971 fest. Der Schlüssel muss übergeben werden. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 1258725940971 in das Feld Standardwert ein.

   Wenn die Entität zwei zusammengesetzte Unternehmens- oder Primärschlüssel hat, können Sie anstelle der entityId auch die filterClause auf Id='1258725940971' festlegen.

Sie können den Vorgang „LÖSCHEN“ für die folgenden Entitäten ausführen: Ordner, Aufgaben, Zusammenarbeit, freigegebene Elemente und Aufgabenzuweisungen.

Beispiel: Ordner erstellen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Ordner“ 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:

   {
   "Name": "Google Cloud Platforms_created_folders",
   "ParentId": "0"
   }

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

    
   {
   "Id": "222269371053"
   } 

Beispiel: Gemeinschaftsprojekte erstellen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option „Zusammenarbeit“ 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:

   {
   "ItemId": "216592737829",
   "ItemType": "folder",
   "AccessibleById": "27370766275",
   "AccessibleByType": "user",
   "AccessibleByLogin": "baklavainthebalkans@gmail.com",
   "Role": "editor"
   }

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

   {
   "Success": false
   } 

Beispiel: Aufgaben erstellen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Aufgaben“ 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:

   {
   "ItemId": "1253997361112",
   "ItemType": "file",
   "Action": "review",
   "Message": "Creating a task from Google Cloud Platform",
   "DueAt": "2023-12-12 09:01:15.0",
   "CompletionRule": "all_assignees"
   }

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

    
   {
   "Id": "1253997361112"
   }

Beispiel – Aufgabenzuweisungen erstellen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie „TaskAssignments“ aus der Entity-Liste 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:

   {
   "TaskId": "21507516872",
   "AssignedToId": "27370766275"
   }

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

    
   {
   "Id": "50804351753"
   }

Beispiel: Dateien aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Dateien“ 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:

   {
   "Name": "Get Started with Box Files.pdf"
   }

5. Legen Sie die Entitäts-ID auf 1253997361112 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 1253997361112 in das Feld Standardwert ein.

   Anstelle der entityId können Sie auch die filterClause auf 1253997361112 festlegen.

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

   {
   "Id": "1253997361112"
   }

Sie können den UPDATE-Vorgang für die folgenden Entitäten ausführen: Folders, Tasks, Collaborations, SharedItems und TaskAssignments.

Beispiel: Ordner aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Ordner“ 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:

   {
   "Name": "Demo Update"
   }

5. Legen Sie die Entitäts-ID auf 216457668125 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 216457668125 in das Feld Standardwert ein.

   Anstelle der entityId können Sie auch die filterClause auf 216457668125 festlegen.

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

   {
   "Id": "216457668125"
   } 

Beispiel: Gemeinschaftsprojekte aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option „Zusammenarbeit“ 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:

   {
   "Role": "Viewer"
   }

5. Legen Sie die Entitäts-ID auf 46685648757 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 46685648757 in das Feld Standardwert ein.

   Anstelle der entityId können Sie auch die filterClause auf 46685648757 festlegen.

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

   {
   
   }

Beispiel: Aufgaben aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Aufgaben“ 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:

   {
   "Message": "This is a new task is updated and assigned to you by me"
   }

5. Legen Sie die Entitäts-ID auf 21507516872 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 21507516872 in das Feld Standardwert ein.

   Anstelle der entityId können Sie auch die filterClause auf 21507516872 festlegen.

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

   {
   "Id": "21507516872"
   }

Beispiel: Zuweisungen von Aufgaben aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie „TaskAssignments“ aus der Entity-Liste 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:

   {
   "Message": "Looks good to me",
   "ResolutionState": "completed"
   }

5. Legen Sie die Entitäts-ID auf 49542929469 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 49542929469 in das Feld Standardwert ein.

   Anstelle der entityId können Sie auch die filterClause auf 49542929469 festlegen.

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

   {
   "Id": "49542929469"
   } 

Beispiel: Transferordner aktualisieren

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Ordner“ 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:

   {
   "Name": "Demo Update"
   "ParentId": "216596059374"
   }

5. Legen Sie die Entitäts-ID auf 216457668125 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 216457668125 in das Feld Standardwert ein.

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

   {
   "Id": "216457668125"
   }