changeTrackedEntity: stageForDeletion

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.

Stage the deletion of an openShift, shift, or timeOff instance in a schedule in draft mode.

Draft changes are only visible to managers. Team members aren't sent notification for draft changes. The deletion is finalized when the schedule is shared.

Permissions

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

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Schedule.ReadWrite.All	Group.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Schedule.ReadWrite.All	Not available.

HTTP request

For an openShift:

POST /teams/{teamsId}/schedule/openShifts/{openShiftId}/stageForDeletion

For a shift:

POST /teams/{teamsId}/schedule/shifts/{shiftId}/stageForDeletion

For a timeOff:

POST /teams/{teamsId}/schedule/timesOff/{timeOffId}/stageForDeletion

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
MS-APP-ACTS-AS	A user ID (GUID). Required only if the authorization token is an application token; otherwise, optional.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 204 No Content response code.

Examples

Example 1: Stage the deletion of an openShift

The following example shows how to stage the deletion of an openShift in a schedule in draft mode.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/openShifts/OPNSHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8/stageForDeletion

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/openShifts/OPNSHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8/stageForDeletion')
	.version('beta')
	.post();

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.

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 2: Stage the deletion of a shift

The following example shows how to stage the deletion of a shift in a schedule in draft mode.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/shifts/SHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8/stageForDeletion

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/shifts/SHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8/stageForDeletion')
	.version('beta')
	.post();

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.

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 3: Stage the deletion of a timeOff

The following example shows how to stage the deletion of a timeOff in a schedule in draft mode.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/timesOff/SHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8/stageForDeletion

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/timesOff/SHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8/stageForDeletion')
	.version('beta')
	.post();

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.

Response

The following example shows the response.

HTTP/1.1 204 No Content