创建排班

命名空间：microsoft.graph

在计划中创建新的班次实例。

班次的持续时间不能小于 1 分钟或超过 24 小时。

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

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

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	Schedule.ReadWrite.All	Group.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	Schedule.ReadWrite.All	不可用。

HTTP 请求

POST /teams/{teamId}/schedule/shifts

请求标头

标头	值
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type	application/json. 必需。
MS-APP-ACTS-AS	GUID) (用户 ID。 仅当授权令牌是应用程序令牌时才需要;否则为可选。

请求正文

在请求正文中，提供修改后的 shift 对象的 JSON 表示形式。

下表列出了在创建 shift 对象时可以使用的属性。

属性	类型	说明
draftShift	shiftItem	轮 班中的草稿更改。 草稿更改仅对经理可见。 更改在 共享时对员工可见，这会将 更改从 draftShift 复制到 sharedShift 属性。 Eiher draShift 或 sharedShift 应为 null。
isStagedForDeletion	布尔值	班次标记为要删除，这是共享计划时完成的过程。 可选。
schedulingGroupId	String	班次所属的计划组的 ID。 必填。
sharedShift	shiftItem	员工和经理均可查看的此 班次 的共享版本。 汇报 sharedShift 属性向 Teams 客户端中的用户发送通知。 Eiher draShift 或 sharedShift 应为 null。
userId	String	分配给 班次的用户的 ID。 必填。

响应

如果成功，此方法在响应正文中返回响应 201 Created 代码和 shift 对象。

示例

请求

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

HTTP

POST https://graph.microsoft.com/v1.0/teams/{teamId}/schedule/shifts
Content-type: application/json

{
  "userId": "5ca83ce7-291d-43b7-bf53-af79eef4bc1d",
  "draftShift": {
    "displayName": null,
    "startDateTime": "2024-10-08T15:00:00Z",
    "endDateTime": "2024-10-09T00:00:00Z",
    "theme": "blue",
    "notes": null,
    "activities": []
  },
  "sharedShift": null,
  "isStagedForDeletion": false
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Shift
{
	UserId = "5ca83ce7-291d-43b7-bf53-af79eef4bc1d",
	DraftShift = new ShiftItem
	{
		DisplayName = null,
		StartDateTime = DateTimeOffset.Parse("2024-10-08T15:00:00Z"),
		EndDateTime = DateTimeOffset.Parse("2024-10-09T00:00:00Z"),
		Theme = ScheduleEntityTheme.Blue,
		Notes = null,
		Activities = new List<ShiftActivity>
		{
		},
	},
	SharedShift = 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.Shifts.PostAsync(requestBody);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

mgc teams schedule shifts create --team-id {team-id} --body '{\
  "userId": "5ca83ce7-291d-43b7-bf53-af79eef4bc1d",\
  "draftShift": {\
    "displayName": null,\
    "startDateTime": "2024-10-08T15:00:00Z",\
    "endDateTime": "2024-10-09T00:00:00Z",\
    "theme": "blue",\
    "notes": null,\
    "activities": []\
  },\
  "sharedShift": null,\
  "isStagedForDeletion": false\
}\
'

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

// 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.NewShift()
userId := "5ca83ce7-291d-43b7-bf53-af79eef4bc1d"
requestBody.SetUserId(&userId) 
draftShift := graphmodels.NewShiftItem()
displayName := null
draftShift.SetDisplayName(&displayName) 
startDateTime , err := time.Parse(time.RFC3339, "2024-10-08T15:00:00Z")
draftShift.SetStartDateTime(&startDateTime) 
endDateTime , err := time.Parse(time.RFC3339, "2024-10-09T00:00:00Z")
draftShift.SetEndDateTime(&endDateTime) 
theme := graphmodels.BLUE_SCHEDULEENTITYTHEME 
draftShift.SetTheme(&theme) 
notes := null
draftShift.SetNotes(&notes) 
activities := []graphmodels.ShiftActivityable {

}
draftShift.SetActivities(activities)
requestBody.SetDraftShift(draftShift)
sharedShift := null
requestBody.SetSharedShift(&sharedShift) 
isStagedForDeletion := false
requestBody.SetIsStagedForDeletion(&isStagedForDeletion) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
shifts, err := graphClient.Teams().ByTeamId("team-id").Schedule().Shifts().Post(context.Background(), requestBody, nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Shift shift = new Shift();
shift.setUserId("5ca83ce7-291d-43b7-bf53-af79eef4bc1d");
ShiftItem draftShift = new ShiftItem();
draftShift.setDisplayName(null);
OffsetDateTime startDateTime = OffsetDateTime.parse("2024-10-08T15:00:00Z");
draftShift.setStartDateTime(startDateTime);
OffsetDateTime endDateTime = OffsetDateTime.parse("2024-10-09T00:00:00Z");
draftShift.setEndDateTime(endDateTime);
draftShift.setTheme(ScheduleEntityTheme.Blue);
draftShift.setNotes(null);
LinkedList<ShiftActivity> activities = new LinkedList<ShiftActivity>();
draftShift.setActivities(activities);
shift.setDraftShift(draftShift);
shift.setSharedShift(null);
shift.setIsStagedForDeletion(false);
Shift result = graphClient.teams().byTeamId("{team-id}").schedule().shifts().post(shift);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const shift = {
  userId: '5ca83ce7-291d-43b7-bf53-af79eef4bc1d',
  draftShift: {
    displayName: null,
    startDateTime: '2024-10-08T15:00:00Z',
    endDateTime: '2024-10-09T00:00:00Z',
    theme: 'blue',
    notes: null,
    activities: []
  },
  sharedShift: null,
  isStagedForDeletion: false
};

await client.api('/teams/{teamId}/schedule/shifts')
	.post(shift);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Shift;
use Microsoft\Graph\Generated\Models\ShiftItem;
use Microsoft\Graph\Generated\Models\ScheduleEntityTheme;
use Microsoft\Graph\Generated\Models\ShiftActivity;


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

$requestBody = new Shift();
$requestBody->setUserId('5ca83ce7-291d-43b7-bf53-af79eef4bc1d');
$draftShift = new ShiftItem();
$draftShift->setDisplayName(null);
$draftShift->setStartDateTime(new \DateTime('2024-10-08T15:00:00Z'));
$draftShift->setEndDateTime(new \DateTime('2024-10-09T00:00:00Z'));
$draftShift->setTheme(new ScheduleEntityTheme('blue'));
$draftShift->setNotes(null);
$draftShift->setActivities([	]);
$requestBody->setDraftShift($draftShift);
$requestBody->setSharedShift(null);
$requestBody->setIsStagedForDeletion(false);

$result = $graphServiceClient->teams()->byTeamId('team-id')->schedule()->shifts()->post($requestBody)->wait();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Teams

$params = @{
	userId = "5ca83ce7-291d-43b7-bf53-af79eef4bc1d"
	draftShift = @{
		displayName = $null
		startDateTime = [System.DateTime]::Parse("2024-10-08T15:00:00Z")
		endDateTime = [System.DateTime]::Parse("2024-10-09T00:00:00Z")
		theme = "blue"
		notes = $null
		activities = @(
		)
	}
	sharedShift = $null
	isStagedForDeletion = $false
}

New-MgTeamScheduleShift -TeamId $teamId -BodyParameter $params

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.shift import Shift
from msgraph.generated.models.shift_item import ShiftItem
from msgraph.generated.models.schedule_entity_theme import ScheduleEntityTheme
from msgraph.generated.models.shift_activity import ShiftActivity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Shift(
	user_id = "5ca83ce7-291d-43b7-bf53-af79eef4bc1d",
	draft_shift = ShiftItem(
		display_name = None,
		start_date_time = "2024-10-08T15:00:00Z",
		end_date_time = "2024-10-09T00:00:00Z",
		theme = ScheduleEntityTheme.Blue,
		notes = None,
		activities = [
		],
	),
	shared_shift = None,
	is_staged_for_deletion = False,
)

result = await graph_client.teams.by_team_id('team-id').schedule.shifts.post(request_body)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

以下示例显示了相应的响应。

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "SHFT_0f004eda-32a6-4f0c-a076-18f76d997a55",
  "createdDateTime": "2024-11-08T23:49:13.877Z",
  "lastModifiedDateTime": "2024-11-08T23:49:13.877Z",
  "schedulingGroupId": "TAG_4ab7d329-1f7e-4eaf-ba93-63f1ff3f3c4a",
  "userId": "5ca83ce7-291d-43b7-bf53-af79eef4bc1d",
  "sharedShift": null,
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "id": "366c0b19-49b1-41b5-a03f-9f3887bd0ed8",
      "displayName": "John Doe",
      "userIdentityType": "aadUser",
      "tenantId": null
    }
  },
  "draftShift": {
    "displayName": null,
    "startDateTime": "2024-10-08T15:00:00Z",
    "endDateTime": "2024-10-09T00:00:00Z",
    "theme": "blue",
    "notes": null,
    "activities": []
  },
  "isStagedForDeletion": false
}