11.3 Liste des dossiers
11.3.1 URL canonique
GET /api/v1/folders/
Récupération de la liste des dossiers accessibles.
11.3.2 Content
Le contenu de la requête est vide.
11.3.3 Structure de retour
Le retour est une donnée JSON.
11.3.3.1 En cas de réussite :
La partie data
contient :
-
requestParameters
: contient un résumé des paramètres de la requête en cours (pagination et orderBy), -
uri
: URI d'accès de la collection, -
documents
: un tableau de document (sous la même forme que les documents unitaires)
Chaque document est un objet contenant les entrées suivantes :
-
properties
: liste des propriétés du dossier, -
uri
: URI du contenu du dossier
Exemple :
{ "success": true, "messages": [], "data": { "requestParameters": { "slice": 10, "offset": 0, "length": 10, "orderBy": "title asc, id desc" }, "uri": "/api/v1/folders/", "properties": { "title": "The folders" }, "documents": [ { "properties": { "id": 1011, "title": "Administrateurs", "icon": "api/v1/images/assets/sizes/24x24c/igroup.png", "initid": 1011, "name": "GADMIN", "revision": 0 }, "uri": "/api/v1/folders/1011/documents/" } ], ... } }
11.3.3.2 En cas d'échec
Les raisons d'échecs spécifiques à cette requête sont
Raison | Status HTTP | Error Code |
---|---|---|
Sens de l'orderBy inconnu | 400 | CRUD0501 |
Attribut ou propriété d'orderBy invalide | 400 | CRUD0502 |
11.3.4 Résultat partiel
11.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'applicationHTTPAPI_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
.
11.3.4.2 Informations retournées
Les documents peuvent être retournés avec plus ou moins d'information.
- GET /folders/?fields=document.properties
- GET /folders/?fields=document.properties.id,document.properties.title
Par défaut : fields=document.properties
fields | Signification | Remarques |
---|---|---|
document.properties |
Récupère l'ensemble des propriétés par défaut | "id", "title", "icon", "initid", "name" |
document.properties.all |
Récupère toutes les propriétés | |
document.properties.<prop> |
Récupère la propriété indiquée |
La liste des propriétés est documentée dans la documentation de format collection.
11.3.5 Cache
La collection n'a pas de cache.