Kann ich Vorlagen in Ordnern organisieren?

Hilfe-Center

Vorlagen

Dokumente

Integrationen

Entwickler

Konto

API-Referenz

Ordner helfen Ihnen, Ihre Vorlagen in einer hierarchischen Struktur zu organisieren. Neben der Verwaltung in der Webanwendung können Sie die DocuGenerate-API verwenden, um Vorlagen beim Erstellen oder Aktualisieren in Ordnern abzulegen und die Vorlagen eines bestimmten Ordners aufzulisten.

In der API wird ein Ordner durch seinen Pfad identifiziert, der als geordnetes Array von Ordnernamen von der Wurzel bis zur untersten Ebene definiert ist. Der Ordner Legal > Contracts hat zum Beispiel den Pfad ["Legal", "Contracts"]. Jede von der API zurückgegebene Vorlage enthält ihren Pfad in der Eigenschaft folder, etwa "folder": ["Legal", "Contracts"], und eine Vorlage ohne Ordner hat einen leeren Pfad "folder": [].

Vorlage in einem Ordner ablegen

Senden Sie beim Erstellen einer Vorlage ein folder-Feld fĂĽr jede Ebene des Pfads. Ordner im Pfad, die noch nicht existieren, werden automatisch erstellt, sodass Sie sie nicht vorher anlegen mĂĽssen:

curl -X 'POST' \
  'https://api.docugenerate.com/v1/template' \
  -H 'Accept: application/json' \
  -H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@Contract.docx' \
  -F 'folder=Legal' \
  -F 'folder=Contracts'

Der Pfad kann auch als JSON-String gesendet werden, zum Beispiel -F 'folder=["Legal", "Contracts"]', oder mit dem Feldnamen folder[], den manche HTTP-Bibliotheken verwenden. Alle drei Formate liefern dasselbe Ergebnis.

Vorlage in einen anderen Ordner verschieben

Um eine bestehende Vorlage zu verschieben, senden Sie ihren neuen Pfad beim Aktualisieren der Vorlage. Zum Beispiel, um eine Vorlage aus ihrem aktuellen Ordner Legal > Contracts in den Ordner Legal > Agreements zu verschieben:

curl -X 'PUT' \
  'https://api.docugenerate.com/v1/template/UgnZ7HeRvVIEC9nDlSbC' \
  -H 'Accept: application/json' \
  -H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
  -H 'Content-Type: multipart/form-data' \
  -F 'folder=Legal' \
  -F 'folder=Agreements'

Um eine Vorlage aus jedem Ordner herauszunehmen, senden Sie einen leeren Pfad:

curl -X 'PUT' \
  'https://api.docugenerate.com/v1/template/UgnZ7HeRvVIEC9nDlSbC' \
  -H 'Accept: application/json' \
  -H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
  -H 'Content-Type: multipart/form-data' \
  -F 'folder=[]'

Vorlagen eines Ordners auflisten

Um beim Abfragen der Vorlagen nur die Vorlagen eines Ordners aufzulisten, wiederholen Sie den Abfrageparameter folder fĂĽr jede Ebene des Pfads:

curl -X 'GET' \
  'https://api.docugenerate.com/v1/template?folder=Legal&folder=Contracts' \
  -H 'Accept: application/json' \
  -H 'Authorization: 491c000c5fad32ed7787005b0723ad55'

Wie beim Filtern von Vorlagen in der Webanwendung werden nur die Vorlagen zurĂĽckgegeben, die direkt in diesem Ordner liegen. Vorlagen in seinen Unterordnern sind nicht enthalten, daher liefert ?folder=Legal die Vorlagen im Ordner Legal, aber nicht die im Unterordner Legal > Contracts.

Ordner umbenennen und löschen

Die API verwaltet den Ordner jeder Vorlage, bietet aber keine Endpunkte für die Ordner selbst. Um einen Ordner umzubenennen oder zu verschieben mitsamt allen seinen Vorlagen, oder um einen Ordner zu löschen, verwenden Sie die Webanwendung.