列出事件

项目
03/15/2024

命名空间：microsoft.graph

检索日历中的事件列表。可以是用户的日历，也可以是 Microsoft 365 组的默认日历。事件列表包含单个实例会议和系列母版。

要获取扩展的事件实例，可以获取日历视图，或者获取事件的实例。

注意

如果目标邮箱日历包含任何私人项目，则调用方必须：

通过 Add-MailboxPermission cmdlet) 授予FullAccess目标邮箱 (的邮箱权限。
Delegate + CanViewPrivateItems通过 Add-MailboxFolderPermission cmdlet) 授予标志 (与上一选项类似。此选项将所有会议请求路由到委托邮箱。有关解决方法，请参阅 SharingPermissionFlags。

不符合这些条件将导致 The specified object was not found in the store 响应。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

根据事件所处的日历类型和所请求的权限类型（委派型或应用程序），需要下列某一权限来调用此 API。要了解详细信息（包括如何选择权限），请参阅权限。

日历	委派（工作或学校帐户）	委派（个人 Microsoft 帐户）	应用程序
用户日历	Calendars.ReadBasic、Calendars.Read、Calendars.ReadWrite	Calendars.ReadBasic、Calendars.Read、Calendars.ReadWrite	Calendars.ReadBasic、Calendars.Read、Calendars.ReadWrite
组日历	Group.Read.All、Group.ReadWrite.All	不支持。	不支持。

HTTP 请求

用户或组的默认日历。

GET /me/calendar/events
GET /users/{id | userPrincipalName}/calendar/events
GET /groups/{id}/calendar/events

默认 calendarGroup 中用户的日历。

GET /me/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendars/{id}/events

指定 calendarGroup 中用户的日历。

GET /me/calendarGroups/{id}/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events

可选的查询参数

此方法支持 OData 查询参数来帮助自定义响应。

请求标头

名称	类型	说明
Authorization	string	持有者 {token}。必填。详细了解身份验证和授权。
Prefer: outlook.timezone	string	此选项可用于指定响应中开始时间和结束时间的时区。如果未指定，返回的这些时间值采用 UTC 时区。可选。

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此方法在响应正文中返回 200 OK 响应代码和 event 对象集合。

示例

示例 1：列出日历事件

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/me/calendar/events


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Calendar.Events.GetAsync();



mgc users calendar events list --user-id {user-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
events, err := graphClient.Me().Calendar().Events().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EventCollectionResponse result = graphClient.me().calendar().events().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let events = await client.api('/me/calendar/events')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->calendar()->events()->get()->wait();


Import-Module Microsoft.Graph.Calendar

# A UPN can also be used as -UserId.
Get-MgUserDefaultCalendarEvent -UserId $userId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.calendar.events.get()

响应

以下示例显示了相应的响应。注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

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

示例 2：通过筛选主题属性获取事件

本示例通过筛选以"All"开始的主题，获取用户主日历中的事件。

请求

下面为请求示例。

GET https://graph.microsoft.com/v1.0/me/calendar/events?$filter=startsWith(subject,'All')


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Calendar.Events.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "startsWith(subject,'All')";
});



mgc users calendar events list --user-id {user-id} --filter "startsWith(subject,'All')"



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
	  //other-imports
)


requestFilter := "startsWith(subject,'All')"

requestParameters := &graphusers.ItemCalendarEventsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphusers.ItemCalendarEventsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
events, err := graphClient.Me().Calendar().Events().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EventCollectionResponse result = graphClient.me().calendar().events().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "startsWith(subject,'All')";
});


const options = {
	authProvider,
};

const client = Client.init(options);

let events = await client.api('/me/calendar/events')
	.filter('startsWith(subject,\'All\')')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Calendar\Events\EventsRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new EventsRequestBuilderGetRequestConfiguration();
$queryParameters = EventsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "startsWith(subject,'All')";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->calendar()->events()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Calendar

# A UPN can also be used as -UserId.
Get-MgUserDefaultCalendarEvent -UserId $userId -Filter "startsWith(subject,'All')"


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.calendar.events.events_request_builder import EventsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = EventsRequestBuilder.EventsRequestBuilderGetQueryParameters(
		filter = "startsWith(subject,'All')",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.calendar.events.get(request_configuration = request_configuration)

响应