Obtenir un dossier spécial par nomGet a special folder by name

• 09/10/2017
• 3 minutes de lecture
• • 
  • 

Espace de noms: microsoft.graphNamespace: microsoft.graph

Utilisez la collection spéciale pour accéder à un dossier spécial par nom.Use the special collection to access a special folder by name.

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.Special folders provide simple aliases to access well-known folders in OneDrive without the need to look up the folder by path (which would require localization), or reference the folder with an ID. If a special folder is renamed or moved to another location within the drive, this syntax will continue to find that folder.

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.Special folders are automatically created the first time an application attempts to write to one, if it doesn't already exist. If a user deletes one, it is recreated when written to again.

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.Note: If you have read-only permissions and request a special folder that doesn't exist, you'll receive a 403 Forbidden error.

AutorisationsPermissions

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.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Requête HTTPHTTP Request

GET /me/drive/special/{name}

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var driveItem = await graphClient.Me.Drive.Special["{name}"]
    .Request()
    .GetAsync();

const options = {
    authProvider,
};

const client = Client.init(options);

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

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

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

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

        MSGraphDriveItem *driveItem = [[MSGraphDriveItem alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

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

DriveItem driveItem = graphClient.me().drive().special("{name}")
    .buildRequest()
    .get();

Noms de dossier spécialSpecial folder names

Les noms de dossier spécial suivants sont disponibles dans OneDrive et OneDrive Entreprise.The follow special folder names are available in OneDrive and OneDrive for Business.

Paramètres facultatifs de la requêteOptional query parameters

Cette méthode prend en charge les paramètres de requête OData $expand et $select pour vous aider à personnaliser la réponse.This method supports the $expand and $select OData query parameters to customize the response.

RéponseResponse

Cette méthode renvoie un code de réponse 200 OK et une ressource driveItem dans le corps de la réponse.This method returns a 200 OK response code and a driveItem object in the response body.

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.You can use this method of addressing a special folder inline with additional calls to properties or relationships on the 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écialGet children of a special folder

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.To request the children of a special folder, you can request the children collection or use the expand option to expand the children collection.

Requête HTTPHTTP request

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

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

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

const options = {
    authProvider,
};

const client = Client.init(options);

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

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];

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

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

RéponseResponse

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 }
  ]
}

RemarquesRemarks

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.Note: DriveItems with the specialFolder facet indicate the item is a special folder and can be accessed via the special collection.

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à.If your app has read-only permissions, the request to get a special folder or the children of a special folder may fail with a 404 Not Found or a 403 Forbidden error if the special folder does not already exist.