Obtenir un dossier spécial par nom

Espace de noms: microsoft.graph

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 dossier spécial 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.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

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

HTTP

GET /me/drive/special/{name}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Special["{driveItem-id}"].GetAsync();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc drives special get --drive-id {drive-id} --drive-item-id {driveItem-id}

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



special, err := graphClient.Drives().ByDriveId("drive-id").Special().ByDriveItemId("driveItem-id").Get(context.Background(), nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DriveItem result = graphClient.drives().byDriveId("{drive-id}").special().byDriveItemId("{driveItem-id}").get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let driveItem = await client.api('/me/drive/special/{name}')
	.get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->drives()->byDriveId('drive-id')->special()->byDriveItemId('driveItem-id')->get()->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Files

Get-MgDriveSpecial -DriveId $driveId -DriveItemId $driveItemId

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.drives.by_drive_id('drive-id').special.by_drive_item_id('driveItem-id').get()

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

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

HTTP

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

C#

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let children = await client.api('/me/drive/special/{special-folder-name}/children')
	.get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

Snippet not available

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

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