Obtenha uma pasta especial por nomeGet a special folder by name

Namespace: microsoft.graphNamespace: microsoft.graph

Use a coleção especial para acessar uma pasta especial pelo nome.Use the special collection to access a special folder by name.

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.Special folders provide simple aliases to access well-known folders in OneDrive without the need to look up the folder by path (which would require localization), or reference the folder with an ID. If a special folder is renamed or moved to another location within the drive, this syntax will continue to find that folder.

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.Special folders are automatically created the first time an application attempts to write to one, if it doesn't already exist. If a user deletes one, it is recreated when written to again.

Observação: Se tiver permissões somente leitura e solicitar uma pasta especial que não exista, você receberá um erro 403 Forbidden.Note: If you have read-only permissions and request a special folder that doesn't exist, you'll receive a 403 Forbidden error.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegado (conta corporativa ou de estudante)Delegated (work or school account) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft)Delegated (personal Microsoft account) Files.ReadWrite.AppFolder, Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.ReadWrite.AppFolder, Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
AplicativoApplication Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitação HTTPHTTP Request

GET /me/drive/special/{name}

Nomes de pasta especialSpecial folder names

Os nomes de pasta especial a seguir estão disponíveis no OneDrive e no OneDrive for Business.The follow special folder names are available in OneDrive and OneDrive for Business.

NomeName Id da pastaFolder id DescriçãoDescription
DocumentosDocuments documents A pasta Documentos.The Documents folder.
FotosPhotos photos A pasta Fotos.The Photos folder.
Imagens da CâmeraCamera Roll cameraroll A pasta de Backup de Imagens da Câmera.The Camera Roll Backup folder.
Raiz de AplicativoApp Root approot Pasta pessoal do aplicativo. Geralmente em /Apps/{Application Name}The application's personal folder. Usually in /Apps/{Application Name}
MúsicaMusic music A pasta Música.The Music folder.

Parâmetros de consulta opcionaisOptional query parameters

Este método oferece suporte aos parâmetros de consulta OData $expand e $select para personalizar a resposta.This method supports the $expand and $select OData query parameters to customize the response.

RespostaResponse

Este método retorna um código de resposta 200 OK e um objeto driveItem no corpo da resposta.This method returns a 200 OK response code and a driveItem object in the response body.

Você pode usar esse método de lidar com uma pasta especial em linha com chamadas adicionais para propriedades ou relações no driveItem.You can use this method of addressing a special folder inline with additional calls to properties or relationships on the 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 especialGet children of a special folder

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.To request the children of a special folder, you can request the children collection or use the expand option to expand the children collection.

Solicitação HTTPHTTP request

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

RespostaResponse

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áriosRemarks

Observação: A faceta specialFolder de DriveItems indica que o item é uma pasta especial e pode ser acessado pelo conjunto special.Note: DriveItems with the specialFolder facet indicate the item is a special folder and can be accessed via the special collection.

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.If your app has read-only permissions, the request to get a special folder or the children of a special folder may fail with a 404 Not Found or a 403 Forbidden error if the special folder does not already exist.