Share via


Obtener una carpeta especial por su nombre

Use la colección especial para acceder a una carpeta especial por su nombre.

Las carpetas especiales proporcionan alias simples para acceder a carpetas conocidas en OneDrive sin necesidad de buscar la carpeta por su ruta (que requeriría localización) o hacer referencia a la carpeta con un identificador. Si una carpeta especial cambia de nombre o se mueve a otra ubicación de la unidad, esta sintaxis seguirá encontrando esa carpeta.

Las carpetas especiales se crean de forma automática la primera vez que una aplicación intenta escribir en una, si aún no existe. Si un usuario elimina una, se vuelve a crear al volver a escribir en ella.

Nota: Si tiene permisos de solo lectura y solicita una carpeta especial que no existe, recibirá un 403 Forbidden error.

Permisos

Se requiere uno de los permisos siguientes para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Tipo de permiso Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft) Files.ReadWrite.AppFolder, Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Aplicación Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitud HTTP

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

Nombres de carpetas especiales

Los siguientes nombres de carpetas especiales están disponibles en OneDrive y OneDrive para la Empresa.

Nombre Id. de carpeta Descripción
Raíz de la aplicación approot La carpeta personal de la aplicación. Normalmente en /Apps/{Application Name}
Álbum de cámara cameraroll La carpeta de copia de seguridad del álbum de cámara.
Escritorio desktop La carpeta Escritorio.
Documentos documents La carpeta Documentos.
Música music La carpeta Música.
Fotos photos La carpeta Fotos.

Parámetros de consulta opcionales

Este método admite los $expandparámetros de consulta y $select OData para personalizar la respuesta.

Respuesta HTTP

Este método devuelve un código de respuesta 200 OK y un objeto driveItem en el cuerpo de la respuesta.

Puede usar este método de direccionamiento de una carpeta especial junto con llamadas adicionales a las propiedades o relaciones en el objeto driveItem.

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

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

Obtener elementos secundarios de una carpeta especial

Para solicitar los elementos secundarios de una carpeta especial, puede solicitar la colección children o usar la opción expand para expandir la colección de elementos secundarios.

Solicitud HTTP

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

Respuesta 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 }
  ]
}

Comentarios

Nota: Los objetos DriveItems con la faceta specialFolder indican que el elemento es una carpeta especial y se puede obtener acceso a ella mediante la colección special.

Si la aplicación tiene permisos de solo lectura, la solicitud para obtener una carpeta especial o los elementos secundarios de una carpeta especial puede producir un error 404 Not Found o 403 Forbidden si la carpeta especial todavía no existe.