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 a serem aplicados usando esse método.

Quando um rótulo de retenção é aplicado a uma pasta, todos os itens na pasta são marcados com o mesmo rótulo de retenção. Para obter informações sobre resolução de conflitos para rótulos de retenção, consulte 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 de documentos armazenados no SharePoint.

Essa API está disponível nas seguintes implantações de nuvem nacional.

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

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
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

Observação

Sites.FullControl.All é a permissão menos privilegiada necessária para alterar os rótulos de retenção que classificam o conteúdo como registros.

Observação

O SharePoint Embedded requer a FileStorageContainer.Selected permissão para acessar o conteúdo do contêiner. Essa permissão é diferente das mencionadas anteriormente. Além das permissões do Microsoft Graph, seu aplicativo deve ter as permissões de tipo de contêiner necessárias para chamar essa API. Para obter mais informações, consulte Autenticação e autorização do SharePoint Embedded.

Solicitação HTTP

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 seguinte parâmetro.

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 código de 201 Created resposta e um objeto itemRetentionLabel atualizado no corpo da resposta. As atualizações subsequentes em 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/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/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"
    }
  }
}