Paramètres de requête

Certaines demandes utiliseront des paramètres de requête facultatifs qui modifieront ou amélioreront les données renvoyées. Pour plus d'informations, reportez-vous à la documentation de chaque ressource. Tous les paramètres de requête ne sont pas pris en charge par toutes les ressources. Cette section présente uniquement les paramètres de requête courants utilisés lorsqu'une ressource n'implémente pas le paramètre de requête spécifié.

Table 1-2  Paramètres de requête courants

Paramètre Description props=true Enumération des métadonnées de la propriété pour une ressource (la valeur par défaut est false) limit=n Limitation du nombre d'éléments de la liste renvoyés start=n Numéro d'index (ou heure) défini pour démarrer le renvoi de données d'élément

Paramètre de requête : props

Le paramètre de requête props s'utilise sur de nombreuses commandes GET renvoyant une instance de ressource unique. Il renverra un élément de données "props" contenant une liste de métadonnées de propriété.

Table 1-3  Valeurs des métadonnées de la propriété

Propriété Description name Nom de la propriété label Description de la propriété immutable Indicateur de l'impossibilité de modifier une propriété type Type de propriété : String, Integer, Boolean... choices Groupe de valeurs disponibles pour les propriétés énumérées

Paramètre de requête : limit

Vous pouvez utiliser la requête de limite sur de nombreuses commandes GET renvoyant un grand nombre d'éléments afin de limiter le nombre maximum d'éléments renvoyés.

Paramètre de requête : start

Le paramètre de la requête de début est pris en charge par les mêmes commandes que le paramètre de limite. Il fournit l'index de départ utilisé pour démarrer les données renvoyées. Pour les ressources prenant en charge les valeurs d'heure, l'index peut être une valeur d'heure, par exemple "20130531T01:13:58".