命名空间:microsoft.graph
此作允许会议组织者发送取消消息并取消活动。
该作将事件移动到“已删除邮件”文件夹。 组织者还可以通过提供事件 ID 来取消定期会议的发生。 调用此作的与会者在 HTTP 400 错误请求) (收到错误,并显示以下错误消息:
“你的请求无法完成。 你需要是组织者才能取消会议。”
此作与 “删除” 不同之处在于 ,“取消” 仅对组织者可用,并允许组织者向与会者发送有关取消的自定义消息。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
Calendars.ReadWrite |
不可用。 |
| 委派(个人 Microsoft 帐户) |
Calendars.ReadWrite |
不可用。 |
| 应用程序 |
Calendars.ReadWrite |
不可用。 |
HTTP 请求
POST /me/events/{id}/cancel
POST /users/{id | userPrincipalName}/events/{id}/cancel
POST /groups/{id}/events/{id}/cancel
POST /me/calendar/events/{id}/cancel
POST /users/{id | userPrincipalName}/calendar/events/{id}/cancel
POST /groups/{id}/calendar/events/{id}/cancel
POST /me/calendars/{id}/events/{id}/cancel
POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/cancel
POST /me/calendarGroups/{id}/calendars/{id}/events/{id}/cancel
POST /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/cancel
| 名称 |
类型 |
说明 |
| Authorization |
string |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
string |
实体正文中的数据性质。 必填。 |
请求正文
在请求正文中,提供具有以下参数的 JSON 对象。
| 参数 |
类型 |
说明 |
| 注释 |
String |
发送给所有与会者的关于取消的注释。 可选。 |
响应
如果成功,此方法返回 202 Accepted 响应代码。 它不会在响应正文中返回任何内容。
示例
下面是一个如何调用此 API 的示例。
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/me/events/{id}/cancel
Content-type: application/json
{
"Comment": "Cancelling for this week due to all hands"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Me.Events.Item.Cancel;
var requestBody = new CancelPostRequestBody
{
Comment = "Cancelling for this week due to all hands",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Events["{event-id}"].Cancel.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// 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
)
requestBody := graphusers.NewItemCancelPostRequestBody()
comment := "Cancelling for this week due to all hands"
requestBody.SetComment(&comment)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Events().ByEventId("event-id").Cancel().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.users.item.events.item.cancel.CancelPostRequestBody cancelPostRequestBody = new com.microsoft.graph.users.item.events.item.cancel.CancelPostRequestBody();
cancelPostRequestBody.setComment("Cancelling for this week due to all hands");
graphClient.me().events().byEventId("{event-id}").cancel().post(cancelPostRequestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const cancel = {
Comment: 'Cancelling for this week due to all hands'
};
await client.api('/me/events/{id}/cancel')
.post(cancel);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Events\Item\Cancel\CancelPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CancelPostRequestBody();
$requestBody->setComment('Cancelling for this week due to all hands');
$graphServiceClient->me()->events()->byEventId('event-id')->cancel()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Calendar
$params = @{
Comment = "Cancelling for this week due to all hands"
}
# A UPN can also be used as -UserId.
Stop-MgUserEvent -UserId $userId -EventId $eventId -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.events.item.cancel.cancel_post_request_body import CancelPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CancelPostRequestBody(
comment = "Cancelling for this week due to all hands",
)
await graph_client.me.events.by_event_id('event-id').cancel.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
HTTP/1.1 202 Accepted