Compartilhar via


driveItem: setRetentionLabel

Namespace: microsoft.graph

Aplicar (definir) uma etiqueta de retenção num driveItem (ficheiros e pastas). As etiquetas de retenção não precisam de ser publicadas numa política de etiqueta de retenção para serem aplicadas com este método.

Quando uma etiqueta de retenção é aplicada a uma pasta, todos os itens na pasta são etiquetados com a mesma etiqueta de retenção. Para obter informações sobre a resolução de conflitos para etiquetas de retenção, veja Será que uma etiqueta existente será substituída ou removida. Para obter informações sobre etiquetas de retenção da perspetiva de um administrador, veja Utilizar etiquetas de retenção para gerir o ciclo de vida dos documentos armazenados no SharePoint.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Files.Read.All Files.ReadWrite.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Files.Read.All Files.ReadWrite.All, Sites.ReadWrite.All

Nota:Sites.FullControl.All é a permissão com menos privilégios necessária para alterar as etiquetas de retenção que classificam o conteúdo como registos.

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 do pedido, forneça um objeto JSON com o seguinte parâmetro.

Propriedade Tipo Descrição
name Cadeia de caracteres Especifica o nome da etiqueta de retenção.

Resposta

Quando um ficheiro é aplicado com uma etiqueta de retenção pela primeira vez, este método devolve um 201 Created código de resposta e um objeto itemRetentionLabel atualizado no corpo da resposta. Atualizações subsequentes para retentionLabel devolvem um 200 OK código de 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"
    }
  }
}