title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
driveItem: lockOrUnlockRecord |
Lock or unlock a retention label on a driveItem that classifies content as records. |
kyracatwork |
medium |
onedrive |
apiPageType |
Namespace: microsoft.graph
Lock or unlock a retention label on a driveItem that classifies content as records.
For information about retention labels from an administrator's perspective, see Use retention labels to manage the lifecycle of documents stored in SharePoint.
For more information about how you can lock and unlock retention labels, see Use record versioning to update records stored in SharePoint or OneDrive.
[!INCLUDE national-cloud-support]
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Files.ReadWrite.All, Sites.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Files.ReadWrite.All, Sites.ReadWrite.All |
PATCH /driveitem/retentionLabel
PATCH /drives/{drive-id}/items/{item-id}/retentionLabel
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
In the request body, provide a JSON object with the following parameter.
Property | Type | Description |
---|---|---|
retentionSettings | retentionLabelSettings | The retention settings enforced on the item. |
If successful, this method returns a 200 OK
response code and an updated itemRetentionLabel object in the response body.
The following example shows a request.
PATCH https://graph.microsoft.com/v1.0/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/retentionLabel
Content-Type: application/json
{
"retentionSettings": {
"isRecordLocked": true
}
}
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "Retention label for Contracts",
"retentionSettings": {
"behaviorDuringRetentionPeriod": "retain",
"isDeleteAllowed": false,
"isRecordLocked": true,
"isMetadataUpdateAllowed": false,
"isContentUpdateAllowed": false,
"isLabelUpdateAllowed": false
},
"isLabelAppliedExplicitly": false,
"labelAppliedDateTime": "2022-12-22T10:18:23.6580555+00:00",
"labelAppliedBy": {
"user": {
"id": "56d171c8-a92e-4359-9c4a-38b88ac7eabd",
"displayName": "Contoso Admin"
}
}
}