Um mit einem Box®-Antrieb zu interagieren, fügen Sie einen Schritt in eine Kette ein, die einen Box-Verbindungsbefehl verwendet. Hier einige Beispiele:
- Dateien hochladen, herunterladen, verschieben, suchen oder löschen
- Erstellen und Löschen von Ordnern
- Abrufen von Datei- und Ordner-URLs
Um diese Befehle zu aktivieren, erstellt ein IT-Administrator zunächst einen Box-Connector.
Datei kopieren
Um eine Datei in Box zu kopieren, verwenden Sie den Befehl Datei kopieren .
Äquivalenter API-Aufruf: https://developer.box.com/reference/post-file-requests-id-copy/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei-ID |
Geben Sie die ID der zu kopierenden Datei ein. |
| Dateiname |
Geben Sie den Namen der zu kopierenden Datei ein. Optional, wenn Sie File IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der die zu kopierende Datei enthält. Optional, wenn Sie File IDeingeben. |
| Zielordner-ID |
Geben Sie die ID des Zielordners ein, in den die Datei kopiert werden soll (optional). Geben Sie für die Wurzel 0ein. |
| Name des Zielordners |
Geben Sie den Namen des Ordners ein, in den kopiert werden soll. Optional, wenn Sie Zielordner-IDeingeben. |
| Name |
Um die Kopie der Datei umzubenennen, geben Sie ihren Namen ein (optional). |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Datei |
JSON |
| Datei-ID |
Zeichenfolge |
Codes für die Beendigung
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Ordner kopieren
Um einen Ordner in Box zu kopieren, verwenden Sie den Befehl Ordner kopieren .
Äquivalenter API-Aufruf: https://developer.box.com/guides/folders/single/copy/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Ordner-ID |
Geben Sie die ID des zu kopierenden Ordners ein. |
| Name des Ordners |
Geben Sie den Namen des zu kopierenden Ordners ein. Optional, wenn Sie Folder IDeingeben. |
| Zielordner-ID |
Geben Sie die ID des Ordners ein, in dem die Kopie gespeichert werden soll. |
| Name des Zielordners |
Geben Sie den Namen des Ordners ein, in dem die Kopie gespeichert werden soll. Optional, wenn Sie Zielordner-IDeingeben. |
| Neuer Ordnername |
Um die Kopie der Datei umzubenennen, geben Sie ihren Namen ein (optional). |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Ordner |
JSON |
| Ordner-ID |
Zeichenfolge |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Ordner erstellen
Um einen Ordner in Box zu erstellen, verwenden Sie den Befehl Ordner erstellen .
Äquivalenter API-Aufruf: https://developer.box.com/guides/folders/single/create/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Name des Ordners |
Geben Sie den Namen des neuen Ordners ein. |
| Zielordner-ID |
Geben Sie die ID des Zielordners ein. Geben Sie für die Wurzel 0ein. |
| Name des Zielordners |
Geben Sie den Namen des Zielordners ein (optional). |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Ordner |
JSON |
| Ordner-ID |
Zeichenfolge |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Datei löschen
Um eine Datei in Box zu löschen, verwenden Sie den Befehl Datei löschen .
Äquivalenter API-Aufruf: https://developer.box.com/guides/file-requests/delete/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei-ID |
Geben Sie die ID der zu löschenden Datei ein |
| Dateiname |
Geben Sie den Namen der zu löschenden Datei ein. Optional, wenn Sie File IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der die zu löschende Datei enthält. Optional, wenn Sie File IDeingeben. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Datei-ID |
Zeichenfolge |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Ordner löschen
Um einen Ordner in Box zu löschen, verwenden Sie den Befehl Ordner löschen .
Äquivalenter API-Aufruf: https://developer.box.com/guides/folders/single/delete/
Eingaben
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Ordner-ID |
Geben Sie die ID des zu löschenden Ordners ein |
| Name des Ordners |
Geben Sie den Namen des zu löschenden Ordners ein. Optional, wenn Sie Folder IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der den zu löschenden Ordner enthält. Optional, wenn Sie Folder IDeingeben. |
| Rekursiv |
Aktivieren Sie dieses Kontrollkästchen, um Ordner rekursiv zu löschen, wenn sie Objekte enthalten. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Ordner-ID |
Zeichenfolge |
Codes für die Beendigung
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Datei herunterladen
Um eine Datei von Box herunterzuladen, verwenden Sie den Befehl Datei herunterladen .
Äquivalenter API-Aufruf: https://developer.box.com/guides/downloads/file/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei-ID |
Geben Sie die ID der Datei ein, die Sie herunterladen möchten. |
| Dateiname |
Geben Sie den Namen der Datei ein, die Sie herunterladen möchten. Optional, wenn Sie File IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der die herunterzuladende Datei enthält. Optional, wenn Sie File IDeingeben. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Linien |
Ganzzahl |
| Datei |
Datei |
Codes für die Beendigung
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Dateiinformationen abrufen
Um Metadaten über eine Datei in Box abzurufen, verwenden Sie den Befehl Get file info .
Äquivalenter API-Aufruf: https://developer.box.com/reference/get-files-id/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei-ID |
Geben Sie die ID der Datei ein, für die Metadaten gesucht werden sollen. |
| Dateiname |
Geben Sie den Namen der Datei ein, für die Metadaten gesucht werden sollen. Optional, wenn Sie File IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der die Datei enthält, für die Metadaten gesucht werden sollen. Optional, wenn Sie File IDeingeben. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Datei-Infos |
JSON |
| Datei-ID |
Zeichenfolge |
Codes für den Ausgang
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Ordnerinformationen abrufen
Um Metadaten über einen Ordner in Box abzurufen, verwenden Sie den Befehl Get folder info .
Äquivalenter API-Aufruf: https://developer.box.com/reference/get-folders-id/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Ordner-ID |
Geben Sie die ID des Ordners ein, für den Sie Metadaten abrufen möchten. |
| Name des Ordners |
Geben Sie den Namen des Ordners ein, für den Sie Metadaten abrufen möchten. Optional, wenn Sie Folder IDeingeben. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Ordner-Infos |
JSON |
Codes für den Ausgang
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Ordnerelemente abrufen
Um alle Elemente innerhalb eines Ordners in Box abzurufen, verwenden Sie den Befehl Get folder items .
Äquivalenter API-Aufruf: https://developer.box.com/reference/get-folders-id-items/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Ordner-ID |
Geben Sie die ID des Ordners ein, aus dem Elemente abgerufen werden sollen. |
| Name des Ordners |
Geben Sie den Namen des Ordners ein, aus dem Elemente abgerufen werden sollen. Optional, wenn Sie Folder IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der den Ordner enthält, aus dem Elemente abgerufen werden sollen. Optional, wenn Sie Folder IDeingeben. |
| Richtung |
Wählen Sie die Sortierreihenfolge für Ordnereinträge. |
| Grenzwert |
Geben Sie das Limit für zurückgegebene Einträge ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Summe |
Ganzzahl |
| Eingaben |
JSON |
Codes für den Ausgang
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Suchen
Um in Box nach einem Objekt zu suchen, verwenden Sie den Befehl Search .
Äquivalenter API-Aufruf: https://developer.box.com/guides/search/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Abfrage |
Geben Sie die Suchanfrage ein. |
| Dateierweiterungen |
Geben Sie die Dateierweiterungen ein, auf die die Suchergebnisse beschränkt werden sollen. |
| Typ |
Wählen Sie die Art von Objekten aus, nach denen Sie suchen möchten. Für alle Typen, leer lassen. |
| Grenzwert |
Geben Sie die Anzahl der Ergebnisse ein, die zurückgegeben werden sollen. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Eingaben |
JSON |
| Summe |
Ganzzahl |
Codes für die Beendigung
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Dateiinformationen aktualisieren
Um den Namen, die Beschreibung oder den übergeordneten Ordner einer Datei in Box zu aktualisieren, verwenden Sie den Befehl Update file info .
Äquivalenter API-Aufruf: https://developer.box.com/guides/file-requests/update/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei-ID |
Geben Sie die ID der zu aktualisierenden Datei ein. |
| Dateiname |
Geben Sie den Namen der zu aktualisierenden Datei ein. Optional, wenn Sie File IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der die zu aktualisierende Datei enthält. Optional, wenn Sie File IDeingeben. |
| Name |
Geben Sie den neuen Namen der Datei ein. |
| Beschreibung |
Geben Sie die Beschreibung der Datei ein. |
| Zielordner-ID |
Geben Sie die ID des Ordners ein, in den die Datei verschoben werden soll (optional). |
| Name des Zielordners |
Geben Sie den Namen des Ordners ein, in den die Datei verschoben werden soll. Optional, wenn Sie Zielordner-IDeingeben. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Datei |
JSON |
| Datei-ID |
Zeichenfolge |
Codes für die Beendigung
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Ordner aktualisieren
Um den Namen, die Beschreibung oder den übergeordneten Ordner eines Ordners in Box zu aktualisieren, verwenden Sie den Befehl Ordner aktualisieren .
Äquivalenter API-Aufruf: https://developer.box.com/reference/put-folders-id/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Ordner-ID |
Geben Sie die ID des zu aktualisierenden Ordners ein. |
| Name des Ordners |
Geben Sie den Namen des zu aktualisierenden Ordners ein. Optional, wenn Sie Folder IDeingeben. |
| Zielordner-ID |
Geben Sie die ID des Ordners ein, in den der Ordner verschoben werden soll (optional). Geben Sie für die Wurzel 0ein. |
| Name des Zielordners |
Geben Sie den Namen des Ordners ein, in den der Ordner verschoben werden soll. Optional, wenn Sie Zielordner-IDeingeben. |
| Name |
Geben Sie den neuen Namen des Ordners ein. |
| Beschreibung |
Geben Sie die Beschreibung des Ordners ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Ordner |
JSON |
Codes der Ausfahrt
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Datei hochladen
Um eine Datei in Box hochzuladen, verwenden Sie den Befehl Upload file .
Äquivalenter API-Aufruf: https://developer.box.com/guides/file-requests/update/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei |
Geben Sie die hochzuladende Datei ein. |
| Zielordner-ID |
Geben Sie die ID des Zielordners ein, in dem die Datei gespeichert werden soll. |
| Name des Zielordners |
Geben Sie den Namen des Zielordners ein, in dem die Datei gespeichert werden soll. Optional, wenn Sie Zielordner-IDeingeben. |
| Name |
Geben Sie den neuen Namen der Datei ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Datei |
JSON |
| Datei-ID |
Zeichenfolge |
Codes der Ausfahrt
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Dateiversion hochladen
Um eine neue Version einer Datei in Box hochzuladen, verwenden Sie den Befehl Upload file version .
Äquivalenter API-Aufruf: https://developer.box.com/guides/uploads/direct/file-version/
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Datei |
Geben Sie die Datei ein, von der Sie eine neue Version hochladen möchten. |
| Datei-ID |
Geben Sie die ID der Datei ein, von der Sie eine neue Version erstellen möchten. |
| Name |
Geben Sie den Namen der Datei ein, von der Sie eine neue Version hochladen möchten. Optional, wenn Sie File IDeingeben. |
| Name des übergeordneten Ordners |
Geben Sie den Namen des Ordners ein, der die Datei enthält, von der Sie eine neue Version hochladen möchten. Optional, wenn Sie File IDeingeben. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Linien |
Ganzzahl |
| Datei |
JSON |
| Datei-ID |
Zeichenfolge |
Codes für den Ausgang
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |