Get retentionLabel
Namespace: microsoft.graph.security
Read the properties and relationships of a retentionLabel object.
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) | RecordsManagement.Read.All | RecordsManagement.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Not supported. | Not supported. |
HTTP request
GET /security/labels/retentionLabels/{retentionLabelId}
GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId}
Optional query parameters
This method supports the expand OData query parameters to help customize the response. For example, to retrieve the retentionEventType property, you can use the expand
parameter:$expand=retentionEventType
or $expand=descriptors
. For general information, see OData query parameters.
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 method returns a 200 OK
response code and a microsoft.graph.security.retentionLabel object in the response body.
Examples
Request
Here's an example of a request.
GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}
Response
Here's an example of the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.security.retentionLabel",
"id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
"displayName": "Retention Schedule 10004",
"behaviorDuringRetentionPeriod": "retain",
"actionAfterRetentionPeriod": "relabel",
"retentionTrigger": "dateCreated",
"retentionDuration": {
"@odata.type": "microsoft.graph.security.retentionDurationInDays",
"days": 730
},
"isInUse": true,
"descriptionForAdmins": "creation based retention label for schedule 10004",
"descriptionForUsers": "retains for 2 years then relabeled",
"createdBy": {
"user": {
"id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
"displayName": "Admin"
}
},
"createdDateTime": "2017-11-27T02:10:12Z",
"lastModifiedBy": {
"user": {
"id": "9563a605-e827-4324-a5a9-09efddff1e90",
"displayName": "Records Manager"
}
},
"lastModifiedDateTime": "2020-08-28T22:13:09Z",
"labelToBeApplied": "Retention schedule 10005",
"defaultRecordBehavior": "startLocked"
}
}
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: