Partager via

Obtenir un dossier spécial par nom

  • Article

Utilisez la collection spéciale pour accéder à un dossier spécial par nom.

Les dossiers spéciaux fournissent des alias simples pour accéder aux dossiers connus dans OneDrive sans avoir besoin de rechercher le dossier par le chemin d’accès (ce qui nécessiterait une localisation), ou référencent le dossier avec un ID. Si un dossier spécial est renommé ou déplacé vers un autre emplacement dans le lecteur, cette syntaxe continuera à rechercher ce dossier.

Les dossiers spéciaux sont créés automatiquement la première fois qu’une application tente d’écrire dans un dossier, s’il n’existe pas encore. Si un utilisateur supprime un dossier, il est recréé lorsqu’une application écrit à nouveau dans ce dossier.

Note: Si vous disposez d’autorisations en lecture seule et que vous demandez un dossier spécial qui n’existe pas, vous recevez une 403 Forbidden erreur.

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Déléguée (compte Microsoft personnel) Files.ReadWrite.AppFolder, Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Application Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Requête HTTP

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

Noms de dossier spécial

Les noms de dossier spécial suivants sont disponibles dans OneDrive et OneDrive Entreprise.

Nom Identificateur de dossier Description
Racine de l’application approot Le dossier personnel de l’application. Généralement dans /Apps/{Application Name}
Pellicule cameraroll Dossier de sauvegarde de la pellicule.
Bureau desktop Dossier Bureau.
Documents documents Dossier Documents.
Musique music Dossier Musique.
Photos photos Dossier Photos.

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de $expandrequête OData et $select pour personnaliser la réponse.

Réponse HTTP

Cette méthode renvoie un code de réponse 200 OK et une ressource driveItem dans le corps de la réponse.

Vous pouvez utiliser cette méthode d’adressage d’un dossier spécial en ligne avec des appels supplémentaires vers les propriétés ou les relations sur la ressource driveItem.

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

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

Obtenir les enfants d’un dossier spécial

Pour demander l’enfant d’un dossier spécifique, vous pouvez demander la collection children ou utiliser l’option expand pour développer la collection d’enfants.

Requête HTTP

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

Réponse 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 }
  ]
}

Remarques

Remarque : L’objet DriveItems avec la facette specialFolder indique que l’élément est un dossier spécial et qu’il est accessible via la collection special.

Si votre application bénéficie d’autorisations en lecture seule, la requête permettant d’obtenir un dossier spécial ou les enfants d’un dossier spécial peut échouer avec une erreur 404 Not Found ou 403 Forbidden si le dossier spécial n’existe pas déjà.