Pagination des données Microsoft Graph dans votre applicationPaging Microsoft Graph data in your app

  • 2 minutes de lecture

Certaines requêtes dans Microsoft Graph renvoient plusieurs pages de données en raison de la pagination côté serveur, ou en raison de l’utilisation du paramètre de requête $top permettant de limiter de manière spécifique la taille de page dans une demande. Lorsqu’un ensemble de résultats s’étend sur plusieurs pages, Microsoft Graph renvoie une propriété @odata.nextLink dans la réponse contenant une URL vers la page de résultats suivante.Some queries against Microsoft Graph return multiple pages of data either due to server-side paging or due to the use of the $top query parameter to specifically limit the page size in a request. When a result set spans multiple pages, Microsoft Graph returns an @odata.nextLink property in the response that contains a URL to the next page of results.

Par exemple, l’URL suivante demande de renvoyer tous les utilisateurs d’une organisation avec une taille de page définie sur 5 à l’aide du paramètre de requête $top :For example, the following URL requests all the users in an organization with a page size of 5, specified with the $top query parameter:

https://graph.microsoft.com/v1.0/users?$top=5

Si le résultat contient plus de cinq utilisateurs, Microsoft Graph renverra une propriété @odata.nextLink semblable à ce qui suit, ainsi que la première page d’utilisateurs.If the result contains more than five users, Microsoft Graph will return an @odata.nextLink property similar to the following along with the first page of users.

"@odata.nextLink": "https://graph.microsoft.com/v1.0/users?$top=5&$skiptoken=X%274453707 ... 6633B900000000000000000000%27"

Vous pouvez récupérer la page de résultats suivante en envoyant la valeur d’URL de la propriété @odata.nextLink à Microsoft Graph.You can retrieve the next page of results by sending the URL value of the @odata.nextLink property to Microsoft Graph.

https://graph.microsoft.com/v1.0/users?$top=5&$skiptoken=X%274453707 ... 6633B900000000000000000000%27

Microsoft Graph continuera à renvoyer une référence à la page de données suivante dans la propriété @odata.nextLink avec chaque réponse jusqu'à ce que toutes les pages de résultat soient lues.Microsoft Graph will continue to return a reference to the next page of data in the @odata.nextLink property with each response until all pages of the result have been read.

Important : vous devez inclure l’URL complète dans la propriété @odata.nextLink de votre demande pour la page de résultats suivante.Important: You should include the entire URL in the @odata.nextLink property in your request for the next page of results. En fonction de l’API utilisée pour l’exécution de la requête, la valeur d’URL @odata.nextLink contient le paramètre de requête $skiptoken ou $skip.Depending on the API that the query is being performed against, the @odata.nextLink URL value will contain either a $skiptoken or a $skip query parameter. L’URL contient également tous les autres paramètres de requête présents dans la demande d’origine.The URL also contains all the other query parameters present in the original request. N’essayez pas d’extraire la valeur $skiptoken ou $skip, ou de l’utiliser dans une autre demande.Do not try to extract the $skiptoken or $skip value and use it in a different request.

Le comportement de pagination varie en fonction des différentes API Microsoft Graph.Paging behavior varies across different Microsoft Graph APIs. Lorsque vous utilisez des données paginées, prenez en compte les éléments suivants :Consider the following when working with paged data:

  • Des API différentes peuvent avoir des tailles de page par défaut et maximale différentes.Different APIs might have different default and maximum page sizes.
  • Des API différentes peuvent se comporter différemment si vous spécifiez une taille de page (via le paramètre de requête $top) qui dépasse la taille de page maximale pour cette API.Different APIs might behave differently if you specify a page size (via the $top query parameter) that exceeds the maximum page size for that API. En fonction de l’API, la taille de page demandée peut être ignorée, peut revenir à la taille de page maximale par défaut pour cette API ou Microsoft Graph peut renvoyer une erreur.Depending on the API, the requested page size might be ignored, it might default to the maximum page size for that API, or Microsoft Graph might return an error.
  • Les ressources ou les relations ne prennent pas toutes en charge la pagination. Par exemple, les requêtes relatives à directoryRoles ne prennent pas en charge la pagination. Cela inclut la lecture d’objets de rôle eux-mêmes, ainsi que de membres de rôle.Not all resources or relationships support paging. For example, queries against directoryRoles do not support paging. This includes reading role objects themselves as well as role members.

En savoir plus sur la paginationLearn more about paging

La vidéo suivante vous présente la pagination dans Microsoft Graph.The following video introduces you to paging in Microsoft Graph.