Classement et recherche¶

Ce domaine regroupe les contrats REST publics permettant de classer les courriers dans des dossiers, de rechercher des courriers, d'administrer les typologies, les tags et les modèles, et d'alimenter le workflow d'indexation.

Une route publique n'est pas nécessairement anonyme : toutes les routes de ce domaine nécessitent une authentification. Les contrôles de privilège, de propriété et de périmètre sont précisés dans chaque page.

Contrats API publics¶

Page	Périmètre
Dossiers	Dossiers visibles, partage, filtres, association de courriers, configuration et préférences
Recherche	Recherche avancée et configuration de recherche
Types de courrier	Consultation et administration de l'arborescence des typologies
Tags	Consultation, administration, fusion et autocomplétion des tags
Modèles d'indexation	Modèles, entités proposées et catégories personnalisées
Modèles de recherche	Recherches enregistrées par le compte courant
Indexation	Préparation et exécution du workflow d'indexation

Les conventions d'URL et d'authentification sont décrites dans l'index général des webservices.

Niveaux d'accès¶

Niveau	Signification
Contrat public authentifié	Route publique accessible à un utilisateur authentifié dans son périmètre
Contrat public soumis à privilège	Route publique exigeant le privilège indiqué dans sa page
Contrat public limité au propriétaire	Route publique opérant uniquement sur les données du compte courant
Route publique relevant d'un autre domaine	Route publique inventoriée ici mais documentée dans son domaine fonctionnel

Inventaire des routes publiques¶

Méthode et route	Page ou domaine	Accès principal
`GET /rest/folders/configuration`	Dossiers	Utilisateur authentifié, configuration `admin_folders` applicable
`GET /rest/pinnedFolders`	Dossiers	Utilisateur authentifié, compte courant
`POST /rest/folders/{id}/pin`	Dossiers	Utilisateur authentifié, dossier visible
`DELETE /rest/folders/{id}/unpin`	Dossiers	Utilisateur authentifié, dossier visible
`GET /rest/autocomplete/folders`	Dossiers	Utilisateur authentifié, dossiers visibles
`GET /rest/search/configuration`	Recherche	Utilisateur authentifié, configuration `admin_search` applicable
`GET /rest/searchTemplates`	Modèles de recherche	Utilisateur authentifié, compte courant
`POST /rest/searchTemplates`	Modèles de recherche	Utilisateur authentifié, propriétaire forcé au compte courant
`DELETE /rest/searchTemplates/{id}`	Modèles de recherche	Utilisateur authentifié, propriétaire du modèle
`GET /rest/administration/doctypes/new`	Types de courrier	Utilisateur authentifié
`GET /rest/tags`	Tags	Utilisateur authentifié
`POST /rest/tags`	Tags	`admin_tag` ou `manage_tags_application`
`GET /rest/tags/{id}`	Tags	Utilisateur authentifié
`PUT /rest/tags/{id}`	Tags	`admin_tag`
`PUT /rest/mergeTags`	Tags	`admin_tag`
`DELETE /rest/tags/{id}`	Tags	`admin_tag` ou `manage_tags_application`, selon l'usage
`GET /rest/autocomplete/tags`	Tags	Utilisateur authentifié
`GET /rest/indexingModels`	Modèles d'indexation	Utilisateur authentifié, périmètre du compte et de ses entités
`GET /rest/indexingModels/entities`	Modèles d'indexation	Utilisateur authentifié, périmètre utilisateur ou courrier
`GET /rest/indexingModels/{id}`	Modèles d'indexation	Utilisateur authentifié, périmètre du modèle
`POST /rest/indexingModels`	Modèles d'indexation	Utilisateur authentifié, visibilité déterminée par ses privilèges
`PUT /rest/indexingModels/{id}`	Modèles d'indexation	`admin_indexing_models`
`PUT /rest/indexingModels/{id}/disable`	Modèles d'indexation	`admin_indexing_models`
`PUT /rest/indexingModels/{id}/enable`	Modèles d'indexation	`admin_indexing_models`
`DELETE /rest/indexingModels/{id}`	Modèles d'indexation	Propriétaire ou privilège adapté au type de modèle
`GET /rest/indexingModels/categories/custom/{id}/usages`	Modèles d'indexation	Utilisateur authentifié
`PUT /rest/indexingModels/categories/custom/{id}/redirect`	Modèles d'indexation	Utilisateur authentifié
`POST /rest/indexingModels/categories/custom`	Modèles d'indexation	`admin_indexing_models`
`PUT /rest/indexingModels/categories/custom/{id}`	Modèles d'indexation	`admin_indexing_models`
`DELETE /rest/indexingModels/categories/custom/{id}`	Modèles d'indexation	`admin_indexing_models`
`GET /rest/indexing/groups/{groupId}/actions`	Indexation	Utilisateur authentifié, groupe lié et autorisé à indexer
`GET /rest/indexing/groups/{groupId}/entities`	Indexation	Utilisateur authentifié, groupe lié et autorisé à indexer
`GET /rest/indexing/processLimitDate`	Indexation	Utilisateur authentifié
`GET /rest/indexing/fileInformations`	Indexation	Utilisateur authentifié
`GET /rest/indexing/priority`	Indexation	Utilisateur authentifié
`PUT /rest/indexing/groups/{groupId}/actions/{actionId}`	Indexation	Utilisateur authentifié, groupe, action et courrier contrôlés
`GET /rest/alfresco/autocomplete/folders`	Connecteurs/Alfresco	Utilisateur authentifié, configuration Alfresco applicable
`GET /rest/groups/{id}/indexing`	Organisation/Groups.md	`admin_groups`
`PUT /rest/groups/{id}/indexing`	Organisation/Groups.md	`admin_groups`
`GET /rest/ban/availableDepartments`	Contacts ou service BAN	Utilisateur authentifié
`POST /rest/resources/folderPrint`	Courriers/Export.md	`print_folder_doc`