Partager via

Obtenir un dossier spécial par nom

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

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.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Files.Read Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Déléguée (compte Microsoft personnel) Files.ReadWrite.AppFolder Files.Read, Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All
Application Non prise en charge. Non prise en charge.

Requête HTTP

GET /me/drive/special/{name}

Noms de dossier spécial

Les noms de dossiers spéciaux suivants sont disponibles dans OneDrive et OneDrive Entreprise.

Nom Identificateur de dossier Description
Documents documents Dossier Documents.
Photos photos Dossier Photos.
Pellicule cameraroll Dossier de sauvegarde de la pellicule.
Racine de l’application approot Le dossier personnel de l’application. Généralement dans /Apps/{Application Name}.
Musique music Dossier Musique.
Enregistrements recordings Dossier Enregistrements. Cette option est disponible uniquement dans OneDrive Entreprise et SharePoint Online.

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

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.

Exemples

Exemple 1 : Obtenir un dossier spécial par nom

Demande

GET /me/drive/special/{name}

Réponse

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

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

Exemple 2 : Obtenir les enfants d’un dossier spécial

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

Demande

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

Réponse

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à.