Skip to content

page-get.md

Latest commit

 

History

History
114 lines (92 loc) · 3.55 KB

page-get.md

File metadata and controls

114 lines (92 loc) · 3.55 KB
title Get page
description Retrieve the properties and relationships of a page object.
ms.localizationpriority medium
author jewan-microsoft
ms.subservice onenote
doc_type apiPageType
ms.date 06/22/2024

Get page

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve the properties and relationships of a page object.

Getting page information

Access a page's metadata by page identifier:

GET /me/onenote/pages/{id}

Getting page content

You can use the page's content endpoint to get the HTML content of a page:

GET /me/onenote/pages/{id}/content[?includeIDs=true]
GET /me/onenote/pages/{id}/$value[?includeIDs=true]

The includeIDs=true query option is used to update pages.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

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

Optional query parameters

This method supports the select and expand OData Query Parameters to help customize the response.

The default response expands parentSection and selects the section's id, name, and self properties. Valid expand values for pages are parentNotebook and parentSection.

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 the onenotePage object in the response body.

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/me/onenote/pages/{id}
Response

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

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

{
  "title": "title-value",
  "createdByAppId": "createdByAppId-value",
  "id": "8fcb5dbc-d5aa-4681-8e31-b001d5168d79",
  "links": {
    "oneNoteClientUrl": {
      "href": "href-value"
    },
    "oneNoteWebUrl": {
      "href": "href-value"
    }
  },
  "contentUrl": "contentUrl-value",
  "content": "content-value",
  "lastModifiedDateTime": "2016-10-19T10:37:00Z"
}