| author | spgraph-docs-team |
|---|---|
| ms.date | 09/10/2017 |
| title | Convert to other formats |
| ms.localizationpriority | high |
| ms.subservice | sharepoint |
| description | Use this API to retrieve the contents of an item in a specific format. |
| doc_type | apiPageType |
Namespace: microsoft.graph
Use this API to retrieve the contents of an item in a specific format. Not all files can be converted into all formats.
To download the item in its original format, see download an item's contents.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
[!INCLUDE app-permissions]
GET /drive/items/{item-id}/content?format={format}
GET /drive/root:/{path and filename}:/content?format={format}| Parameter | Type | Description |
|---|---|---|
| format | String | Specify the format the item's content should be downloaded as. |
| height | Int32 | The desired height of the converted image in pixels. Required when format=jpg. |
| width | Int32 | The desired width of the converted image in pixels. Required when format=jpg. |
The following values are valid for the format parameter:
| Format value | Description | Supported source extensions |
|---|---|---|
| jpg | Converts the item into JPG format. | 3g2, 3gp, 3gp2, 3gpp, 3mf, ai, arw, asf, avi, bas, bash, bat, bmp, c, cbl, cmd, cool, cpp, cr2, crw, cs, css, csv, cur, dcm, dcm30, dic, dicm, dicom, dng, doc, docx, dwg, eml, epi, eps, epsf, epsi, epub, erf, fbx, fppx, gif, glb, h, hcp, heic, heif, htm, html, ico, icon, java, jfif, jpeg, jpg, js, json, key, log, m2ts, m4a, m4v, markdown, md, mef, mov, movie, mp3, mp4, mp4v, mrw, msg, mts, nef, nrw, numbers, obj, odp, odt, ogg, orf, pages, pano, pdf, pef, php, pict, pl, ply, png, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, ps, ps1, psb, psd, py, raw, rb, rtf, rw1, rw2, sh, sketch, sql, sr2, stl, tif, tiff, ts, txt, vb, webm, wma, wmv, xaml, xbm, xcf, xd, xml, xpm, yaml, yml |
| Converts the item into PDF format. | doc, docx, dot, dotx, dotm, dsn, dwg, eml, epub, fluidframework, form, htm, html, loop, loot, markdown, md, msg, note, odp, ods, odt, page, pps, ppsx, ppt, pptx, pulse, rtf, task, tif, tiff, wbtx, whiteboard, xls, xlsm, xlsx | |
| html | Converts the item into HTML format. | loop, fluid, wbtx, whiteboard |
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| if-none-match | String. If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned. |
The following example shows a request.
GET /me/drive/items/{item-id}/content?format={format}
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response. It returns a 302 Found response redirecting to a preauthenticated download URL for the converted file.
To download the converted file, your app must follow the Location header in the response.
Preauthenticated URLs are only valid for a short period of time (a few minutes) and don't require an Authorization header to access.
HTTP/1.1 302 Found
Location: https://b0mpua-by3301.files.1drv.com/y23vmagahszhxzlcvhasdhasghasodfiFor more information about how errors are returned, see Error responses.