Obtenir un dossier spécial par nom

Cette page est-elle utile ?

D'autres commentaires ?

Les commentaires seront envoyés à Microsoft : en appuyant sur le bouton envoyer, vos commentaires seront utilisés pour améliorer les produits et services Microsoft. Politique de confidentialité.

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.

Remarque : si vous disposez d’autorisations en lecture seule et demandez un dossier spécial qui n’existe pas, vous recevrez une erreur 403 Forbidden.

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/{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.

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData $expand et $select pour vous aider à 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.

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

HTTP

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var children = await graphClient.Me.Drive.Special["{driveItem-id}"].Children
    .Request()
    .GetAsync();

Lisez la documentation du SDK pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

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

Lisez la documentation du SDK pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/drive/special/{special-folder-name}/children"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphDriveItem *driveItem = [[MSGraphDriveItem alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

Lisez la documentation du SDK pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

DriveItemCollectionPage children = graphClient.me().drive().special("{special-folder-name}").children()
    .buildRequest()
    .get();

Lisez la documentation du SDK pour plus d’informations sur l’ajout du SDK à votre projet et la création d’une instance authProvider.

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