Recherche

La recherche retourne uniquement les courriers du périmètre du compte authentifié. La structure de présentation dépend de la configuration admin_search.

Rechercher des courriers

POST /rest/search

Authentification : obligatoire. Le privilège adv_search_mlb est requis pour un appel d'intégration standard. Le body technique linkedResource, utilisé par l'application pour une recherche liée, n'est pas un mécanisme public de contournement du privilège.

Paramètres de query string

Paramètre	Type	Obligatoire	Description
limit	integer	Non	Nombre maximal de résultats, 25 par défaut
offset	integer	Non	Décalage, 0 par défaut
order	string	Non	Champ de tri autorisé, creationDate est utilisé lorsque la valeur n'est pas reconnue
orderDir	string	Non	ASC ou DESC
filters	valeur non vide	Non	Lorsque présent, n'inclut pas le calcul des facettes dans la réponse

Body

Chaque critère est un objet contenant values. Selon le critère, values contient une valeur, une liste ou un intervalle start/end.

Critère	Contenu de values confirmé	Description
meta	string	Recherche rapide dans les métadonnées prises en charge
subject	string	Sujet du courrier ou d'une pièce jointe
doctype	array	Identifiants de types de courrier
chrono	string	Numéro chrono
barcode	string	Code-barres
resId	object start/end	Intervalle d'identifiants de courriers
categoryId	array	Catégories de courrier
status	array	Identifiants de statuts
priority	array	Identifiants de priorités
confidentiality	array	Valeurs de confidentialité
destination	array	Identifiants d'entités destinataires
initiator	array	Identifiants d'entités initiatrices
creationDate, documentDate, arrivalDate, departureDate, processLimitDate, closingDate	object start/end	Intervalle de dates
senders, recipients	array d'objects	Correspondants avec id et type
folders	array	Identifiants de dossiers
tags	array	Identifiants de tags
notes	string	Texte recherché dans les notes
attachment_type	array	Types de pièces jointes
attachment_creationDate	object start/end	Intervalle de dates de création des pièces jointes
groupSign	array	Identifiants de groupes de signataires
senderDepartment	array	Départements d'expéditeurs
fulltext	string	Recherche plein texte
role_<rôle>	array d'objects	Correspondants d'un rôle de diffusion ou de circuit
indexingCustomField_<id>	selon le champ personnalisé	Valeur d'un champ personnalisé d'indexation
registeredMail_reference	string	Référence de courrier recommandé
registeredMail_issuingSite	array	Identifiants de sites émetteurs
registeredMail_receivedDate	object start/end	Intervalle de dates de réception
registeredMail_recipient	object	Destinataire d'un courrier recommandé

{
  "doctype": {"values": [3]},
  "subject": {"values": "<objet-courrier>"},
  "resId": {"values": {"start": 100, "end": 200}},
  "documentDate": {"values": {"start": "2026-01-01", "end": "2026-01-31"}},
  "senders": {"values": [{"id": 10, "type": "contact"}]}
}

Retour

Code HTTP	Type	Description ou message confirmé
200	object	Résultats, identifiants complets, configuration d'affichage et éventuellement facettes
400	object	No admin_search configuration found, avec lang: noAdminSearchConfiguration
403	object	Service forbidden lorsque adv_search_mlb manque

{
  "resources": [
    {
      "resId": 42,
      "subject": "<objet-courrier>",
      "inAttachments": false
    }
  ],
  "count": 1,
  "allResources": [42],
  "defaultTab": "<onglet-par-défaut>",
  "displayFolderTags": false,
  "templateColumns": 1,
  "filters": {}
}

Les champs détaillés de resources, filters, defaultTab et templateColumns dépendent de admin_search. Un test de contrat manque pour figer toutes les variantes de réponse et toutes les combinaisons de critères dynamiques.

Configuration publique de la recherche

Cette route fait partie de l'API publique. Elle nécessite une authentification et retourne la configuration applicable au compte courant.

Méthode et route	Authentification et périmètre	Consommateur connu	Motif
GET /rest/search/configuration	Utilisateur authentifié et autorisation de route	Écrans de traitement et d'administration de la recherche	Retourne directement la configuration de l'interface

Les préférences de recherche sont documentées dans Modèles de recherche. Toutes les routes sont recensées dans l'inventaire du domaine.

Charger la configuration de recherche

GET /rest/search/configuration

Retourne la valeur JSON de la configuration accessible au compte courant pour le privilège admin_search.

Code HTTP	Type	Description
200	object	Objet contenant configuration

La structure interne dépend de la configuration admin_search.