Get onenoteOperation
Namespace: microsoft.graph
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.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
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.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Notes.Create | Notes.Read, Notes.Read.All, Notes.ReadWrite, 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. Learn more about authentication and authorization. |
Accept | string | application/json |
Request body
Don't 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
The following example shows a request.
GET https://graph.microsoft.com/v1.0/me/onenote/operations/{id}
Response
The following example shows the response. Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "id-value",
"status": "status-value",
"createdDateTime": "2016-10-19T10:37:00Z",
"lastActionDateTime": "2016-10-19T10:37:00Z",
"resourceLocation": "resourceLocation-value",
"resourceId": "resourceId-value"
}
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för