Export search results as CSV

The export search service exports search results to a CSV file. The export runs asynchronously: the request submits a job and returns immediately with the job identifier; the generated file is then retrieved through the job endpoints described below. There is no limit on the number of exported results.

Export via POST

The examples below show how to export search results using a POST request with a SearchRequest body.

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <CATEGORY>   component category (documents, folders, tasks, virtualFolders)
curl -X POST "<CORE_HOST>/rest/<CATEGORY>/search/csv" \
  -H "token: <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "searchCriteria": [
    {
      "name": "classId",
      "value": "MyDocumentClass"
    }
  ],
  "paginationContext": {
    "maxResults": 1000,
    "pageIndex": 0
  }
}'

The following query parameters can be used:

Name	Description	Default
locale	Locale for date and number formatting	server default

Export via GET

Alternatively, the search request can be passed as a URL-encoded JSON parameter.

REST

# <CORE_HOST>      FlowerDocs Core base URL
# <TOKEN>          authentication token
# <CATEGORY>       component category (documents, folders, tasks, virtualFolders)
# <SEARCH_JSON>    URL-encoded SearchRequest JSON
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/csv?searchRequest=<SEARCH_JSON>" \
  -H "token: <TOKEN>"

Asynchronous job management

The CSV export is generated in the background as a job. Use the following endpoints to track its progress and retrieve the result.

Check job status

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <CATEGORY>   component category
# <JOBID>      Job identifier returned by GET or POST export request
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/job/status?jobId=<JOBID>" \
  -H "token: <TOKEN>"

Get job result

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <CATEGORY>   component category
# <JOBID>      Job identifier returned by GET or POST export request
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/job?jobId=<JOBID>" \
  -H "token: <TOKEN>"

Get job error

REST

# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <CATEGORY>   component category
# <JOBID>      Job identifier returned by GET or POST export request
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/job/error?jobId=<JOBID>" \
  -H "token: <TOKEN>"