microsoftgraph / microsoftgraph/msgraph-sdk-python

skiptoken for large request responses

Ouverte
#176 2 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
630
Forks
96
Merge moyen
15 h 20 min
PR mergées (30 j)
3

Description

I am looking to use the msgraph sdk for python. I want to get a list of devices in our tenant. We have thousands of devices. When using the msgraph.devices.get(), it will return 100 devices (the default limit for msgraph). Utilize the request_query=DevicesRequestBuilder.DevicesRequestBuilderGetQueryParameters(top=100,skip=100)
gives me this error msgraph.generated.models.o_data_errors.o_data_error.ODataError

After some digging in the Microsoft graph explorer for https://graph.microsoft.com/v1.0/devices?$top=100&$skip=100 gives this error

{ "error": { "code": "Request_BadRequest", "message": "'$skip' is not supported by the service.", "innerError": { "date": "2023-04-24T23:08:17", "request-id": "e077ef6b-d848-4fba-8cce-257e7188a6ec", "client-request-id": "4a9beda2-c3ee-0c9f-f012-5308f25f8954" } } }

So, skip is not supported for devices. It is the same in the beta requests.

Since I am able to get the data_data_next_link from my initial devices.get() response, I tried
request_query=DevicesRequestBuilder.DevicesRequestBuilderGetQueryParameters(top=100,skiptoken='RNFw.....')
However, I get an error TypeError: __init__() got an unexpected keyword argument skiptoken
After digging through the code, I modified device_request_builder.py, changing the DevicesRequestBuilderGetQueryParameters(): adding

 if original_name == "skiptoken":
       return "%24skiptoken
......
skiptoken: Optional[str] = None

and class DevicesRequestBuilder(): modifying

self.url_template: str = "{+baseurl}/devices{?%24top,%24skip,%24search,%24filter,%24count,%24orderby,%24select,%24expand,%24skiptoken}

These make the skiptoken available and work with GetQueryParameters.
So basically modifying this module to work with the limitations of msgraph

Is there another way to accomplish paging with devices in this python module?

If not, I can try a pull request for this.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par device_request_builder.py et la classe DevicesRequestBuilderGetQueryParameters, puis comparez la requête générée avec data_data_next_link de la réponse des appareils. Vérifiez comment skiptoken est représenté dans l’URL de la requête et si le chemin GetQueryParameters existant peut le suivre. C’est terminé lorsque la pagination des appareils peut utiliser le next link ou skiptoken renvoyé sans l’erreur de constructeur signalée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.