List calendarView

  • Artículo

Espacio de nombres: microsoft.graph

Obtenga las repeticiones, excepciones e instancias únicas de eventos en una vista de calendario definida por un intervalo de tiempo, del calendario predeterminado de un usuario (../me/calendarView) u otros calendarios del usuario.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Delegado (cuenta personal de Microsoft) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Aplicación Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite

Solicitud HTTP

calendar predeterminado de un usuario.

GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

calendar de un usuario del calendarGroup predeterminado.

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

calendar de un usuario de un calendarGroup específico.

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

Parámetros de consulta

En la dirección URL de la solicitud, proporcione los siguientes parámetros de consulta necesarios con valores.

Parámetro Tipo Descripción
startDateTime String La fecha y hora de inicio del intervalo de tiempo, representada en formato ISO 8601. Por ejemplo, "2019-11-08T19:00:00-08:00".
endDateTime String La fecha y hora de finalización del intervalo de tiempo, representada en formato ISO 8601. Por ejemplo, "2019-11-08T20:00:00-08:00".

Los valores de startDateTime y endDateTime se interpretan mediante el desplazamiento de zona horaria especificado en el valor y no se ven afectados por el valor del Prefer: outlook.timezone encabezado si están presentes. Si no se incluye ningún desplazamiento entre zonas en el valor, será interpretado como hora UTC.

Este método también admite los Parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.

CalendarView con $top tiene un valor mínimo de 1 y un máximo de 1000.

Nota:

Las propiedades createdDateTime y lastModifiedDateTime del evento no son compatibles $select. Para obtener los valores, simplemente realice una consulta en calendarView sin aplicar $select.

Encabezados de solicitud

Nombre Tipo Descripción
Authorization string {token} de portador. Obligatorio.
Prefer: outlook.timezone string Se usa para especificar la zona horaria de las horas de inicio y final de la respuesta. Si no se especifican, estos valores de hora se devuelven en UTC. Opcional.

Cuerpo de la solicitud

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

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y la colección de objetos event en el cuerpo de la respuesta.

Si el conjunto de resultados abarca varias páginas, calendarView devuelve una propiedad @odata.nextLink en la respuesta que contiene una dirección URL a la siguiente página de resultados. Consulte paginación para más detalles.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/v1.0/me/calendar/calendarView?startDateTime=2017-01-01T19:00:00-08:00&endDateTime=2017-01-07T19:00:00-08:00

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

{
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "response-value",
        "time": "datetime-value"
      },
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}