Create or replace schedule

Article
07/20/2022
7 minutes to read

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create or replace a schedule object.

The schedule creation process conforms to the One API guideline for resource based long running operations (RELO). When clients use the PUT method, if the schedule is provisioned, the operation replaces the schedule; otherwise, the operation starts the schedule provisioning process in the background.

During schedule provisioning, clients can use the GET method to get the schedule and look at the provisionStatus property for the current state of the provisioning. If the provisioning failed, clients can get additional information from the provisionStatusCode property.

Clients can also inspect the configuration of the schedule.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Schedule.ReadWrite.All, Group.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Schedule.ReadWrite.All

HTTP request

PUT /teams/{teamId}/schedule

Request headers

Header	Value
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of a schedule object.

Response

If successful, this method returns a 200 OK response code and a schedule object in the response body.

Examples

Example 1: Update a schedule

Request

The following is an example of the request.

PUT https://graph.microsoft.com/beta/teams/{teamId}/schedule
Content-type: application/json

{
  "enabled": true,
  "timeZone": "America/Chicago"
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var schedule = new Schedule
{
	Enabled = true,
	TimeZone = "America/Chicago"
};

await graphClient.Teams["{team-id}"].Schedule
	.Request()
	.PutAsync(schedule);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const schedule = {
  enabled: true,
  timeZone: 'America/Chicago'
};

await client.api('/teams/{teamId}/schedule')
	.version('beta')
	.put(schedule);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Schedule schedule = new Schedule();
schedule.enabled = true;
schedule.timeZone = "America/Chicago";

graphClient.teams("{teamId}").schedule()
	.buildRequest()
	.put(schedule);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewSchedulePostRequestBody()
additionalData := map[string]interface{}{
	enabled := true
requestBody.SetEnabled(&enabled) 
	"timeZone" : "America/Chicago", 
}
requestBody.SetAdditionalData(additionalData)

graphClient.TeamsById("team-id").Schedule().Put(requestBody)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new SchedulePostRequestBody();
$additionalData = [
'enabled' => true,
'timeZone' => 'America/Chicago', 
];
$requestBody->setAdditionalData($additionalData);




$graphServiceClient->teamsById('team-id')->schedule()->put($requestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "833fc4df-c88b-4398-992f-d8afcfe41df2",
  "enabled": true,
  "timeZone": "America/Chicago",
  "provisionStatus": "Completed",
  "provisionStatusCode": null,
  "timeClockEnabled": true,
  "openShiftsEnabled": true,
  "swapShiftsRequestsEnabled": true,
  "offerShiftRequestsEnabled": true,
  "timeOffRequestsEnabled": true
}

Example 2: Enable location detection for time clock

Request

The following is an example of the request.

PUT https://graph.microsoft.com/beta/teams/871dbd5c-3a6a-4392-bfe1-042452793a50/schedule

{
   "enabled":true,
   "timeZone":"America/Chicago",
   "provisionStatus":"Completed",
   "provisionStatusCode":null,
   "openShiftsEnabled":true,
   "swapShiftsRequestsEnabled":true,
   "offerShiftRequestsEnabled":true,
   "timeOffRequestsEnabled":true,
   "timeClockEnabled":true,
   "timeClockSettings":{
      "approvedLocation":{
         "altitude":1024.13,
         "latitude":26.13246,
         "longitude":24.34616
      }
   }
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

using var schedule = new System.IO.MemoryStream(Encoding.UTF8.GetBytes(@"{
   ""enabled"":true,
   ""timeZone"":""America/Chicago"",
   ""provisionStatus"":""Completed"",
   ""provisionStatusCode"":null,
   ""openShiftsEnabled"":true,
   ""swapShiftsRequestsEnabled"":true,
   ""offerShiftRequestsEnabled"":true,
   ""timeOffRequestsEnabled"":true,
   ""timeClockEnabled"":true,
   ""timeClockSettings"":{
      ""approvedLocation"":{
         ""altitude"":1024.13,
         ""latitude"":26.13246,
         ""longitude"":24.34616
      }
   }
}"));

await graphClient.Teams["{team-id}"].Schedule
	.Request()
	.PutAsync<Team>(schedule);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const schedule = {
   enabled: true,
   timeZone: 'America/Chicago',
   provisionStatus: 'Completed',
   provisionStatusCode: null,
   openShiftsEnabled: true,
   swapShiftsRequestsEnabled: true,
   offerShiftRequestsEnabled: true,
   timeOffRequestsEnabled: true,
   timeClockEnabled: true,
   timeClockSettings: {
      approvedLocation: {
         altitude: 1024.13,
         latitude: 26.13246,
         longitude: 24.34616
      }
   }
};

await client.api('/teams/871dbd5c-3a6a-4392-bfe1-042452793a50/schedule')
	.version('beta')
	.put(schedule);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

byte[] schedule = Base64.getDecoder().decode("{   "enabled":true,   "timeZone":"America/Chicago",   "provisionStatus":"Completed",   "provisionStatusCode":null,   "openShiftsEnabled":true,   "swapShiftsRequestsEnabled":true,   "offerShiftRequestsEnabled":true,   "timeOffRequestsEnabled":true,   "timeClockEnabled":true,   "timeClockSettings":{      "approvedLocation":{         "altitude":1024.13,         "latitude":26.13246,         "longitude":24.34616      }   }} ");
	graphClient.teams("871dbd5c-3a6a-4392-bfe1-042452793a50").schedule()
	.buildRequest()
	.put(schedule);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewSchedulePostRequestBody()
additionalData := map[string]interface{}{
	enabled := true
requestBody.SetEnabled(&enabled) 
	"timeZone" : "America/Chicago", 
	"provisionStatus" : "Completed", 
	provisionStatusCode := null
requestBody.SetProvisionStatusCode(&provisionStatusCode) 
	openShiftsEnabled := true
requestBody.SetOpenShiftsEnabled(&openShiftsEnabled) 
	swapShiftsRequestsEnabled := true
requestBody.SetSwapShiftsRequestsEnabled(&swapShiftsRequestsEnabled) 
	offerShiftRequestsEnabled := true
requestBody.SetOfferShiftRequestsEnabled(&offerShiftRequestsEnabled) 
	timeOffRequestsEnabled := true
requestBody.SetTimeOffRequestsEnabled(&timeOffRequestsEnabled) 
	timeClockEnabled := true
requestBody.SetTimeClockEnabled(&timeClockEnabled) 
timeClockSettings := graphmodels.New()
approvedLocation := graphmodels.New()
altitude := int32(1024.13)
approvedLocation.SetAltitude(&altitude) 
latitude := int32(26.13246)
approvedLocation.SetLatitude(&latitude) 
longitude := int32(24.34616)
approvedLocation.SetLongitude(&longitude) 
	timeClockSettings.SetApprovedLocation(approvedLocation)
	requestBody.SetTimeClockSettings(timeClockSettings)
}
requestBody.SetAdditionalData(additionalData)

graphClient.TeamsById("team-id").Schedule().Put(requestBody)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new SchedulePostRequestBody();
$additionalData = [
'enabled' => true,
'timeZone' => 'America/Chicago', 
'provisionStatus' => 'Completed', 
'provisionStatusCode' => 		null,
'openShiftsEnabled' => true,
'swapShiftsRequestsEnabled' => true,
'offerShiftRequestsEnabled' => true,
'timeOffRequestsEnabled' => true,
'timeClockEnabled' => true,
'timeClockSettings' => $requestBody = new TimeClockSettings();
$approvedLocation = new ApprovedLocation();
		$approvedLocation->setAltitude(1024.13);

		$approvedLocation->setLatitude(26.13246);

		$approvedLocation->setLongitude(24.34616);


$requestBody->setApprovedLocation($approvedLocation);

$requestBody->setTimeClockSettings($timeClockSettings);

];
$requestBody->setAdditionalData($additionalData);




$graphServiceClient->teamsById('team-id')->schedule()->put($requestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
   "enabled":true,
   "timeZone":"America/Chicago",
   "provisionStatus":"Completed",
   "provisionStatusCode":null,
   "openShiftsEnabled":true,
   "swapShiftsRequestsEnabled":true,
   "offerShiftRequestsEnabled":true,
   "timeOffRequestsEnabled":true,
   "timeClockEnabled":true,
   "timeClockSettings":{
      "approvedLocation":{
         "altitude":1024.13,
         "latitude":26.13246,
         "longitude":24.34616
      }
   }
}

Create or replace schedule

Permissions

HTTP request

Request headers

Request body

Response

Examples

Example 1: Update a schedule

Request

Response

Example 2: Enable location detection for time clock

Request

Response

Feedback