microsoftgraph / microsoftgraph/msgraph-sdk-python
skiptoken for large request responses
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 630
- Forks
- 96
- Merge medio
- 15 h 20 min
- PR fusionados (30 d)
- 3
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con device_request_builder.py y la clase DevicesRequestBuilderGetQueryParameters; después, compara la solicitud generada con data_data_next_link de la respuesta de dispositivos. Verifica cómo se representa skiptoken en la URL de la solicitud y si la ruta existente de GetQueryParameters puede seguirlo. Se considera terminado cuando la paginación de dispositivos puede usar el next link o skiptoken devuelto sin el error de constructor indicado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100