The content archive service allows downloading the contents of documents, folders or virtual folders as a ZIP archive. The operation can be performed synchronously or asynchronously depending on the volume of data.

Archive document contents

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <IDS>        document identifiers (comma-separated)
curl -X GET "<CORE_HOST>/rest/documents/<IDS>/content/archive/" \
  -H "token: <TOKEN>"

The following query parameters can be used:

Name	Description	Default
isAsync	Run as an asynchronous job	true
format	Archive format	application/zip
includeMetaData	Include component metadata in the archive	false
recursive	Include children contents recursively	false
flatten	Flatten the directory structure	true
name	Name of the output archive file	auto-generated

Archive folder contents

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <ID>         folder identifier
curl -X GET "<CORE_HOST>/rest/folders/<ID>/content/archive/" \
  -H "token: <TOKEN>"

Archive virtual folder contents

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <ID>         virtual folder identifier
curl -X GET "<CORE_HOST>/rest/virtualFolders/<ID>/content/archive/" \
  -H "token: <TOKEN>"

Asynchronous job management

When using isAsync=true, the archive is generated in the background. The following endpoints allow tracking the job progress.

Check job status

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <IDS>        component identifiers used for the archive request
curl -X GET "<CORE_HOST>/rest/documents/<IDS>/content/archive/job/status/" \
  -H "token: <TOKEN>"

Get job result

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <IDS>        component identifiers used for the archive request
curl -X GET "<CORE_HOST>/rest/documents/<IDS>/content/archive/job/" \
  -H "token: <TOKEN>"

Get job error

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <IDS>        component identifiers used for the archive request
curl -X GET "<CORE_HOST>/rest/documents/<IDS>/content/archive/job/error/" \
  -H "token: <TOKEN>"