Listar calendarViewList calendarView

Namespace: microsoft.graphNamespace: microsoft.graph

Obtenha as ocorrências, exceções e instâncias individuais de eventos em uma exibição de calendário definida por um intervalo de tempo, do calendário padrão do usuário ou grupo ou de algum outro calendário do usuário.Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegado (conta corporativa ou de estudante)Delegated (work or school account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
Delegado (conta pessoal da Microsoft)Delegated (personal Microsoft account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
AplicativoApplication Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite

Solicitação HTTPHTTP request

Um calendar padrão do usuário.A user's default calendar.

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

Um calendar de um usuário em um calendarGroup padrão.A user's calendar in the default calendarGroup.

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

Um calendar de um usuário em um calendarGroup específico.A user's calendar in a specific calendarGroup.

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 consultaQuery parameters

Forneça os seguintes parâmetros de consulta necessários com valores na URL solicitada.In the request URL, provide the following required query parameters with values.

ParâmetroParameter TipoType DescriçãoDescription
startDateTimestartDateTime StringString A data e a hora de início do intervalo de tempo, representadas no formato ISO 8601. Por exemplo, "2019-11-08T19:00:00-08:00".The start date and time of the time range, represented in ISO 8601 format. For example, "2019-11-08T19:00:00-08:00".
endDateTimeendDateTime StringString A data e a hora de término do intervalo de tempo, representadas no formato ISO 8601. Por exemplo, "2019-11-08T20:00:00-08:00".The end date and time of the time range, represented in ISO 8601 format. For example, "2019-11-08T20:00:00-08:00".

Os valores de startDateTime e endDateTime são interpretados usando o deslocamento de fuso horário especificado no valor e não são afetados pelo valor do cabeçalho Prefer: outlook.timezone, se presente.The values of startDateTime and endDateTime are interpreted using the timezone offset specified in the value and are not impacted by the value of the Prefer: outlook.timezone header if present. Se nenhum deslocamento de fuso horário estiver incluído no valor, ele será interpretado como UTC.If no timezone offset is included in the value, it is interpreted as UTC.

Este método também dá suporte a alguns Parâmetros de consulta OData para ajudar a personalizar a resposta.This method also supports some of the OData Query Parameters to help customize the response.

Observação

As propriedades createdDateTime e lastModifiedDateTime do evento não são compatíveis com $select.The createdDateTime and lastModifiedDateTime properties of event do not support $select. Para obter os valores, basta consultar no calendarView sem aplicar $select.To get their values, simply query on calendarView without applying $select.

Cabeçalhos de solicitaçãoRequest headers

NomeName TipoType DescriçãoDescription
AutorizaçãoAuthorization stringstring {token} de portador. Obrigatório.Bearer {token}. Required.
Prefira: outlook.timezonePrefer: outlook.timezone stringstring Use isto para especificar o fuso horário para horas de início e término na resposta.Use this to specify the time zone for start and end times in the response. Se não especificado, esses valores de tempo serão retornados em UTC.If not specified, those time values are returned in UTC. Opcional.Optional.
Prefer: outlook.body-content-typePrefer: outlook.body-content-type cadeia de caracteresstring O formato da propriedade corpo a ser retornada.The format of the body property to be returned in. Os valores podem ser "text" ou "html".Values can be "text" or "html". Um cabeçalho Preference-Applied é retornado como confirmação se este cabeçalho Prefer for especificado.A Preference-Applied header is returned as confirmation if this Prefer header is specified. Se o cabeçalho não for especificado, a propriedade corpo será retornada no formato HTML.If the header is not specified, the body property is returned in HTML format. Opcional.Optional.

Corpo da solicitaçãoRequest body

Não forneça um corpo de solicitação para esse método.Do not supply a request body for this method.

RespostaResponse

Se bem-sucedido, este método retorna um código de resposta 200 OK e uma coleção de objetos event no corpo da resposta.If successful, this method returns a 200 OK response code and collection of event objects in the response body.

ExemploExample

SolicitaçãoRequest

Este é um exemplo da solicitação.Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/calendarView?startDateTime=2020-01-01T19:00:00-08:00&endDateTime=2020-01-02T19:00:00-08:00
RespostaResponse

Veja a seguir um exemplo da resposta. Observação: o objeto response mostrado aqui pode estar truncado por motivos de concisão. Todas as propriedades serão retornadas de uma chamada real.Here is an example of the response. 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: 354

{
  "value": [
    {
      "originalStartTimeZone": "Pacific Standard Time",
      "originalEndTimeZone": "Pacific Standard Time",
      "responseStatus": {
        "response": "accepted",
        "time": "2016-10-19T10:37:00Z"
      },
      "iCalUId": "040000008200E00074C5B7101A82E00800000000D3D70B8A6A17D70100000000000000001000000074665914A06C3F49BB4B7D7EEE4304DA",
      "reminderMinutesBeforeStart": 15,
      "isReminderOn": true
    }
  ]
}