10.3 Liste des recherches

10.3.1 URL canonique

GET /api/v1/searches/

Récupération de la liste des recherches accessibles.

10.3.2 Content

Le contenu de la requête est vide.

10.3.3 Structure de retour

Le retour est une donnée JSON.

10.3.3.1 En cas de réussite :

La partie data contient :

1. requestParameters : contient un résumé des paramètres de la requête en cours (pagination et orderBy),
2. uri : URI d'accès de la collection,
3. documents : un tableau de recherche (sous la même forme que les documents unitaires)

Chaque document est un objet contenant les entrées suivantes :

1. properties : liste des propriétés de la recherche,
2. uri : URI de contenu de la recherche.

Exemple :

{
    "success": true,
    "messages": [],
    "data": {
        "requestParameters": {
            "slice": 10,
            "offset": 0,
            "length": 9,
            "orderBy": "title asc, id desc"
        },
        "uri": "/api/v1/searches/",
        "documents": [
            {
                "properties": {
                    "id": 1894,
                    "title": "Les articles intéressants",
                    "icon": "api/v1/images/assets/sizes/24x24c/search.gif",
                    "initid": 1894,
                    "name": null,
                    "revision": 0
                },
                "uri": "/api/v1/searches/1894/documents/"
            }[...]
        ]
    }
}

10.3.3.2 En cas d'échec

Les raisons d'échecs spécifiques à cette requête sont

10.3.4 Résultat partiel

10.3.4.1 Pagination et tri

La liste des documents peut être paginée et ordonnée.

Les mots clefs GET sont les suivants :

• orderBy : <attribut|propriété>:<asc:desc>
  • il indique dans quel sens la collection doit être triée,
  • valeur par défaut : title:asc,
• slice :
  • il indique le nombre maximum de documents à retourner,
  • sa valeur par défaut est celle du paramètre applicatif COLLECTION_DEFAULT_SLICE de l'application HTTPAPI_V1 (10),
• offset :
  • il indique le nombre d'éléments à exclure avant de retourner la collection.
  • valeur par défaut : 0

Les paramètres appliqués sont résumés dans le retour de la collection requestParameter.

10.3.4.2 Informations retournées

Les documents peuvent être retournés avec plus ou moins d'information.

• GET /searches/?fields=document.properties
• GET /searches/?fields=document.properties.id,document.properties.title

Par défaut : fields=document.properties

La liste des propriétés est documentée dans la documentation de format collection.

10.3.5 Cache

La collection n'a pas de cache.