driveItem: releaseLock

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.

Release the exclusive lock that the calling user currently holds on a file represented by a driveItem. After successful release, the file is immediately available for other users to lock and modify.

Note

This API applies only to driveItems that represent files. Folders or other non-file driveItems can't be locked, so there's nothing to release. Requests that target a non-file driveItem are rejected with 400 Bad Request.

Only the user who currently holds the lock can release it. The server identifies the lock from the file's current state (no lock identifier is required from the caller).

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)	Not supported.	Not supported.
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 from the ones mentioned previously. In addition to Microsoft Graph permissions, your app must have the necessary container type permissions to call this API. For more information, see SharePoint Embedded authentication and authorization.

HTTP request

POST /drives/{drive-id}/items/{item-id}/releaseLock

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. The server determines the lock to release from the file's current lock state and the caller's identity.

Response

If successful, this method returns a 204 No Content response code. The lock is fully removed from the file and the file becomes available for other users to lock.

This method returns the following error response codes.

HTTP code	Description
400	Bad request. The target driveItem isn't a file (for example, a folder).
401	Request lacks valid authentication credentials.
403	The caller doesn't have permission to release the lock on this file.
404	The driveItem wasn't found at the specified path.
409	The file isn't currently locked, or the caller isn't the lock owner. Use lock to acquire a lock first.

For more information about how errors are returned, see Error responses and resource types for differences between Microsoft Graph for Microsoft accounts and Microsoft Graph for work or school accounts.

Examples

The following example releases the lock the calling user currently holds on the file identified by {item-id}.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/drives/{drive-id}/items/{item-id}/releaseLock

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/drives/{drive-id}/items/{item-id}/releaseLock')
	.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

Remarks

• Only exclusive locks are currently supported.
• The caller must currently hold the lock. The server validates ownership by comparing the caller's identity against the lock owner recorded on the file. Other users that attempt to release the lock receive 409 Conflict.
• After release, the file's lock state is cleared: a subsequent call to GET /drives/{drive-id}/items/{item-id}?$select=lockInfo returns the lockInfo facet with lockType none and an empty owners array.
• Releasing a lock is immediate and final; there's no soft state to recover. To re-acquire the lock, use lock.
• If the file isn't currently locked, the request fails with 409 Conflict.