Is het mogelijk om sjablonen in mappen te organiseren?

Mappen helpen u uw sjablonen in een hiërarchische structuur te organiseren. Naast het beheer vanuit de webapp kunt u de DocuGenerate API gebruiken om sjablonen in mappen te plaatsen wanneer u ze aanmaakt of bijwerkt, en om de sjablonen van een specifieke map weer te geven.

In de API wordt een map geïdentificeerd door zijn pad, gedefinieerd als een geordende array van mapnamen van de hoofdmap tot het laagste niveau. De map Legal > Contracts heeft bijvoorbeeld het pad ["Legal", "Contracts"]. Elk sjabloon dat de API retourneert, bevat zijn pad in de eigenschap folder, zoals "folder": ["Legal", "Contracts"], en een sjabloon zonder map heeft een leeg pad "folder": [].

Een sjabloon in een map plaatsen

Stuur bij het aanmaken van een sjabloon één folder-veld voor elk niveau van het pad. Mappen in het pad die nog niet bestaan, worden automatisch aangemaakt, dus u hoeft ze niet vooraf aan te maken:

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'

Het pad kan ook als JSON-string worden verzonden, bijvoorbeeld -F 'folder=["Legal", "Contracts"]', of met de veldnaam folder[] die sommige HTTP-bibliotheken gebruiken. Alle drie de formaten geven hetzelfde resultaat.

Een sjabloon naar een andere map verplaatsen

Om een bestaand sjabloon te verplaatsen, stuurt u het nieuwe pad mee bij het bijwerken van het sjabloon. Bijvoorbeeld om een sjabloon van zijn huidige map Legal > Contracts naar de map Legal > Agreements te verplaatsen:

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'

Om een sjabloon uit elke map te halen, stuurt u een leeg pad:

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=[]'

De sjablonen van een map weergeven

Om bij het opvragen van de sjablonen alleen de sjablonen van een map weer te geven, herhaalt u de queryparameter folder voor elk niveau van het pad:

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

Net als bij het filteren van sjablonen in de webapp worden alleen de sjablonen geretourneerd die direct in die map staan. Sjablonen in de submappen worden niet meegenomen, dus ?folder=Legal geeft de sjablonen in de map Legal terug, maar niet die in de submap Legal > Contracts.

Mappen hernoemen en verwijderen

De API beheert de map van elk sjabloon, maar biedt geen eindpunten voor de mappen zelf. Gebruik de webapp om een map te hernoemen of te verplaatsen samen met al zijn sjablonen, of om een map te verwijderen.