Criar shift

Namespace: microsoft.graph

Crie uma nova instância de turno numa agenda.

A duração de um turno não pode ser inferior a 1 minuto ou superior a 24 horas.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	Schedule.ReadWrite.All	Group.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	Schedule.ReadWrite.All	Indisponível.

Solicitação HTTP

POST /teams/{teamId}/schedule/shifts

Cabeçalhos de solicitação

Cabeçalho	Valor
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.
MS-APP-ACTS-AS (preterido)	Um ID de utilizador (GUID). Necessário apenas se o token de autorização for um token de aplicação; caso contrário, opcional. O MS-APP-ACTS-AS cabeçalho foi preterido e já não é necessário com tokens de aplicação.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto shift modificado.

A tabela seguinte lista as propriedades que pode utilizar quando cria um objeto shift .

Propriedade	Tipo	Descrição
draftShift	shiftItem	Redigir alterações no turno. As alterações de rascunho só são visíveis para os gestores. As alterações são visíveis para os funcionários quando são partilhados, o que copia as alterações do draftShift para a propriedade sharedShift . Eiher draShift ou sharedShift deve ser null.
isStagedForDeletion	Booliano	O turno é marcado para eliminação, um processo que é finalizado quando a agenda é partilhada. Opcional.
schedulingGroupId	Cadeia de caracteres	ID do grupo de agendamento do qual o turno faz parte. Obrigatório.
sharedShift	shiftItem	A versão partilhada deste turno que é visível tanto pelos colaboradores como pelos gestores. Atualizações para a propriedade sharedShift, envie notificações aos utilizadores no cliente do Teams. Eiher draShift ou sharedShift deve ser null.
userId	Cadeia de caracteres	ID do utilizador atribuído ao turno. Obrigatório.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto shift no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

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);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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\
}\
'

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// 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)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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
}