title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
driveItem: getRetentionLabel |
Get metadata information for a retention label applied on a driveItem. |
kyracatwork |
medium |
onedrive |
apiPageType |
Namespace: microsoft.graph
Get metadata information for a retention label applied on a driveItem.
For information about retention labels from an administrator's perspective, see Use retention labels to manage the lifecycle of documents stored in SharePoint.
[!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.Read.All, Sites.Read.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Files.Read.All, Sites.Read.All |
GET /driveitem/retentionLabel
GET /drives/{drive-id}/items/{item-id}/retentionLabel
GET /drives/{drive-id}/items/{item-id}?$expand=retentionLabel
This method supports the $expand
OData query parameter to help customize the response.
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and an itemRetentionLabel object in the response body.
The following example shows a request.
GET https://graph.microsoft.com/v1.0/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/lists/documents/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/driveitem/retentionLabel
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": false,
"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"
}
}
}