{"id":780,"date":"2016-09-13T00:00:00","date_gmt":"2016-09-13T00:00:00","guid":{"rendered":"http:\/\/officedevblogs.wpengine.com\/?p=780"},"modified":"2016-09-13T00:00:00","modified_gmt":"2016-09-13T00:00:00","slug":"onedrive-webhooks-and-large-uploads-with-microsoft-graph","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/onedrive-webhooks-and-large-uploads-with-microsoft-graph\/","title":{"rendered":"OneDrive Webhooks and Large Uploads with Microsoft Graph"},"content":{"rendered":"
\n

This week we’re happy to announce two new Microsoft Graph features for OneDrive files: webhook notifications and large file uploads. This functionality is available on the Microsoft Graph beta endpoint, https:\/\/graph.microsoft.com\/beta.<\/p>\n

Webhook Notifications<\/h2>\n

By creating a subscription on a drive’s root item, your app will receive a webhook notification whenever files within that drive are created, deleted, or modified. To create a subscription, your app needs to specify the Files.ReadWrite<\/strong> permission scope and request a subscription type of ‘updated’. We’ve included an example create request, response, and notification below. Make sure to visit our documentation for more details on using webhooks<\/a> with the Microsoft Graph.<\/p>\n

Subscription Create Request<\/h2>\n

To create a new Webhook notification subscription, your application sends a POST request to the subscriptions collection:<\/p>\n

POST https:\/\/graph.microsoft.com\/beta\/subscriptions<\/p>\n

Content-Type: application\/json<\/p>\n

{<\/p>\n

“changeType”: “updated”,<\/p>\n

“notificationUrl”: “https:\/\/webhookapp12345.azurewebsites.net\/api\/notifications<\/a>“,<\/p>\n

“clientState”: “My client state”,<\/p>\n

“resource”: “me\/drive\/root”,<\/p>\n

“expirationDateTime”: “2016-08-26T23:08:37Z”<\/p>\n

}<\/p>\n

Note: In the subscription create request it is important to use the “updated” change type as it is the only supported type for the drive resource.<\/p>\n

Subscription Create Response<\/h2>\n

HTTP\/1.1 200 OK<\/p>\n

Content-Type: application\/json<\/p>\n

{<\/p>\n

“id”: “aa269f87-2a92-4cff-a43e-2771878c3727”,<\/p>\n

“resource”: “me\/drive\/root”,<\/p>\n

“changeType”: “updated”,<\/p>\n

“clientState”: “My client state”,<\/p>\n

“notificationUrl”: “https:\/\/webhookapp12345.azurewebsites.net\/api\/notifications<\/a>“,<\/p>\n

“expirationDateTime”: “2016-08-26T23:08:37Z”<\/p>\n

} <\/p>\n

Your app should track the resulting subscription ID and the user who subscribed, so that when a notification is received you can connect the notification to the user\/drive to request the changes to the drive.<\/p>\n

Notification<\/h2>\n

When a notification is triggered, the Graph API will POST a request to your registered notification URL, similar to the following:<\/p>\n

POST https:\/\/webhookapp12345.azurewebsites.net\/api\/notification<\/p>\n

Content-Type: application\/json<\/p>\n

{<\/p>\n

  “subscriptionId”: “aa269f87-2a92-4cff-a43e-2771878c3727”,<\/p>\n

  “clientState”: “My client state”,<\/p>\n

  “changeType”: “updated”,<\/p>\n

  “resource”: “me\/drive\/root”,<\/p>\n

  “subscriptionExpirationDateTime”: “2016-08-26T23:08:37.00+00:00”,<\/p>\n

  “resourceData”: null<\/p>\n

}<\/p>\n

As you can see in the notification example, the resource data returned is null – you will need to use the delta<\/a> functionality (\/me\/drive\/root\/delta) on the target drive’s root object to track state and find what changed. This ensures that a dropped notification does not result in any loss of state.<\/p>\n

 <\/p>\n

Large File Uploads<\/h2>\n

This week we’re also adding the createUploadSession method to driveItem. This allows your application to request an upload session which allows uploading files larger than 4 MB through Graph API. To upload larger files, your application POSTs a request to createUploadSession to create a new upload session for a file.<\/p>\n

POST https:\/\/graph.microsoft.com\/beta\/me\/drive\/root:\/file.mp4:\/createUploadSession<\/p>\n

This returns a URL which your application can use to upload the contents of the file.<\/p>\n

{<\/p>\n

“uploadUrl”: “https:\/\/contoso.sharepoint.com\/_api\/v2.0\/uploadsessions123191”,<\/p>\n

“expirationDateTime”: “20160916T21:00:12Z”<\/p>\n

}<\/p>\n

 <\/p>\n

Next your app logically breaks the file into fragments, each of which must be a multiple of 320KiB. For example, you could choose a fragment size of 4,259,840 bytes (approximately 4 MB) for good performance. Then, your application sequentially makes a PUT request to the uploadUrl<\/strong> and writes the uploads the contents of the next fragment. Your app must use the Content-Range header to specify which part of the file you are uploading, and must upload the file’s contents sequentially.<\/p>\n

If the upload of one part of the file is unable to complete (say the connection is dropped), your app can resume the upload by remembering the uploadUrl<\/strong>. Your app can query for the current status of the upload URL by performing a GET request on the uploadUrl<\/strong>, which will return the expirationDateTime<\/strong> and nextExpectedRanges<\/strong> values, which indicate which parts of the file should be uploaded next.<\/p>\n

When the last part of the file is uploaded, the session is committed and the file appears inside the user’s drive.<\/p>\n

We’re excited to be rolling out this functionality to make it easier to use Microsoft Graph API for all scenarios where your app interacts with OneDrive content. Happy coding!<\/p>\n

 <\/p>\n

Ryan Gregg, Principal Program Manager, OneDrive\/SharePoint and Matt Geimer, Program Manager II, Microsoft Graph<\/p>\n<\/p><\/div>\n","protected":false},"excerpt":{"rendered":"

This week we’re happy to announce two new Microsoft Graph features for OneDrive files: webhook notifications and large file uploads. This functionality is available on the Microsoft Graph beta<\/p>\n","protected":false},"author":69077,"featured_media":25159,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[3],"tags":[35],"class_list":["post-780","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-graph","tag-onedrive"],"acf":[],"blog_post_summary":"

This week we’re happy to announce two new Microsoft Graph features for OneDrive files: webhook notifications and large file uploads. This functionality is available on the Microsoft Graph beta<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/780","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/users\/69077"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/comments?post=780"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/780\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/25159"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=780"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=780"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=780"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}