event: delta

Espacio de nombres: microsoft.graph

Obtenga un conjunto de recursos de eventos que se agregan, eliminan o actualizan en uno o más calendarios.

Puede obtener tipos específicos de estos cambios incrementales en los eventos de todos los calendarios de un buzón o de un calendario específico, o en una colección de eventos de un calendarView (rango de eventos definidos por fechas de inicio y finalización) de un calendario. El calendario puede ser el calendario predeterminado o algún otro calendario especificado que pertenezca al usuario. Al obtener cambios incrementales en calendarView, el calendario también puede ser un calendario de grupo.

Normalmente, la sincronización de eventos en un calendario o calendarView en un almacén local implica una ronda de varias llamadas a la función delta . La llamada inicial es una sincronización completa y cada llamada delta posterior en la misma ronda obtendrá los cambios incrementales (adiciones, eliminaciones o actualizaciones). El uso de deltas le permite mantener y sincronizar de forma incremental un almacén local de eventos en el calendario especificado.

En la tabla siguiente se enumeran las diferencias entre la función delta en eventos y la función delta en una vista de calendario de un calendario.

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

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.

Solicitud HTTP

En esta sección se muestra la sintaxis de la solicitud HTTP para la llamada inicial de la función delta con el fin de iniciar una sincronización completa que recupere todos los eventos de la vista de calendario o calendario especificada. Esta sintaxis no contiene ningún token de estado.

La dirección URL de consulta devuelta en un @odata.nextLink o @odata.deltaLink de una respuesta correcta incluye un token de estado. Para cualquier llamada a la función diferencial posterior, use la dirección URL de consulta en una @odata.nextLink de ellas o @odata.deltaLink anterior.

Función delta en eventos del calendario de un usuario (versión preliminar)

Aplique la función delta en todos los eventos o eventos que comiencen a partir de una fecha u hora específica, en el calendario o calendarios de usuario especificados:

• Para obtener cambios incrementales de todos los eventos, o de aquellos que comiencen en o después de la fecha y hora especificada en el buzón del usuario:

  GET /me/events/delta
  GET /users/{id | userPrincipalName}/events/delta
  
  GET /me/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/events/delta?startDateTime={start_datetime}
  

• Para obtener cambios incrementales de todos los eventos o de eventos que comiencen en o después de la fecha y hora especificada en el calendario predeterminado del usuario:

  GET /me/calendar/events/delta
  GET /users/{id | userPrincipalName}/calendar/events/delta
  
  GET /me/calendar/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/calendar/events/delta?startDateTime={start_datetime}
  

• Para obtener cambios incrementales de todos los eventos, o de eventos que comiencen en o después de la fecha y hora especificada en el calendario del usuario especificado:

  GET /me/calendars/{id}/events/delta
  GET /users/{id | userPrincipalName}/calendars/{id}/events/delta
  
  GET /me/calendars/{id}/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/calendars/{id}/events/delta?startDateTime={start_datetime}
  

• Para obtener cambios incrementales, todos los eventos o de eventos que comiencen en o después de la fecha y hora especificadas en el grupo de calendarios y calendario especificados:

  GET /me/calendarGroups/{id}/calendars/{id}/events/delta
  GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/delta
  
  GET /me/calendarGroups/{id}/calendars/{id}/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/delta?startDateTime={start_datetime}
  

Función delta en calendarView en un calendario de usuario

Aplique la función delta en un rango de eventos delimitados por fecha y hora de inicio y finalización, en el calendario de usuario especificado:

• Para obtener cambios incrementales en una vista de calendario del calendario predeterminado del usuario:

  GET /me/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
  GET /users/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
  

• Para obtener cambios incrementales en una vista de calendario del calendario de usuario especificado:

  GET /me/calendars/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
  GET /users/{id}/calendars/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
  

Función delta en calendarVer en un calendario de grupo

