Syntaxe de pagination

Pour limiter les résultats renvoyés dans une demande d'extraction API, HTTP GET, la plupart des points d'extrémité API qui renvoient des listes de ressources prennent en charge le paramètre d'en-tête IBM® QRadar® Qui renvoient des listes de ressources prennent en charge le paramètre d'en-tête Range .

La syntaxe du paramètre Range est cohérente pour tous les noeuds finaux qui la prennent en charge. Reportez-vous à la documentation du noeud final pour déterminer si le paramètre Range s'y applique. Toute limitation de la syntaxe Range est incluse dans la description de ce noeud final.

Remarque: le paramètre Range est toujours envoyé en tant que paramètre d'en-tête, contrairement aux paramètres sort, filteret fields . Ces paramètres sont généralement des paramètres de requête.

Par défaut, seuls les 50 premiers enregistrements sont renvoyés pour le paramètre Range sur la page de documentation de l'API interactive. Vous pouvez modifier la valeur Range pour un noeud final. Toutefois, si vous demandez des ensembles de résultats volumineux, cela peut avoir un impact négatif sur les performances de la page de documentation de l'API interactive.

Paramètre d'en-tête de plage

Les demandes de pagination sont spécifiées avec le paramètre d'en-tête Range . Utilisez la syntaxe d'indexation zéro suivante:

Range: items=x-y

La réponse à une demande qui utilise la pagination inclut l'en-tête Content-Range. L'en-tête indique le nombre d'enregistrements renvoyés dans la plage de contenu au format suivant:

Content-Range: items x-y/total number of records received

Par exemple, pour renvoyer les 5 premiers enregistrements, l'en-tête de demande contient le paramètre suivant:

"Range: items= 0-4"

L'en-tête de réponse de cette demande renvoie les informations suivantes:

Content-Range: items 0-4/5

Si la plage demandée dépasse le nombre d'enregistrements, tous les enregistrements compris dans la plage indiquée sont renvoyés. Dans l'exemple suivant, les 100 premiers enregistrements sont demandés:

"Range: items= 0-99"

Cependant, il n'y a que 12 enregistrements au total. La réponse renvoie tous les enregistrements compris dans la plage indiquée:

Content-Range: items 0-11/12

Si la plage demandée dépasse les limites du nombre d'enregistrements, aucun enregistrement n'est renvoyé. Dans l'exemple suivant, les premiers enregistrements 3 à 5 sont demandés:

"Range: items = 3-5"

Toutefois, il y a moins de 3 enregistrements et aucun enregistrement n'est renvoyé:

Content-Range: items */3