driveItem: setRetentionLabel
Namespace: microsoft.graph
Aplicar (definir) um rótulo de retenção em um driveItem (arquivos e pastas). Os rótulos de retenção não precisam ser publicados em uma política de rótulo de retenção para serem aplicados usando esse método.
Quando um rótulo de retenção é aplicado a uma pasta, todos os itens da pasta são marcados com o mesmo rótulo de retenção. Para obter informações sobre a resolução de conflitos para rótulos de retenção, consulte Será que um rótulo existente será substituído ou removido. Para obter informações sobre rótulos de retenção da perspectiva de um administrador, consulte Usar rótulos de retenção para gerenciar o ciclo de vida dos documentos armazenados no SharePoint.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.
Tipo | Permissões (da com menos para a com mais privilégios) |
---|---|
Delegado (conta corporativa ou de estudante) | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. |
Application | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
Nota:
Sites.FullControl.All
é a permissão menos privilegiada necessária para alterar rótulos de retenção que classificam o conteúdo como registros.
Solicitação HTTP
PATCH /driveitem/retentionLabel
PATCH /drives/{drive-id}/items/{item-id}/retentionLabel
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Content-Type | application/json. Obrigatório. |
Corpo da solicitação
No corpo da solicitação, forneça um objeto JSON com o parâmetro a seguir.
Propriedade | Tipo | Descrição |
---|---|---|
name | Cadeia de caracteres | Especifica o nome do rótulo de retenção. |
Resposta
Quando um arquivo é aplicado com um rótulo de retenção pela primeira vez, esse método retorna um 201 Created
código de resposta e um objeto item AtualizadoRetentionLabel no corpo da resposta. Atualizações subsequentes para retentionLabel retornam um código de 200 OK
resposta.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
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"
}
Resposta
O exemplo a seguir mostra a resposta.
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"
}
}
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de