• Para obtener cambios incrementales en una vista de calendario del calendario de un grupo:

  GET /groups/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
  

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 deseados. En solicitudes posteriores, copie y aplique la dirección URL @odata.nextLink o @odata.deltaLink de la respuesta anterior, dado que la dirección URL ya incluye los parámetros codificados deseados.

Parámetros de consulta de OData

• Esperar que una llamada de función delta en un calendarView devuelva las mismas propiedades que normalmente obtendría de una solicitud GET /calendarView. No se puede usar $select para obtener solo un subconjunto de esas propiedades.

• La función delta no admite los siguientes parámetros de consulta para eventos en un calendario de usuario o eventos en un calendarView: $expand, $filter,$orderby, $searchy $select.

Encabezados de solicitud

Respuesta

Función delta en eventos (versión preliminar)

Si tiene éxito, este método devuelve un 200 OK código de respuesta y una colección de eventos en el cuerpo de la respuesta. Cada evento de la respuesta contiene solo las propiedades id, type, start y end por motivos de rendimiento. Use GET /events/{id} más adelante para expandir los eventos de la respuesta.

Función delta en calendarView

Si tiene éxito, este método devuelve un 200 OK código de respuesta y una colección de eventos en el cuerpo de la respuesta.

Espere obtener todas las propiedades que normalmente obtendría de una GET /calendarView solicitud.

Dentro de una ronda de llamadas de función delta enlazadas por el intervalo de fechas de un calendarView, a veces puede encontrar una llamada delta que devuelva dos tipos de eventos con @removed el motivo deleted:

• Eventos que se encuentran dentro del intervalo de fechas y que se eliminaron desde la llamada delta anterior.
• Eventos que están fuera del intervalo de fechas y que se agregaron, eliminaron o actualizaron desde la llamada delta anterior.

Filtre los eventos en @removed para el intervalo de fechas que requiera el escenario.

Ejemplos

Ejemplo 1: Función Delta en eventos de un calendario (versión preliminar)

Solicitud

En el ejemplo siguiente se muestra la solicitud de sincronización inicial para obtener eventos en el calendario predeterminado del usuario que ha iniciado sesión, que se producen en o después del parámetro especificado startDateTime . La solicitud inicial no incluye ningún token de estado.

La solicitud utiliza el Prefer: odata.maxpagesize encabezado para limitar el número máximo de eventos de cada respuesta a 1. Siga llamando a la delta función mediante la consulta devuelta @odata.nextLink hasta que obtenga una @odata.deltaLink respuesta en consecuencia.

GET https://graph.microsoft.com/beta/me/calendar/events/delta?startDateTime=2020-06-12T00:00:00Z

Prefer: odata.maxpagesize=1

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/calendar/events/delta?startDateTime=2020-06-12T00:00:00Z')
	.version('beta')
	.get();

Respuesta

Si la solicitud es correcta, la respuesta incluye un token de estado, que puede ser un skipToken (en un encabezado de respuesta @odata.nextLink ) o un deltaToken (en un encabezado de respuesta @odata.deltaLink ). Respectivamente, indican si debe continuar con la ronda o si ha completado la obtención de todos los cambios para esa ronda.

La respuesta siguiente muestra un skipToken en un encabezado de respuesta de @odata.nextLink.

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/calendar/events/delta?$skiptoken=R0usmcdvmMu7jxWP8",
  "value": [
    {
      "id": " AAMkADllMWMwNDkzLWJlY2EtNDIyOS1iZjAA=",
      "type": "singleInstance",
      "start": {
             "DateTime": "2020-02-19T10:00:00.0000000", 
             "TimeZone": "UTC"
         }, 
       "end": {
                "DateTime": "2020-02-19T11:00:00.0000000", 
                "TimeZone": "UTC"      
          } 
        }
  ]
}

Ejemplo 2: Función Delta en calendarView

Solicitud

