事件资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
用户日历或 Microsoft 365 组默认日历中的事件。
事件中包含的最大与会者人数，以及发送自 Exchange Online 邮箱的 eventMessage 中的收件人数上限都是 500 人。 有关详细信息，请参阅发送限制。
该资源支持：
注释：与用户日历、组日历及其事件交互的方式稍有不同：
- 只可以组织 calendarGroup 中的用户日历。
- 只能将 attachment 对象添加到用户日历中的事件，而不能添加到组日历中的事件。
- Outlook 将代表组自动接受所有会议请求。 只能接受、暂时接受或拒绝用户日历的会议请求。
- Outlook 不支持对组事件提供提醒。 只可以暂停或消除用户日历中的提醒。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | Event 集合 | 检索用户邮箱中的 event 对象列表。 该列表包含单实例会议和系列主控事件。 |
| 创建 | 事件 | 通过发布到实例集合创建新事件。 |
| 获取 | 事件 | 读取 event 对象的属性和关系。 |
| 更新 | 事件 | 更新事件对象。 |
| 删除 | 无 | 删除 event 对象。 |
| 永久删除 | None | 永久删除事件并将其放置在用户邮箱的“可恢复邮件”文件夹中的“清除”文件夹中。 |
| 获取增量 | event 集合 | 获取一组在 calendarView 中添加、删除或更新的事件集， (用户的主日历) 一系列事件。 |
| 转发事件 | 无 | 让会议事件的组织者或与会者可以将会议请求转发给新的收件人。 |
| 取消事件 | 无 | 将取消消息从组织者发送至所有与会者，并取消指定会议。 |
| Accept 事件 | 无 | 接受用户日历中的指定事件。 |
| 暂时接受 | 无 | 暂时接受用户日历中的指定事件。 |
| 拒绝事件 | 无 | 拒绝用户日历中的指定事件邀请。 |
| 关闭提醒 | 无 | 消除用户日历中指定事件的提醒。 |
| 推迟提醒 | 无 | 将用户日历中指定事件的提醒推迟至新的时间。 |
| 列出事件实例 | Event 集合 | 获取 event 对象集合。 |
| 附件 | ||
| 列出附件 | Attachment 集合 | 获取事件的所有附件。 |
| Add attachment | 附件 | 通过发布到附件集合，向事件添加新附件。 |
| 开放扩展 | ||
| 创建开放扩展 | openTypeExtension | 创建开放扩展，并将自定义属性添加到新资源或现有资源。 |
| 获取开放扩展 | openTypeExtension 集合 | 获取扩展名称标识的开放扩展。 |
| 扩展属性 | ||
| 创建单值属性 | 事件 | 在新建或现有事件中创建一个或多个单值扩展属性。 |
| 获取单值属性 | 事件 | 通过使用 $expand 或 $filter 获取包含单值扩展属性的事件。 |
| 创建多值属性 | 事件 | 在新建或现有的事件中创建一个或多个多值扩展属性。 |
| 获取多值属性 | 事件 | 使用 $expand 获取包含一个多值扩展属性的事件。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| allowNewTimeProposals | 布尔值 |
true 如果会议组织者允许被邀请者在答复时建议新时间，则为 ;否则为 false。 可选。 默认值为 true。 |
| attendees | Attendee 集合 | 事件的与会者集合。 |
| body | ItemBody | 与事件相关联的邮件正文。 可以是 HTML 格式或文本格式。 |
| bodyPreview | String | 与事件相关联的邮件预览。 文本格式。 |
| cancelledOccurrences | 字符串集合 | 如果事件是系列主节点，则包含定期序列中已取消实例的 occurrenceId 属性值。 已取消的定期系列中的实例称为 canceledOccurences。 仅在 Get 操作的 $select 中返回，该操作指定系列母版事件（即 seriesMasterId 属性值）的 ID。 |
| categories | String collection | 与事件相关联的类别。 每个类别对应于为用户定义的 outlookCategory 的 displayName 属性。 |
| changeKey | String | 标识 event 对象的版本。 每次事件更改时，ChangeKey 也将更改。 这样，Exchange 可以将更改应用于该对象的正确版本。 |
| createdDateTime | DateTimeOffset | 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| end | DateTimeTimeZone | 事件结束的日期、时间和时区。 默认情况下，结束时间为 UTC 时间。 |
| exceptionOccurrences | event 集合 | 包含定期系列中的例外事件实例的 id 属性值。 例外可能不同于定期系列中的其他事件，如主题、开始或结束时间或与会者。 异常不包括已取消的匹配项。 仅在 get 操作中 指定系列主 (事件 ID 的 GET 操作$select和$expand上返回，即 seriesMasterId 属性值) 。 |
| hasAttachments | Boolean | 如果事件包含附件，则设置为 true。 |
| hideAttendees | 布尔值 | 如果设置为 true，则每个与会者仅会在会议请求和会议 跟踪 列表中看到自己。 默认值为 false。 |
| iCalUId | 字符串 | 跨日历事件的唯一标识符。 此 ID 对于定期系列中的每个单一事件来说是不同的。 只读。 |
| id | String | 事件的唯一标识符。
默认情况下，当项从一个容器（如文件夹或日历）移动到另一个容器时，此值会更改。 若要更改此行为，请使用 Prefer: IdType="ImmutableId"头。 有关详细信息，请参阅获取 Outlook 资源的不可变标识符。 区分大小写和只读。 |
| importance | String | 事件的重要性。 可取值为：low、normal、high。 |
| isAllDay | Boolean | 如果事件持续一整天，则设置为 true。 如果为 true，无论是单天事件还是多天事件，都必须将开始和结束时间设置为午夜，并且必须处于同一时区。 |
| isCancelled | Boolean | 如果事件已取消，则设置为 true。 |
| isDraft | Boolean | 如果用户在 Outlook 中更新了会议，但尚未将更新发送给与会者，则设置为 true。 如果所有更改均已发送，或者如果事件是不带任何与会者的约会，则设置为 false。 |
| isOnlineMeeting | Boolean | 若此事件包含联机会议信息（即 onlineMeeting 指向 onlineMeetingInfo 资源）则为 True，反之则为 false。 默认值为 false（onlineMeeting 为 null）。 可选。 将 isOnlineMeeting 设置为 true 后，Microsoft Graph 将初始化 onlineMeeting。 然后，Outlook 将忽略 对 isOnlineMeeting 的任何进一步更改，并且会议仍可联机访问。 |
| isOrganizer | Boolean | 如果日历所有者（通过“日历”的“所有者”属性指定）是事件的组织者（通过“事件”的“组织者”属性指定），设定为 true。 这也适用于代理人代表所有者组织事件。 |
| isReminderOn | Boolean | 如果设置警报以提醒用户有事件，则设置为 true。 |
| lastModifiedDateTime | DateTimeOffset | 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| 位置 | 位置 | 事件的位置。 |
| 位置 | location 集合 | 举办或参加活动的地点。 location 和 locations 属性总是相互对应。 如果更新 location 属性，locations 集合中所有以前的位置都将被删除并替换为新的 location 值。 |
| occurrenceId | 字符串 | 定期事件系列中的事件的标识符。 如果事件不是定期序列的一部分，则为 Null。 属性值的格式为 OID.{seriesMasterId-value}.{occurrence-start-date}。 {occurrence-start-date} 的时区是为相应 recurrenceRange 定义的 recurrenceTimeZone 属性。 此属性可以标识定期系列中的任何事件，包括已修改或取消的匹配项。 可使用此属性执行定期系列中的事件所支持的所有操作。 |
| onlineMeeting | OnlineMeetingInfo | 关于与会者如何加入联机会议的详细信息。 默认值为 Null。 只读。 设置 isOnlineMeeting 和 onlineMeetingProvider 属性以启用联机会议后，Microsoft Graph 将初始化 onlineMeeting。 设置后，会议将保持联机状态，并且无法再次更改 isOnlineMeeting、 onlineMeetingProvider 和 onlneMeeting 属性。 |
| onlineMeetingProvider | onlineMeetingProviderType | 表示联机会议服务提供商。 默认情况下，onlineMeetingProvider 为 unknown。 可取值为：unknown、teamsForBusiness、skypeForBusiness 和 skypeForConsumer。 可选。 设置 isOnlineMeeting 后，Microsoft Graph 将初始化 onlineMeeting。 随后无法再次更改 onlineMeetingProvider ，并且会议仍可联机访问。 |
| onlineMeetingUrl | String | 联机会议的 URL。 仅当组织者在 Outlook 中将事件指定为联机会议（如 Skype）才会设置此属性。 只读。 若要访问 URL 参加联机会议，请使用通过 event 的 onlineMeeting 属性公开的 joinUrl。 未来即将弃用 onlineMeetingUrl 属性。 |
| 组织者 | 收件人 | 事件的组织者。 |
| originalEndTimeZone | String | 创建事件时设置的结束时区。
tzone://Microsoft/Custom 值表示旧的自定义时区已在桌面版 Outlook 中设置。 |
| originalStart | DateTimeOffset | 表示事件最初在定期系列中作为事件或异常创建的开始时间。 对于单个实例的事件，不会返回此属性。 其日期和时间信息以 ISO 8601 格式表示，并且始终采用 UTC。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| originalStartTimeZone | String | 创建事件时设置的开始时区。 值表示旧的自定义时区在桌面版 Outlook 中设置。 |
| recurrence | PatternedRecurrence | 事件的定期模式。 |
| reminderMinutesBeforeStart | Int32 | 事件开始时间（即提醒警报发生时间）之前的分钟数。 |
| responseRequested | 布尔值 | 默认值为 true，表示组织者愿意被邀请者发送事件响应。 |
| responseStatus | ResponseStatus | 指示在事件消息的响应中发送的响应类型。 |
| sensitivity | String | 可能的值是：normal、personal、private、confidential。 |
| seriesMasterId | String | 定期系列主项的 ID（如果此事件是定期系列的一部分）。 |
| showAs | String | 要显示的状态。 可取值为：free、tentative、busy、oof、workingElsewhere、unknown。 |
| start | DateTimeTimeZone | 事件的开始日期、时间和时区。 默认情况下，开始时间使用 UTC 格式。 |
| subject | String | 事件的主题行文本。 |
| transactionId | 字符串 | 客户端应用为服务器指定的自定义标识符，以便在客户端重试创建同一事件时避免冗余 POST 操作。 当低网络连接性导致客户端在从服务器中收到客户端先前创建事件请求的响应之前超时时，此功能很有用。 在创建事件时设置 transactionId 后，无法在后续更新中更改 transactionId 。 如果应用已设置此属性，则仅在响应有效负载中返回此属性。 可选。 |
| type | String | 事件类型。 可取值为：singleInstance、occurrence、exception、seriesMaster。 只读 |
| uid | 字符串 | 日历事件的唯一标识符。 对于定期事件，Series Master 及其所有事件（包括异常）的此值均相同。 |
| webLink | String | 要在 Web 上的 Outlook 中打开事件的 URL。 如果你已登录到邮箱，Outlook 网页版将在浏览器中打开事件。 否则，Outlook 网页面会提示你进行登录。 无法从 iFrame 内部访问此 URL。 |
注意
webLink 属性指定了一个 URL，它仅在 Outlook 网页版早期版本中打开事件。 其 URL 的格式如下所示，其中 {event-id} 是 id 属性的 URL 编码值：
对于工作或学校帐户：
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item对于 Microsoft 帐户：
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
要在 Outlook 网页版的当前版本中打开事件，请将 URL 转换为下述格式之一，并使用该 URL 打开事件：
对于工作或学校帐户：
https://outlook.office365.com/calendar/item/{event-id}对于 Microsoft 帐户：
https://outlook.live.com/calendar/item/{event-id}
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| attachments | Attachment 集合 | 事件的 FileAttachment、ItemAttachment 和 referenceAttachment 附件的集合。 导航属性。 只读。 可为 Null。 |
| 日历 | Calendar | 包含事件的日历。 导航属性。 只读。 |
| extensions | 扩展集合 | 为事件定义的开放扩展集合。 可为空。 |
| 实例 | Event 集合 | 定期系列的出现次数（如果该事件是系列母版事件）。 此属性包括属于重复模式的一部分的匹配项和已修改的异常。 它不包括已从系列中取消的匹配项。 导航属性。 只读。 可为 Null。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty 集合 | 为事件定义的多值扩展属性的集合。 只读。 可为 Null。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | 为事件定义的单值扩展属性的集合。 只读。 可为 Null。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"allowNewTimeProposals": "Boolean",
"attendees": [{"@odata.type": "microsoft.graph.attendee"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"cancelledOccurrences":["string"],
"categories": ["string"],
"changeKey": "string",
"createdDateTime": "String (timestamp)",
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"exceptionOccurrences":["microsoft.graph.event"],
"hasAttachments": true,
"hideAttendees": false,
"iCalUId": "String",
"id": "string (identifier)",
"importance": "String",
"isAllDay": true,
"isCancelled": true,
"isDraft": false,
"isOnlineMeeting": true,
"isOrganizer": true,
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"locations": [{"@odata.type": "microsoft.graph.location"}],
"occurrenceId":"string",
"onlineMeeting": {"@odata.type": "microsoft.graph.onlineMeetingInfo"},
"onlineMeetingProvider": "string",
"onlineMeetingUrl": "string",
"organizer": {"@odata.type": "microsoft.graph.recipient"},
"originalEndTimeZone": "string",
"originalStart": "String (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderMinutesBeforeStart": 1024,
"responseRequested": true,
"responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
"sensitivity": "String",
"seriesMasterId": "string",
"showAs": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"type": "String",
"uid": "String",
"webLink": "string",
"attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"extensions": [ { "@odata.type": "microsoft.graph.extension" } ],
"instances": [ { "@odata.type": "microsoft.graph.event" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }]
}