列表实例
命名空间:microsoft.graph
获取指定的时间范围的事件的实例(发生次数)。
如果事件的类型是 seriesMaster,这将返回在指定的时间范围内事件的发生次数和异常。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Calendars.Read |
| 委派(个人 Microsoft 帐户) | Calendars.Read |
| 应用程序 | Calendars.Read |
HTTP 请求
GET /me/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendargroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
查询参数
在请求 URL 中,提供以下必要查询参数的值。
| 参数 | 类型 | 说明 |
|---|---|---|
| startDateTime | String | 时间范围的开始日期和时间以 ISO 8601 格式表示。例如,“2015-11-08T19:00:00.0000000”。 |
| endDateTime | String | 时间范围的结束日期和时间以 ISO 8601 格式表示。例如,“2015-11-08T20:00:00.0000000”。 |
此方法支持 OData 查询参数 来帮助自定义响应。
请求标头
| 名称 | 类型 | 说明 |
|---|---|---|
| Authorization | string | Bearer {token}。必需。 |
| Prefer: outlook.timezone | string | 用于指定响应中开始时间和结束时间的时区。如果未指定,返回的这些时间值采用 UTC 时区。可选。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回 200 OK 响应代码和 Event 对象集合。
示例
请求
以下示例获取指定时间范围内的事件(即定期系列的主事件)的发生次数和异常。
GET https://graph.microsoft.com/v1.0/me/events/AAMkAGUzYRgWAAA=/instances?startDateTime=2019-04-08T09:00:00.0000000&endDateTime=2019-04-30T09:00:00.0000000&$select=subject,bodyPreview,seriesMasterId,type,recurrence,start,end
响应
下面是一个响应示例。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('bb8775a4-4d8c-42cf-a1d4-4d58c2bb668f')/events('AAMkAGUzYRgWAAA%3D')/instances(subject,bodyPreview,seriesMasterId,type,recurrence,start,end)",
"value": [
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sE1TatAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "Changing meeting from 4/15 to 4/16.",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "exception",
"recurrence": null,
"start": {
"dateTime": "2019-04-16T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-16T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1ru1JMcAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-08T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-08T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sa1do_AAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-22T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-22T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sw1n3PAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-29T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-29T21:00:00.0000000",
"timeZone": "UTC"
}
}
]
}
反馈
提交和查看相关反馈