En el ejemplo siguiente se muestra la solicitud de sincronización inicial para obtener eventos en el calendario especificado del usuario que ha iniciado sesión, dentro del intervalo de fechas indicado por calendarView. La solicitud inicial no incluye ningún token de estado.

La solicitud utiliza el Prefer: odata.maxpagesize encabezado para limitar el número máximo de eventos de cada respuesta a 2. Continúe llamando a la delta función mediante la consulta devuelta @odata.nextLink hasta que obtenga todos los eventos en esa vista de calendario y a @odata.deltaLink en la respuesta.

GET https://graph.microsoft.com/beta/me/calendars/AAMkADI5M1BbeAAA=/calendarView/delta?startDateTime=2020-06-01T00:00:00Z&endDateTime=2020-06-10T00:00:00Z

Prefer: odata.maxpagesize=2

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/calendars/AAMkADI5M1BbeAAA=/calendarView/delta?startDateTime=2020-06-01T00:00:00Z&endDateTime=2020-06-10T00:00:00Z')
	.version('beta')
	.get();

Respuesta

Si la solicitud es correcta, la respuesta incluye un token de estado, que puede ser un skipToken (en un encabezado de respuesta @odata.nextLink ) o un deltaToken (en un encabezado de respuesta @odata.deltaLink ). Respectivamente, indican si debe continuar con la ronda o si ha completado la obtención de todos los cambios para esa ronda.

