driveItem: discardCheckout

Namespace: microsoft.graph

Discard the check out of a driveItem. This action releases a driveItem resource that was previously checked out. Any changes made to the item while it was checked out are discarded.

The same user that performed the checkout must discard it. Another alternative is to use application permissions.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Files.ReadWrite	Files.ReadWrite.All, Sites.ReadWrite.All
Delegated (personal Microsoft account)	Files.ReadWrite	Files.ReadWrite.All
Application	Files.ReadWrite.All	Sites.ReadWrite.All

Note

SharePoint Embedded requires the FileStorageContainer.Selected permission to access the content of the container. This permission is different than the ones mentioned in the table. For more information, see SharePoint Embedded authentication and authorization. In addition to Microsoft Graph permissions, your app must have the necessary container type-level permission or permissions to call this API. For more information, see container types. To learn more about container type-level permissions, see SharePoint Embedded authorization.

HTTP request

POST /drive/root/discardCheckout
POST /drives/{drivesId}/root/discardCheckout
POST /shares/{sharesId}/root/discardCheckout
POST /drive/items/{driveItemId}/discardCheckout
POST /shares/{sharesId}/driveItem/discardCheckout
POST /drive/bundles/{driveItemId}/discardCheckout
POST /drive/special/{driveItemId}/discardCheckout
POST /drive/following/{driveItemId}/discardCheckout

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

The request returns 400 Bad Request if the file isn't checked out. Requests made with delegated access return 423 Locked if another user has the file checked out. Requests made with application access can discard any checkout.

For more information about how errors are returned, see Error responses.

Examples

Request

The following example shows a discard checkout request on a file identified by {item-id}.

HTTP

POST https://graph.microsoft.com/v1.0/drives/{drive-id}/items/{item-id}/discardCheckout

C#

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].DiscardCheckout.PostAsync();

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

CLI

mgc drives items discard-checkout post --drive-id {drive-id} --drive-item-id {driveItem-id}

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

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"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").DiscardCheckout().Post(context.Background(), nil)

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

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").discardCheckout().post();

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/drives/{drive-id}/items/{item-id}/discardCheckout')
	.post();

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


$graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->discardCheckout()->post()->wait();

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').discard_checkout.post()

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