plannerBucket: delta

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Obtenga cubos recién creados, actualizados o eliminados en un plan de Planner sin tener que realizar una lectura completa de toda la colección de recursos. Para obtener más información, consulte Usar la consulta delta para realizar un seguimiento de los cambios en los datos de Microsoft Graph.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Tasks.Read No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Tasks.Read.All No disponible.

Solicitud HTTP

GET /planner/plans/{plan-id}/buckets/delta

Parámetros de consulta

El seguimiento de cambios implica una ronda de una o más llamadas a la función delta . Si usa cualquier parámetro de consulta (distinto de $deltaToken y $skipToken), debe especificarlo en la solicitud delta inicial. Microsoft Graph codifica automáticamente cualquier parámetro especificado en la parte del token de la URL @odata.nextLink o @odata.deltaLink proporcionada en la respuesta. Solo debe especificar una vez por adelantado los parámetros de consulta. En solicitudes posteriores, copie y aplique la @odata.nextLink@odata.deltaLink dirección URL o de la respuesta anterior. Esa dirección URL ya incluye los parámetros codificados.

Parámetro de consulta Tipo Descripción
$deltaToken string Un token de estado devuelto en la @odata.deltaLink dirección URL de la llamada de función delta anterior para la misma colección de recursos, lo que indica la finalización de esa ronda de seguimiento de cambios. Guarde y aplique la dirección URL completa @odata.deltaLink , incluido este token en la primera solicitud de la siguiente ronda de seguimiento de cambios para esa colección.
$skipToken string Un token de estado devuelto en la @odata.nextLink dirección URL de la llamada de función delta anterior, lo que indica que hay más cambios de los que realizar un seguimiento en la misma colección de recursos.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se realiza correctamente, esta función devuelve un 200 OK código de respuesta y una colección plannerBucket en el cuerpo de la respuesta. La respuesta también incluye un @odata.nextLink o una @odata.deltaLink dirección URL.

  • Una @odata.nextLink dirección URL en el objeto de respuesta indica páginas adicionales de datos que se recuperarán en la sesión. La aplicación continúa realizando solicitudes mediante la dirección URL @odata.nextLink hasta que se incluya dirección URL @odata.deltaLink en la respuesta.

  • Una @odata.deltaLink dirección URL del objeto de respuesta indica que no se devuelven más datos sobre el estado actual del recurso. Persista y use la @odata.deltaLink dirección URL para obtener información sobre los cambios que se realizarán en el recurso en el futuro.

Para obtener más información, vea Usar la consulta diferencial para realizar un seguimiento de los cambios en los datos de Microsoft Graph. Para ver un ejemplo que muestra cómo realizar un seguimiento de los cambios en los usuarios, consulte Obtener cambios incrementales para los usuarios.

Ejemplos

En el siguiente ejemplo se muestra una solicitud de delta en objetos plannerBucket contenidos por un plannerPlan.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/delta

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/buckets?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "id": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "name": "This is a bucket",
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "orderHint": "8585371316800245114P\\"
    }
  ]
}