La siguiente respuesta muestra un skipToken en un encabezado de respuesta @odata.nextLink .

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(event)",
    "@odata.nextLink": "https://graph.microsoft.com/beta/me/calendars/AAMkADI5M1BbeAAA=/calendarView/delta?$skiptoken=R0usmcdvmMu7jxWP8",
    "value": [
        {
            "@odata.type": "#microsoft.graph.event",
            "@odata.etag": "W/\"Jdsb3FEkPk2qoUHCdliYowACwixTgw==\"",
            "createdDateTime": "2020-06-16T04:05:43.8668791Z",
            "lastModifiedDateTime": "2020-06-16T04:08:27.354268Z",
            "changeKey": "Jdsb3FEkPk2qoUHCdliYowACwixTgw==",
            "categories": [],
            "transactionId": null,
            "originalStartTimeZone": "Pacific Standard Time",
            "originalEndTimeZone": "Pacific Standard Time",
            "uid": "040000008200E00074C5B7101A82E00800000000F088B8B95843D601000000000000000010000000165CD5547CFC9545B6492B261750B48C",
            "reminderMinutesBeforeStart": 15,
            "isReminderOn": false,
            "hasAttachments": false,
            "subject": "Summer party",
            "bodyPreview": "",
            "importance": "normal",
            "sensitivity": "normal",
            "isAllDay": false,
            "isCancelled": false,
            "isOrganizer": true,
            "IsRoomRequested": false,
            "AutoRoomBookingStatus": "None",
            "responseRequested": true,
            "seriesMasterId": null,
            "showAs": "busy",
            "type": "singleInstance",
            "webLink": "https://outlook.office365.com/owa/?itemid=AAMkADI5MAAKkeE1QAAA%3D&exvsurl=1&path=/calendar/item",
            "onlineMeetingUrl": null,
            "isOnlineMeeting": false,
            "onlineMeetingProvider": "unknown",
            "allowNewTimeProposals": true,
            "OccurrenceId": null,
            "isDraft": false,
            "recurrence": null,
            "AutoRoomBookingOptions": null,
            "onlineMeeting": null,
            "id": "AAMkADI5MAAKkeE1QAAA=",
            "responseStatus": {
                "response": "none",
                "time": "0001-01-01T00:00:00Z"
            },
            "body": {
                "contentType": "html",
                "content": "<html>\r\n<head></head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#954F72\" style=\"\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\">&nbsp;</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
            },
            "start": {
                "dateTime": "2020-06-02T20:00:00.0000000",
                "timeZone": "UTC"
            },
            "end": {
                "dateTime": "2020-06-02T22:30:00.0000000",
                "timeZone": "UTC"
            },
            "location": {
                "displayName": "",
                "locationType": "default",
                "uniqueIdType": "unknown",
                "address": {
                    "type": "unknown"
                },
                "coordinates": {}
            },
            "locations": [],
            "attendees": [
                {
                    "type": "required",
                    "status": {
                        "response": "none",
                        "time": "0001-01-01T00:00:00Z"
                    },
                    "emailAddress": {
                        "name": "Samantha Booth",
                        "address": "samanthab@contoso.com"
                    }
                }
            ],
            "organizer": {
                "emailAddress": {
                    "name": "Samantha Booth",
                    "address": "samanthab@contoso.com"
                }
            }
        },
        {
            "@odata.type": "#microsoft.graph.event",
            "@odata.etag": "W/\"Jdsb3FEkPk2qoUHCdliYowACwixTfw==\"",
            "createdDateTime": "2020-06-16T04:06:18.386713Z",
            "lastModifiedDateTime": "2020-06-16T04:08:19.5694048Z",
            "changeKey": "Jdsb3FEkPk2qoUHCdliYowACwixTfw==",
            "categories": [],
            "transactionId": null,
            "originalStartTimeZone": "Pacific Standard Time",
            "originalEndTimeZone": "Pacific Standard Time",
            "uid": "040000008200E00074C5B7101A82E0080000000060074BC55843D6010000000000000000100000002D33A89F36B10D43A12FD990B62858B2",
            "reminderMinutesBeforeStart": 15,
            "isReminderOn": true,
            "hasAttachments": false,
            "subject": "Summer party part 2",
            "bodyPreview": "",
            "importance": "normal",
            "sensitivity": "normal",
            "isAllDay": false,
            "isCancelled": false,
            "isOrganizer": true,
            "IsRoomRequested": false,
            "AutoRoomBookingStatus": "None",
            "responseRequested": true,
            "seriesMasterId": null,
            "showAs": "busy",
            "type": "singleInstance",
            "webLink": "https://outlook.office365.com/owa/?itemid=AAMkADI5MAAKkeE1RAAA%3D&exvsurl=1&path=/calendar/item",
            "onlineMeetingUrl": null,
            "isOnlineMeeting": false,
            "onlineMeetingProvider": "unknown",
            "allowNewTimeProposals": true,
            "OccurrenceId": null,
            "isDraft": false,
            "recurrence": null,
            "AutoRoomBookingOptions": null,
            "onlineMeeting": null,
            "id": "AAMkADI5MAAKkeE1RAAA=",
            "responseStatus": {
                "response": "none",
                "time": "0001-01-01T00:00:00Z"
            },
            "body": {
                "contentType": "html",
                "content": "<html>\r\n<head></head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#954F72\" style=\"\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\">&nbsp;</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
            },
            "start": {
                "dateTime": "2020-06-04T19:30:00.0000000",
                "timeZone": "UTC"
            },
            "end": {
                "dateTime": "2020-06-04T22:30:00.0000000",
                "timeZone": "UTC"
            },
            "location": {
                "displayName": "",
                "locationType": "default",
                "uniqueIdType": "unknown",
                "address": {
                    "type": "unknown"
                },
                "coordinates": {}
            },
            "locations": [],
            "attendees": [
                {
                    "type": "required",
                    "status": {
                        "response": "none",
                        "time": "0001-01-01T00:00:00Z"
                    },
                    "emailAddress": {
                        "name": "Samantha Booth",
                        "address": "samanthab@contoso.com"
                    }
                }
            ],
            "organizer": {
                "emailAddress": {
                    "name": "Samantha Booth",
                    "address": "samanthab@contoso.com"
                }
            }
        }
    ]
}

Contenido relacionado

• Consulta delta de Microsoft Graph
• Obtener los cambios incrementales de los eventos de una carpeta