Requetes.Search
En bref
2 opérations sur 2 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations
| Méthode | Chemin | Rôle |
|---|---|---|
POST |
/v2/search |
Créer l'enregistrement |
GET |
/v2/search/{model}/{terme} |
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 /v2/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 | JsonNode |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/search" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"models": [], "searchTerm": "…", "limit": 0}'
GET /v2/search/{model}/{terme}
Lire l'enregistrement désigné.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
model |
path | string |
oui | - |
terme |
path | string |
oui | - |
limit |
query | integer (int32) |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | JsonNode |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/search/<model>/<terme>?limit=<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.
JsonNode
JsonNode - 3 propriétés
| Propriété | Type | Notes |
|---|---|---|
options |
JsonNodeOptions |
- |
parent |
JsonNode |
- |
root |
JsonNode |
- |
SearchController
SearchController - 3 propriétés
| Propriété | Type | Notes |
|---|---|---|
models |
tableau de string |
nullable |
searchTerm |
string |
nullable |
limit |
integer (int32) |
- |