driveItem: preview
Namespace: microsoft.graph
This action allows you to obtain a short-lived embeddable URL for an item in order to render a temporary preview.
If you want to obtain long-lived embeddable links, use the createLink API instead.
Note: The preview action is currently only available on SharePoint and OneDrive for Business.
This API is supported in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
HTTP request
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
Request body
The body of the request defines properties of the embeddable URL your application is requesting. The request should be a JSON object with the following properties.
Name | Type | Description |
---|---|---|
page | string/number | Optional. Page number of document to start at, if applicable. Specified as string for future use cases around file types such as ZIP. |
zoom | number | Optional. Zoom level to start at, if applicable. |
Response
{
"getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
"postParameters": "param1=value¶m2=another%20value",
"postUrl": "https://www.onedrive.com/embed_by_post"
}
The response will be a JSON object containing the following properties:
Name | Type | Description |
---|---|---|
getUrl | string | URL suitable for embedding using HTTP GET (iframes, etc.) |
postUrl | string | URL suitable for embedding using HTTP POST (form post, JS, etc.) |
postParameters | string | POST parameters to include if using postUrl |
Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options.
postParameters is a string formatted as application/x-www-form-urlencoded
, and if performing a POST to the postUrl the content-type should be set accordingly. For example:
POST https://www.onedrive.com/embed_by_post
Content-Type: application/x-www-form-urlencoded
param1=value¶m2=another%20value
Page/zoom
The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it.
Feedback
Submit and view feedback for