microsoftgraph / microsoftgraph/msgraph-sdk-python

skiptoken for large request responses

Open
#176 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
630
Forks
96
Avg merge
15h 20m
Merged PRs (30d)
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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with device_request_builder.py and the DevicesRequestBuilderGetQueryParameters class, then compare the generated request with the devices response's data_data_next_link. Verify how skiptoken is represented in the request URL and whether the existing GetQueryParameters path can follow it. Done means device paging can use the returned next link or skiptoken without the reported constructor error.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.