driveItem: setRetentionLabel
Espacio de nombres: microsoft.graph
Aplique (establezca) una etiqueta de retención en un driveItem (archivos y carpetas). Las etiquetas de retención no necesitan publicarse en una directiva de etiquetas de retención para aplicarlas mediante este método.
Cuando se aplica una etiqueta de retención a una carpeta, todos los elementos de la carpeta se etiquetan con la misma etiqueta de retención. Para obtener información sobre la resolución de conflictos para las etiquetas de retención, consulte Will a existing label be over invalida or removed. Para obtener información sobre las etiquetas de retención desde la perspectiva de un administrador, vea Uso de etiquetas de retención para administrar el ciclo de vida de los documentos almacenados en SharePoint.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permisos
Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.
Tipo | Permisos (de menos a más privilegiados) |
---|---|
Delegado (cuenta profesional o educativa) | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
Delegado (cuenta personal de Microsoft) | No admitida. |
Aplicación | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
Nota:
Sites.FullControl.All
es el permiso con privilegios mínimos necesario para cambiar las etiquetas de retención que clasifican el contenido como registros.
Solicitud HTTP
PATCH /driveitem/retentionLabel
PATCH /drives/{drive-id}/items/{item-id}/retentionLabel
Encabezados de solicitud
Nombre | Descripción |
---|---|
Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
Content-Type | application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con el parámetro siguiente.
Propiedad | Tipo | Descripción |
---|---|---|
name | Cadena | Especifica el nombre de la etiqueta de retención. |
Respuesta
Cuando se aplica un archivo con una etiqueta de retención por primera vez, este método devuelve un 201 Created
código de respuesta y un objeto itemRetentionLabel actualizado en el cuerpo de la respuesta. Las actualizaciones posteriores de retentionLabel devuelven un código de 200 OK
respuesta.
Ejemplos
Solicitud
En el ejemplo siguiente se muestra la solicitud.
PATCH https://graph.microsoft.com/v1.0/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/retentionLabel
Content-Type: application/json
{
"name": "Retention label for Contracts"
}
Respuesta
En el ejemplo siguiente se muestra la respuesta.
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"
}
}
}
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de