Partager via


driveItem : préversion

Espace de noms: microsoft.graph

Cette action vous permet d’obtenir une URL incorporable de courte durée pour un élément afin d’afficher un aperçu temporaire.

Si vous souhaitez obtenir des liens incorporés de longue durée, utilisez plutôt l’API createLink .

Note: L’action d’aperçu est actuellement disponible uniquement sur SharePoint et OneDrive Entreprise.

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) Non prise en charge. Non prise en charge.
Application Files.Read.All Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Requête HTTP

POST /drives/{driveId}/items/{itemId}/preview
POST /groups/{groupId}/drive/items/{itemId}/preview
POST /me/drive/items/{itemId}/preview
POST /sites/{siteId}/drive/items/{itemId}/preview
POST /users/{userId}/drive/items/{itemId}/preview
POST /shares/{shareId}/driveItem/preview

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Le corps de la demande définit les propriétés de l’URL incorporable que votre application demande. La demande doit être un objet JSON qui possède les propriétés suivantes :

Nom Type Description
page chaîne/numéro Optional. Numéro de page du document à partir de laquelle commencer, le cas échéant. Spécifié en tant que chaîne pour les futurs cas d’usage autour des types de fichiers tels que ZIP.
zoom number Optional. Niveau de zoom à partir de laquelle commencer, le cas échéant.

Réponse

{
    "getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
    "postParameters": "param1=value&param2=another%20value",
    "postUrl": "https://www.onedrive.com/embed_by_post"
}

La réponse est un objet JSON contenant les propriétés suivantes :

Nom Type Description
Geturl chaîne URL adaptée à l’incorporation à l’aide de HTTP GET (iframes, etc.)
postUrl string URL adaptée à l’incorporation à l’aide de HTTP POST (formulaire post, JS, etc.)
postParameters string Paramètres POST à inclure si vous utilisez postUrl

GetUrl, postUrl ou les deux peuvent être retournés en fonction de l’état actuel de la prise en charge de l’incorporation pour les options spécifiées.

postParameters est une chaîne au application/x-www-form-urlencodedformat , et si vous effectuez un postUrl, le type de contenu doit être défini en conséquence. Par exemple :

POST https://www.onedrive.com/embed_by_post
Content-Type: application/x-www-form-urlencoded

param1=value&param2=another%20value

Page/zoom

Les options « page » et « zoom » ne sont peut-être pas disponibles pour toutes les applications en préversion, mais elles seront appliquées si l’application en préversion les prend en charge.