Список calendarView

  • Статья

Пространство имен: microsoft.graph

Получение в представлении календаря исключений, повторяемых или единичных экземпляров событий за определенный диапазон времени, указанных в стандартном календаре (../me/calendarView) или любом другом календаре пользователя.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Делегированные (личная учетная запись Майкрософт) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Для приложений Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite

HTTP-запрос

Экземпляр calendar по умолчанию для пользователя.

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

Экземпляр calendar пользователя в экземпляре по умолчанию 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}

Календарь в определенном объекте 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}

Параметры запроса

В URL-адресе запроса укажите перечисленные ниже обязательные параметры запроса и их значения.

Параметр Тип Описание
startDateTime String Дата и время начала диапазона, представленные в формате ISO 8601. Например, "2019-11-08T19:00:00-08:00".
endDateTime String Дата и время окончания диапазона, представленные в формате ISO 8601. Например, "2019-11-08T20:00:00-08:00".

Значения startDateTime и endDateTime интерпретируются с помощью смещения часового пояса, указанного в значении, и не влияют на значение заголовка Prefer: outlook.timezone , если оно присутствует. Если в значении не указано смещение часового пояса, оно интерпретируется в формате UTC.

Этот метод также поддерживает некоторые параметры запросов OData для настройки отклика.

CalendarView с $top имеет минимальное значение 1 и максимальное значение 1000.

Примечание.

Свойства createdDateTime и lastModifiedDateTimeсобытия не поддерживают $select. Чтобы получить их значения, просто запросите calendarView, не применяя $select.

Заголовки запросов

Имя Тип Описание
Authorization string Bearer {token}. Обязательно.
Prefer: outlook.timezone string С помощью этого заголовка вы можете задать часовой пояс для времени начала и окончания в ответе. Если он не задан, эти значения времени возвращаются в формате UTC. Необязательный параметр.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха этот метод возвращает код отклика 200 OK и коллекцию объектов event в теле отклика.

Если набор результатов занимает несколько страниц, calendarView возвращает в ответе свойство @odata.nextLink, содержащее URL-адрес следующей страницы результатов. Дополнительные сведения см. в разделе о разбиении на страницы.

Пример

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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
    }
  ]
}