Aller au contenu

Search

En bref

3 opérations sur 3 chemins. Routes héritées, sans préfixe /v2. Authentification JWT (voir Démarrer).

Routes héritées

Les chemins de ce groupe ne portent pas le préfixe /v2 : ils proviennent de la surface historique du connecteur, publiée dans la même spécification. Pour une intégration neuve, préférez l'équivalent /v2 (voir Conventions).

Opérations

Méthode Chemin Rôle
POST /Search Créer l'enregistrement
GET /Search/{Model}/{SearchTerm} Lire l'enregistrement désigné
GET /Search/{Model}/{SearchTerm}/{Limit} Lire l'enregistrement désigné

Rôle déduit

La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.

Détail

POST /Search

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma SearchController — 3 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK —
401 Unauthorized —
403 Forbidden —

Exemple

curl -s -X POST "https://<votre-connecteur>/Search" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"models": [], "searchTerm": "…", "limit": 0}'

GET /Search/{Model}/{SearchTerm}

Lire l'enregistrement désigné.

Paramètres

Nom Emplacement Type Obligatoire Description
Model path string oui —
SearchTerm path string oui —

Réponses

Code Description Schéma de data
200 OK —
401 Unauthorized —
403 Forbidden —

Exemple

curl -s -X GET "https://<votre-connecteur>/Search/<Model>/<SearchTerm>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /Search/{Model}/{SearchTerm}/{Limit}

Lire l'enregistrement désigné.

Paramètres

Nom Emplacement Type Obligatoire Description
Model path string oui —
SearchTerm path string oui —
Limit path integer (int32) oui —

Réponses

Code Description Schéma de data
200 OK —
401 Unauthorized —
403 Forbidden —

Exemple

curl -s -X GET "https://<votre-connecteur>/Search/<Model>/<SearchTerm>/<Limit>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

Schémas

Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.

SearchController

SearchController — 3 propriétés
Propriété Type Notes
models tableau de string nullable
searchTerm string nullable
limit integer (int32) —

Voir aussi