Obtenha uma pasta especial por nome

  • Artigo

Use a coleção especial para acessar uma pasta especial pelo nome.

Pastas especiais fornecem aliases simples para acessar pastas conhecidas no OneDrive sem a necessidade de pesquisar a pasta pelo caminho (o que exigiria a localização) ou fazer referência à pasta com uma ID. Se uma pasta especial for renomeada ou movida para outro local na unidade de disco, esta sintaxe continuará a localizar a pasta.

As pastas especiais são criadas automaticamente na primeira vez que um aplicativo tenta gravar em uma, caso ainda não existam. Se um usuário excluir uma, ela será recriada quando algo for gravado nela novamente.

Nota: Se tiver permissões só de leitura e pedir uma pasta especial que não existe, receberá um 403 Forbidden erro.

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 de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Files.ReadWrite.AppFolder, Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Aplicativo Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitação HTTP

GET /me/drive/special/{special-folder-name}

Nomes de pasta especial

Os nomes de pasta especial a seguir estão disponíveis no OneDrive e no OneDrive for Business.

Nome Id da pasta Descrição
Raiz de Aplicativo approot Pasta pessoal do aplicativo. Geralmente em /Apps/{Application Name}
Imagens da Câmera cameraroll A pasta de Backup de Imagens da Câmera.
Área de trabalho desktop A pasta Área de trabalho.
Documentos documents A pasta Documentos.
Música music A pasta Música.
Fotos photos A pasta Fotos.

Parâmetros de consulta opcionais

Este método suporta os $expandparâmetros de consulta OData e $select para personalizar a resposta.

Resposta HTTP

Este método retorna um código de resposta 200 OK e um objeto driveItem no corpo da resposta.

Você pode usar esse método de lidar com uma pasta especial em linha com chamadas adicionais para propriedades ou relações no driveItem.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "0123456789abc",
  "name": "Documents",
  "eTag": "012345819293.1",
  "specialFolder": {
    "name": "documents"
  }
}

Obter filhos de uma pasta especial

Para solicitar os filhos de uma pasta especial, você pode solicitar a coleção children ou usar a opção expand para expandir a coleção de filhos.

Solicitação HTTP

GET /me/drive/special/{special-folder-name}/children

Resposta HTTP

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {"name": "myfile.jpg", "size": 2048 },
    {"name": "Documents", "folder": { "childCount": 4} },
    {"name": "Photos", "folder": { "childCount": 203} },
    {"name": "my sheet(1).xlsx", "size": 197 }
  ]
}

Comentários

Observação: A faceta specialFolder de DriveItems indica que o item é uma pasta especial e pode ser acessado pelo conjunto special.

Se seu aplicativo tiver permissões somente leitura, a solicitação para obter uma pasta especial ou os filhos de uma pasta especial poderá falhar com um erro 404 Not Found ou 403 Forbidden, se a pasta especial ainda não existir.