命名空间:microsoft.graph
在计划中创建一个新的 timeOff 实例。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
Schedule.ReadWrite.All |
Group.ReadWrite.All |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
Schedule.ReadWrite.All |
不可用。 |
注意:此 API 支持管理员权限。 具有管理员角色的用户可以访问他们不是其成员的组。
HTTP 请求
POST /teams/{teamId}/schedule/timesOff
| 标头 |
值 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
| MS-APP-ACTS-AS (已弃用) |
GUID) (用户 ID。 仅当授权令牌是应用程序令牌时才需要;否则为可选。 标头 MS-APP-ACTS-AS 已弃用,不再需要应用程序令牌。 |
请求正文
在请求正文中,提供 modified timeOff 对象的 JSON 表示形式。
下表列出了创建 timeOff 对象时可以使用的属性。
| 属性 |
类型 |
说明 |
| draftTimeOff |
timeOffItem |
此 timeOff 项的草稿版本,可由经理查看。 必须先共享它,然后才能对团队成员可见。
draftOpenShift 或 sharedOpenShift 应为 null。 |
| isStagedForDeletion |
布尔值 |
timeOff 标记为要删除,这是共享计划时完成的过程。 可选 |
| sharedTimeOff |
timeOffItem |
此 timeOff 的共享版本,可由员工和经理查看。 汇报 sharedTimeOff 属性向 Teams 客户端中的用户发送通知。
draftOpenShift 或 sharedOpenShift 应为 null。 |
| userId |
String |
分配给 timeOff 的用户的 ID。 必填。 |
响应
如果成功,此方法在 201 Created 响应正文中返回响应代码和 timeOff 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/teams/{teamId}/schedule/timesOff
Content-type: application/json
{
"userId": "aa162a04-bec6-4b81-ba99-96caa7b2b24d",
"sharedTimeOff": {
"timeOffReasonId": "TOR_29a5ba96-c7ef-4e76-bec6-055323746314",
"startDateTime": "2024-10-10T19:00:00Z",
"endDateTime": "2024-10-10T20:00:00Z",
"theme": "blue"
},
"draftTimeOff": null,
"isStagedForDeletion": false
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new TimeOff
{
UserId = "aa162a04-bec6-4b81-ba99-96caa7b2b24d",
SharedTimeOff = new TimeOffItem
{
TimeOffReasonId = "TOR_29a5ba96-c7ef-4e76-bec6-055323746314",
StartDateTime = DateTimeOffset.Parse("2024-10-10T19:00:00Z"),
EndDateTime = DateTimeOffset.Parse("2024-10-10T20:00:00Z"),
Theme = ScheduleEntityTheme.Blue,
},
DraftTimeOff = null,
IsStagedForDeletion = false,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teams["{team-id}"].Schedule.TimesOff.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"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewTimeOff()
userId := "aa162a04-bec6-4b81-ba99-96caa7b2b24d"
requestBody.SetUserId(&userId)
sharedTimeOff := graphmodels.NewTimeOffItem()
timeOffReasonId := "TOR_29a5ba96-c7ef-4e76-bec6-055323746314"
sharedTimeOff.SetTimeOffReasonId(&timeOffReasonId)
startDateTime , err := time.Parse(time.RFC3339, "2024-10-10T19:00:00Z")
sharedTimeOff.SetStartDateTime(&startDateTime)
endDateTime , err := time.Parse(time.RFC3339, "2024-10-10T20:00:00Z")
sharedTimeOff.SetEndDateTime(&endDateTime)
theme := graphmodels.BLUE_SCHEDULEENTITYTHEME
sharedTimeOff.SetTheme(&theme)
requestBody.SetSharedTimeOff(sharedTimeOff)
draftTimeOff := null
requestBody.SetDraftTimeOff(&draftTimeOff)
isStagedForDeletion := false
requestBody.SetIsStagedForDeletion(&isStagedForDeletion)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
timesOff, err := graphClient.Teams().ByTeamId("team-id").Schedule().TimesOff().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);
TimeOff timeOff = new TimeOff();
timeOff.setUserId("aa162a04-bec6-4b81-ba99-96caa7b2b24d");
TimeOffItem sharedTimeOff = new TimeOffItem();
sharedTimeOff.setTimeOffReasonId("TOR_29a5ba96-c7ef-4e76-bec6-055323746314");
OffsetDateTime startDateTime = OffsetDateTime.parse("2024-10-10T19:00:00Z");
sharedTimeOff.setStartDateTime(startDateTime);
OffsetDateTime endDateTime = OffsetDateTime.parse("2024-10-10T20:00:00Z");
sharedTimeOff.setEndDateTime(endDateTime);
sharedTimeOff.setTheme(ScheduleEntityTheme.Blue);
timeOff.setSharedTimeOff(sharedTimeOff);
timeOff.setDraftTimeOff(null);
timeOff.setIsStagedForDeletion(false);
TimeOff result = graphClient.teams().byTeamId("{team-id}").schedule().timesOff().post(timeOff);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const timeOff = {
userId: 'aa162a04-bec6-4b81-ba99-96caa7b2b24d',
sharedTimeOff: {
timeOffReasonId: 'TOR_29a5ba96-c7ef-4e76-bec6-055323746314',
startDateTime: '2024-10-10T19:00:00Z',
endDateTime: '2024-10-10T20:00:00Z',
theme: 'blue'
},
draftTimeOff: null,
isStagedForDeletion: false
};
await client.api('/teams/{teamId}/schedule/timesOff')
.post(timeOff);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\TimeOff;
use Microsoft\Graph\Generated\Models\TimeOffItem;
use Microsoft\Graph\Generated\Models\ScheduleEntityTheme;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new TimeOff();
$requestBody->setUserId('aa162a04-bec6-4b81-ba99-96caa7b2b24d');
$sharedTimeOff = new TimeOffItem();
$sharedTimeOff->setTimeOffReasonId('TOR_29a5ba96-c7ef-4e76-bec6-055323746314');
$sharedTimeOff->setStartDateTime(new \DateTime('2024-10-10T19:00:00Z'));
$sharedTimeOff->setEndDateTime(new \DateTime('2024-10-10T20:00:00Z'));
$sharedTimeOff->setTheme(new ScheduleEntityTheme('blue'));
$requestBody->setSharedTimeOff($sharedTimeOff);
$requestBody->setDraftTimeOff(null);
$requestBody->setIsStagedForDeletion(false);
$result = $graphServiceClient->teams()->byTeamId('team-id')->schedule()->timesOff()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Teams
$params = @{
userId = "aa162a04-bec6-4b81-ba99-96caa7b2b24d"
sharedTimeOff = @{
timeOffReasonId = "TOR_29a5ba96-c7ef-4e76-bec6-055323746314"
startDateTime = [System.DateTime]::Parse("2024-10-10T19:00:00Z")
endDateTime = [System.DateTime]::Parse("2024-10-10T20:00:00Z")
theme = "blue"
}
draftTimeOff = $null
isStagedForDeletion = $false
}
New-MgTeamScheduleTimeOff -TeamId $teamId -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.models.time_off import TimeOff
from msgraph.generated.models.time_off_item import TimeOffItem
from msgraph.generated.models.schedule_entity_theme import ScheduleEntityTheme
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = TimeOff(
user_id = "aa162a04-bec6-4b81-ba99-96caa7b2b24d",
shared_time_off = TimeOffItem(
time_off_reason_id = "TOR_29a5ba96-c7ef-4e76-bec6-055323746314",
start_date_time = "2024-10-10T19:00:00Z",
end_date_time = "2024-10-10T20:00:00Z",
theme = ScheduleEntityTheme.Blue,
),
draft_time_off = None,
is_staged_for_deletion = False,
)
result = await graph_client.teams.by_team_id('team-id').schedule.times_off.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('48ba9e52-8d25-41c7-bbe7-5ee6346eec0d')/schedule/timesOff/$entity",
"@odata.etag": "\"40021ee2-0000-0c00-0000-672ea2790000\"",
"id": "SHFT_d0941bce-2229-43f5-b1cd-c9e2eaf592cf",
"createdDateTime": "2024-11-08T23:44:56.913Z",
"lastModifiedDateTime": "2024-11-08T23:44:56.913Z",
"userId": "aa162a04-bec6-4b81-ba99-96caa7b2b24d",
"draftTimeOff": null,
"lastModifiedBy": {
"application": null,
"device": null,
"user": {
"id": "366c0b19-49b1-41b5-a03f-9f3887bd0ed8",
"displayName": "John Doe",
"userIdentityType": "aadUser",
"tenantId": null
}
},
"sharedTimeOff": {
"timeOffReasonId": "TOR_29a5ba96-c7ef-4e76-bec6-055323746314",
"startDateTime": "2024-10-10T19:00:00Z",
"endDateTime": "2024-10-10T20:00:00Z",
"theme": "blue"
},
"isStagedForDeletion": false
}