Aller au contenu

Modèles de recherche

Ces contrats publics gèrent les recherches enregistrées par l'utilisateur courant.

Toutes les opérations nécessitent une authentification. Aucun privilège supplémentaire n'est contrôlé, le périmètre est systématiquement limité au propriétaire.

Lister les modèles de recherche

GET /rest/searchTemplates
Code HTTP Type Description
200 object Objet contenant searchTemplates, trié par label
Donnée Type Description
id integer Identifiant du modèle
label string Libellé
query array ou object JSON Critères enregistrés par l'interface

Créer un modèle de recherche

POST /rest/searchTemplates

Le propriétaire est forcé au compte authentifié.

Champ Type Obligatoire Description
label string Oui Libellé de 1 à 255 caractères
query array Oui Critères enregistrés
{
  "label": "<nom-du-modèle>",
  "query": [
    {
      "identifier": "subject",
      "values": "<texte-recherché>"
    }
  ]
}
Code HTTP Description ou message confirmé
200 Objet contenant l'id créé
400 Body query is empty or not an array
400 Body label is empty or not a string

La structure interne de chaque critère dépend des composants de recherche, seuls les critères réellement acceptés par POST /rest/search doivent être enregistrés.

Supprimer un modèle de recherche

DELETE /rest/searchTemplates/{id}
Paramètre URL Type Obligatoire Description
id integer Oui Identifiant du modèle appartenant au compte courant
Code HTTP Description ou message confirmé
204 Suppression effectuée
400 Query id is empty or not a numeric
400 This template does not exists or it is not your template