event: deltaevent: delta

Importante

Las API de /beta la versión de Microsoft Graph están sujetas a cambios.APIs under the /beta version in Microsoft Graph are subject to change. No se admite el uso de estas API en aplicaciones de producción.Use of these APIs in production applications is not supported.

Obtenga un conjunto de eventos que se han agregado, eliminado o actualizado en una calendarView (un intervalo de eventos) del calendario principal del usuario.Get a set of events that have been added, deleted, or updated in a calendarView (a range of events) of the user's primary calendar.

La llamada de una función delta para eventos funciona de forma similar a una solicitud GET /calendarview para un intervalo de fechas en el calendario principal del usuario, salvo que, al aplicar correctamente los tokens de estado en al menos una de estas llamadas, pueda realizar una consulta para obtener los cambios incrementales en la vista del calendario. Esto permite mantener y sincronizar un almacén local de eventos de un usuario en el calendario principal, sin tener que capturar cada vez todos los eventos de ese calendario desde el servidor.A delta function call for events is similar to a GET /calendarview request for a range of dates in the user's primary calendar, except that by appropriately applying state tokens in one or more of these calls, you can query for incremental changes in that calender view. This allows you to maintain and synchronize a local store of a user's events in the primary calendar, without having to fetch all the events of that calendar from the server every time.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
AplicaciónApplication Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite

Solicitud HTTPHTTP request

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

Parámetros de consultaQuery parameters

El seguimiento de cambios en los eventos conlleva al menos una llamada de una 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 nextLink o deltaLink proporcionada en la respuesta. Solo debe especificar una vez por adelantado los parámetros de consulta deseados. En solicitudes posteriores, basta con copiar y aplicar la dirección URL nextLink o deltaLink de la respuesta anterior, dado que la dirección URL ya incluye los parámetros codificados deseados.Tracking changes in events incurs a round of one or more delta function calls. If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. You only need to specify any desired query parameters once upfront. In subsequent requests, simply copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

Parámetro de consultaQuery parameter TipoType DescripciónDescription
startDateTimestartDateTime StringString La fecha y hora de inicio del intervalo de tiempo, representada en formato ISO 8601. Por ejemplo, "2015-11-08T19:00:00.0000000".The start date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T19:00:00.0000000".
endDateTimeendDateTime StringString La fecha y hora de finalización del intervalo de tiempo, representada en formato ISO 8601. Por ejemplo, "2015-11-08T20:00:00.0000000".The end date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T20:00:00.0000000".
$deltatoken$deltatoken stringstring Token de estado que se devuelve en la dirección URL de deltaLink de la llamada de función delta anterior para la misma colección de usuarios. Indica el progreso de la ronda de seguimiento de cambios. Guarde y aplique toda la dirección URL deltaLink, incluido este token, en la primera solicitud de la siguiente ronda de seguimiento de la vista del calendario.A state token returned in the deltaLink URL of the previous delta function call for the same calendar view, indicating the completion of that round of change tracking. Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that calendar view.
$skiptoken$skiptoken stringstring Token de estado que se devuelve en la dirección URL de nextLink de la llamada de función delta. Indica que debe realizarse el seguimiento de más cambios en la misma vista del calendario.A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same calendar view.

Al hacer una consulta delta en una vista del calendario, se espera obtener todas las propiedades que se obtendrían con normalidad de una solicitud GET /calendarview. $select no se admite en este caso.When you do a delta query on a calendar view, expect to get all the properties you'd normally get from a GET /calendarview request. $select is not supported in this case.

Encabezados de solicitudRequest headers

NombreName TipoType DescripciónDescription
AuthorizationAuthorization stringstring {token} de portador. Obligatorio.Bearer {token}. Required.
Content-TypeContent-Type stringstring application/json. Obligatorio.application/json. Required.
PreferPrefer stringstring odata.maxpagesize={x}. Opcional.odata.maxpagesize={x}. Optional.
PreferPrefer stringstring {Zona horaria}. Opcional, se supone la hora UTC si no se encuentra.{Time zone}. Optional, UTC assumed if absent.

RespuestaResponse

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto de colección event en el cuerpo de la respuesta.If successful, this method returns a 200 OK response code and event collection object in the response body.

EjemploExample

SolicitudRequest

En el ejemplo siguiente se muestra cómo realizar una llamada de función delta única y limitar el número máximo de eventos en el cuerpo de la respuesta a 2.The following example shows how to make a single delta function call, and limit the maximum number of events in the response body to 2.

Para realizar un seguimiento de la vista del calendario, debería realizar al menos una llamada de función delta, con unos tokens de estado adecuados, para obtener el conjunto de cambios incrementales desde la última consulta delta.To track changes in a calendar view, you would make one or more delta function calls, with appropriate state tokens, to get the set of incremental changes since the last delta query.

GET https://graph.microsoft.com/beta/me/calendarview/delta?startdatetime={start_datetime}&enddatetime={end_datetime}

Prefer: odata.maxpagesize=2
RespuestaResponse

Si la solicitud es correcta, la respuesta debería incluir 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 bien si ha terminado de obtener todos los cambios de la ronda.If the request is successful, the response would include a state token, which is either a skipToken (in an _@odata.nextLink_ response header) or a deltaToken (in an _@odata.deltaLink_ response header). Respectively, they indicate whether you should continue with the round or you have completed getting all the changes for that round.

La respuesta siguiente muestra un skipToken en un encabezado de respuesta de _@odata.nextLink_.The response below shows a skipToken in an _@odata.nextLink_ response header.

Nota: Es posible que el objeto de respuesta que aparezca aquí esté truncado para abreviar. Todas las propiedades se devolverán de una llamada real.Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/calendarview/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "response-value",
        "time": "datetime-value"
      },
      "uid": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}

Vea tambiénSee also