Get onenoteOperation

Get the status of a long-running OneNote operation. This applies to operations that return the Operation-Location header in the response, such as CopyNotebook, CopyToNotebook, CopyToSectionGroup, and CopyToSection.

You can poll the Operation-Location endpoint until the status property returns completed or failed.

If the status is completed, the resourceLocation property contains the resource endpoint URI.

If the status is failed, the error and @api.diagnostics properties provide error information.

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) Notes.Create, Notes.Read, Notes.ReadWrite, Notes.Read.All, Notes.ReadWrite.All
Delegated (personal Microsoft account) Notes.Create, Notes.Read, Notes.ReadWrite
Application Notes.Read.All, Notes.ReadWrite.All

HTTP request

GET /me/onenote/operations/{id}
GET /users/{id | userPrincipalName}/onenote/operations/{id}
GET /groups/{id}/onenote/operations/{id}
GET /sites/{id}/onenote/operations/{id}

Optional query parameters

None.

Request headers

Name Type Description
Authorization string Bearer {token}. Required.
Accept string application/json

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and onenoteOperation object in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/onenote/operations/{id}
Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 215

{
  "id": "id-value",
  "status": "status-value",
  "createdDateTime": "2016-10-19T10:37:00Z",
  "lastActionDateTime": "2016-10-19T10:37:00Z",
  "resourceLocation": "resourceLocation-value",
  "resourceId": "resourceId-value"
}

SDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var onenoteOperation = await graphClient.Me.Onenote.Operations["{id}"]
	.Request()
	.GetAsync();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.