Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Aplicar (establecer) una etiqueta de retención en un elemento de unidad (archivos y carpetas). No es necesario publicar las etiquetas de retención en una directiva de etiquetas de retención para que se apliquen 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 con las etiquetas de retención, consulte ¿Se anulará o quitará una etiqueta existente? Para obtener información sobre las etiquetas de retención desde la perspectiva de un administrador, vea Usar etiquetas de retención para administrar el ciclo de vida de los documentos almacenados en SharePoint.
Esta API está disponible en las siguientes implementaciones en la nube nacional.
| Servicio global | Administración pública de EE. UU. | Gobierno de EE. UU. L5 (DOD) | China operado por 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
|---|---|---|
| Delegado (cuenta profesional o educativa) | Files.Read.All | Files.ReadWrite.All, Sites.ReadWrite.All |
| Delegado (cuenta personal de Microsoft) | No admitida. | 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.
Nota:
SharePoint Embedded requiere permiso FileStorageContainer.Selected para acceder al contenido del contenedor. Este permiso es diferente de los mencionados anteriormente. Además de los permisos de Microsoft Graph, la aplicación debe tener los permisos de tipo de contenedor necesarios para llamar a esta API. Para obtener más información, consulte Autenticación y autorización de SharePoint Embedded.
Solicitud HTTP
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 autenticación y autorización. |
| Content-Type | application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con el siguiente parámetro.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | Cadena | Especifica el nombre de la etiqueta de retención. |
Respuesta
Cuando un archivo se aplica 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 200 OK código de respuesta.
Ejemplos
Solicitud
En el ejemplo siguiente se muestra la solicitud.
PATCH https://graph.microsoft.com/beta/drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/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"
}
}
}