Le service d’export de recherche permet d’exporter les résultats de recherche dans un fichier CSV. L’opération peut être effectuée de manière synchrone ou asynchrone.
Export via POST
Les exemples ci-dessous indiquent comment exporter les résultats de recherche en utilisant une requête POST avec un corps SearchRequest.
# <CORE_HOST> : URL de base de FlowerDocs Core
# <TOKEN> : jeton d'authentification
# <CATEGORY> : catégorie de composant (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
}
}'
Les paramètres de requête suivants peuvent être utilisés :
| Nom | Description | Défaut |
|---|---|---|
isAsync |
Exécuter comme un job asynchrone | false |
locale |
Locale pour le formatage des dates et nombres | défaut du serveur |
Export via GET
Alternativement, la requête de recherche peut être passée en tant que paramètre JSON encodé dans l’URL.
# <CORE_HOST> URL de base de FlowerDocs Core
# <TOKEN> jeton d'authentification
# <CATEGORY> catégorie de composant (documents, folders, tasks, virtualFolders)
# <SEARCH_JSON> JSON SearchRequest encodé dans l'URL
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/csv?searchRequest=<SEARCH_JSON>" \
-H "token: <TOKEN>"
Gestion des jobs asynchrones
Lors de l’utilisation de isAsync=true, l’export CSV est généré en arrière-plan. Utilisez les endpoints suivants pour suivre la progression du job.
Vérifier le statut du job
# <CORE_HOST> : URL de base de FlowerDocs Core
# <TOKEN> : jeton d'authentification
# <CATEGORY> : catégorie de composant
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/csv/job/status/" \
-H "token: <TOKEN>"
Récupérer le résultat du job
# <CORE_HOST> : URL de base de FlowerDocs Core
# <TOKEN> : jeton d'authentification
# <CATEGORY> : catégorie de composant
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/csv/job/" \
-H "token: <TOKEN>"
Récupérer l’erreur du job
# <CORE_HOST> : URL de base de FlowerDocs Core
# <TOKEN> : jeton d'authentification
# <CATEGORY> : catégorie de composant
curl -X GET "<CORE_HOST>/rest/<CATEGORY>/search/csv/job/error/" \
-H "token: <TOKEN>"