Obtener una carpeta especial por su nombre
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
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.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
---|---|---|
Delegado (cuenta profesional o educativa) | Files.Read | Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Delegado (cuenta personal de Microsoft) | Files.ReadWrite.AppFolder | Files.Read, Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All |
Aplicación | No admitida. | No admitida. |
Solicitud HTTP
GET /me/drive/special/{name}
Nombres de carpetas especiales
Los siguientes nombres de carpeta especiales están disponibles en OneDrive y OneDrive para la Empresa.
Nombre | Id. de carpeta | Descripción |
---|---|---|
Documentos | documents |
La carpeta Documentos. |
Fotos | photos |
La carpeta Fotos. |
Álbum de cámara | cameraroll |
La carpeta de copia de seguridad del álbum de cámara. |
Raíz de la aplicación | approot |
La carpeta personal de la aplicación. Normalmente en /Apps/{Application Name} . |
Música | music |
La carpeta Música. |
Grabaciones | recordings |
La carpeta Grabaciones. Esta opción solo está disponible en OneDrive para la Empresa y SharePoint Online. |
Parámetros de consulta opcionales
Este método admite los $expand
parámetros de consulta y $select
OData para personalizar la respuesta.
Respuesta
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.
Ejemplos
Ejemplo 1: Obtención de una carpeta especial por nombre
Solicitud
GET /me/drive/special/{name}
Respuesta
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "0123456789abc",
"name": "Documents",
"eTag": "012345819293.1",
"specialFolder": {
"name": "documents"
}
}
Ejemplo 2: 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
GET /me/drive/special/{name}/children
Respuesta
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ónspecial
.
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.