Получение содержимого и структуры OneNote с помощью Microsoft GraphGet OneNote content and structure with Microsoft Graph

Область применения: пользовательские записные книжки в OneDrive и корпоративные записные книжки в Office 365.Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Чтобы получить содержимое и структуру OneNote, необходимо отправить запрос GET к целевой конечной точке.To get OneNote content and structure, you send a GET request to the target endpoint. Пример:For example:

GET ../onenote/pages/{id}

Если запрос выполнен успешно, Microsoft Graph возвращает код состояния HTTP 200 и запрашиваемые объекты или содержимое.If the request is successful, Microsoft Graph returns a 200 HTTP status code and the entities or content that you requested. Объекты OneNote возвращаются в виде объектов JSON, соответствующих спецификации OData версии 4.0.OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

С помощью параметров строки запроса вы можете фильтровать запросы и повышать производительность.By using query string options, you can filter your queries and improve performance.

Создание URI запросаConstruct the request URI

Чтобы создать URI запроса, начните с корневого URL-адреса службы:To construct the request URI, start with the service root URL:

https://graph.microsoft.com/v1.0/me/onenote


Затем добавьте конечную точку нужного ресурса.Then append the endpoint of the resource you want to retrieve. (Пути к ресурсам показаны в следующем разделе.)(Resource paths are shown in the next section.)

Полный URI запроса будет выглядеть так, как в одном из следующих примеров:Your full request URI will look like one of these examples:

  • https://graph.microsoft.com/v1.0/me/onenote/notebooks/{id}/sections
  • https://graph.microsoft.com/v1.0/me/onenote/notes/pages
  • https://graph.microsoft.com/v1.0/me/onenote/pages?select=title,self

Примечание. Узнайте больше о корневом URL-адресе службы.Note: Learn more about the service root URL.

Пути к ресурсам для запросов GETResource paths for GET requests

Используйте приведенные ниже пути к ресурсам, чтобы получать страницы, разделы, группы разделов, записные книжки, а также изображения или файлы.Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

Коллекция PagePage collection

Получение страниц (метаданных) из всех записных книжек.Get pages (metadata) across all notebooks.

../pages[?filter,orderby,select,expand,top,skip,search,count]


Получение страниц (метаданных) из определенного раздела.Get pages (metadata) from a specific section.

../sections/{section-id}/pages[?filter,orderby,select,expand,top,skip,search,count,pagelevel]


Параметр строки запроса `search` доступен только для пользовательских записных книжек.The `search` query string option is available for consumer notebooks only.

По умолчанию для страниц используется порядок сортировки lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

Запрос по умолчанию разворачивает родительский раздел и выбирает свойства id, name и self этого раздела.The default query expands the parent section and selects the section's id, name, and self properties.

По умолчанию в ответ на запросы GET для страниц возвращаются только первые 20 записей.By default, only the top 20 entries are returned for GET pages requests. В ответах на запросы, в которых не указан параметр top, возвращается ссылка @odata.nextLink, с помощью которой можно получить следующие 20 записей.Requests that don't specify a top query string option return an @odata.nextLink link in the response that you can use to get the next 20 entries.

Для коллекции страниц в разделе используйте параметр pagelevel, чтобы возвращать уровень отступа страниц и их порядок в разделе.For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

ПримерExample

GET ../sections/{section-id}/pages?pagelevel=true

Объект PagePage entity

Получение метаданных определенной страницы.Get the metadata for a specific page.

../pages/{page-id}[?select,expand,pagelevel]


Запросы страниц могут разворачивать свойства parentNotebook и parentSection.Pages can expand the parentNotebook and parentSection properties.

Запрос по умолчанию разворачивает родительский раздел и выбирает свойства id, name и self этого раздела.The default query expands the parent section and selects the section's id, name, and self properties.

С помощью параметра pagelevel можно вернуть уровень отступа страницы и ее порядковый номер в родительском разделе.Use pagelevel to return the indentation level of the page and its order within its parent section.

ПримерExample

GET ../pages/{page-id}?pagelevel=true

Предварительный просмотр страницыPage preview

Получение текста и изображений на странице для предварительного просмотра.Get text and image preview content for a page.

../pages/{page-id}/preview


Отклик JSON содержит часть контента для предварительного просмотра, благодаря которому пользователи могут узнать, что находится на странице.The JSON response contains the preview content, which you can use to help users identify what's in the page.

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.PagePreview",
  "previewText":"text-snippet",
  "links":{
    "previewImageUrl":{
      "href":"https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png"
    }
  }
}

Свойство previewText содержит фрагмент текста со страницы.The previewText property contains a text snippet from the page. Microsoft Graph возвращает полные фразы длиной до 300 символов.Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

Если на странице есть изображение, подходящее для предварительного просмотра, то свойство href объекта previewImageUrl будет содержать ссылку на общедоступный ресурс изображения.If the page has an image that can be used to build a preview UI, the href property in the previewImageUrl object contains a link to a public, pre-authenticated image resource. Эту ссылку можно использовать в коде HTML.You can use this link in HTML. Если не сделать этого, свойство href возвратит значение NULL.Otherwise, href returns null.

ПримерExample

<img src="https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png" />

HTML-контент страницыPage HTML content

Получение HTML-контента страницы.Get the HTML content of a page.

../pages/{page-id}/content[?includeIDs]

(Дополнительные сведения о возвращаемом HTML-контенте.)(learn more about returned HTML content)


Указав в строке запроса параметр includeIDs=true, можно получить созданные идентификаторы, используемые для обновления страницы.Use the includeIDs=true query string option to get generated IDs used to update the page.

Коллекция SectionSection collection

Получение всех разделов всех записных книжек, принадлежащих пользователю, включая разделы из вложенных групп разделов.Get all sections from all notebooks that are owned by the user, including sections in nested section groups.

../sections[?filter,orderby,select,top,skip,expand,count]


Получение всех разделов, вложенных непосредственно в определенную группу разделов.Get all sections that are directly under a specific section group.

../sectionGroups/{sectiongroup-id}/sections[?filter,orderby,select,top,skip,expand,count]


Получение всех разделов, вложенных непосредственно в определенную записную книжку.Get all sections that are directly under a specific notebook.

../notebooks/{notebook-id}/sections[?filter,orderby,select,top,skip,expand,count]


Запросы разделов могут разворачивать свойства parentNotebook и parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

По умолчанию для разделов используется порядок сортировки name asc.The default sort order for sections is name asc.

Запрос по умолчанию разворачивает родительскую записную книжку и родительскую группу разделов и выбирает их свойства id, name и self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Объект SectionSection entity

Получение определенного раздела.Get a specific section.

../sections/{section-id}[?select,expand]


Запросы разделов могут разворачивать свойства parentNotebook и parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

Запрос по умолчанию разворачивает родительскую записную книжку и родительскую группу разделов и выбирает их свойства id, name и self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Коллекция SectionGroupSectionGroup collection

Получение всех групп разделов из всех записных книжек, принадлежащих пользователю, включая вложенные.Get all section groups from all notebooks that are owned by the user, including nested section groups.

../sectionGroups[?filter,orderby,select,top,skip,expand,count]


Получение всех групп разделов, вложенных непосредственно в определенную записную книжку.Get all section groups that are directly under a specific notebook.

../notebooks/{notebook-id}/sectionGroups[?filter,orderby,select,top,skip,expand,count]


Запросы групп разделов могут разворачивать свойства sections, sectionGroups, parentNotebook и parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

По умолчанию для групп разделов используется порядок сортировки name asc.The default sort order for section groups is name asc.

Запрос по умолчанию разворачивает родительскую записную книжку и родительскую группу разделов и выбирает их свойства id, name и self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Объект SectionGroupSectionGroup entity

Получение определенной группы разделов.Get a specific section group.

../sectionGroups/{sectiongroup-id}[?select,expand]


Запросы групп разделов могут разворачивать свойства sections, sectionGroups, parentNotebook и parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

Запрос по умолчанию разворачивает родительскую записную книжку и родительскую группу разделов и выбирает их свойства id, name и self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Коллекция NotebookNotebook collection

Получение всех записных книжек, принадлежащих пользователю.Get all the notebooks that are owned by the user.

../notebooks[?filter,orderby,select,top,skip,expand,count]


Запросы записных книжек могут разворачивать свойства sections и sectionGroups.Notebooks can expand the sections and sectionGroups properties.

По умолчанию для записных книжек используется порядок сортировки name asc.The default sort order for notebooks is name asc.

Объект NotebookNotebook entity

Получение определенной записной книжки.Get a specific notebook.

../notebooks/{notebook-id}[?select,expand]


Запросы записных книжек могут разворачивать свойства sections и sectionGroups.Notebooks can expand the sections and sectionGroups properties.

Ресурс изображений или других файловImage or other file resource

Получение двоичных данных определенного ресурса.Get the binary data of a specific resource.

../resources/{resource-id}/$value


URI ресурса файла можно найти в выходном HTML-коде страницы.You can find the file's resource URI in the page's output HTML.

Например, тег img содержит конечные точки для исходного изображения в атрибуте data-fullres-src и оптимизированное изображение в атрибуте src.For example, an img tag includes endpoints for the original image in the data-fullres-src attribute and the optimized image in the src attribute.

ПримерExample

<img 
    src="https://www.onenote.com/api/v1.0/me/notes/resources/{image-id}/$value"  
    data-src-type="image/png"
    data-fullres-src="https://www.onenote.com/api/v1.0/resources/{image-id}/$value"  
    data-fullres-src-type="image/png" ... />

Тег object содержит конечную точку файлового ресурса в атрибуте data.And an object tag includes the endpoint for the file resource in the data attribute.

ПримерExample

<object
    data="https://www.onenote.com/api/v1.0/me/notes/resources/{file-id}/$value"
    data-attachment="fileName.pdf" 
    type="application/pdf" ... />

Примечание. Получение коллекции ресурсов не поддерживается.Note: Getting a collection of resources is not supported.

При получении файлового ресурса не требуется включать в запрос тип контента Accept.When you get a file resource, you don't need to include an Accept content type in the request.

Дополнительные сведения о запросах GET см. в следующих статьях документации по API REST Microsoft Graph:For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

Примеры запросов GETExample GET requests

Вы можете запрашивать объекты OneNote и содержимое страницы поиска, чтобы получать только нужные вам сведения.You can query for OneNote entities and search page content to get just the information you need. Ниже показаны некоторые способы использования поддерживаемых параметров строки в запросах GET к Microsoft Graph.The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

Помните:Remember:

  • Все запросы GET начинаются с корневого URL-адреса службы.All GET requests start with the service root URL.

    Примеры: https://www.onenote.com/api/v1.0/me/notes и https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/.Examples: https://www.onenote.com/api/v1.0/me/notes and https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

  • Пробелы в строке запроса URL следует кодировать как %20.Spaces in the URL query string must use %20 encoding.

    Пример: filter=title%20eq%20'biology'.Example: filter=title%20eq%20'biology'

  • В случае имен свойств и сравнения строк OData учитывается регистр.Property names and OData string comparisons are case-sensitive. Рекомендуем использовать функцию OData tolower для сравнения строк.We recommend using the OData tolower function for string comparisons.

    Пример: filter=tolower(name) eq 'spring'.Example: filter=tolower(name) eq 'spring'

search и filtersearch & filter

Получение всех страниц с термином recipe, созданных определенным приложением (search доступен только для пользовательских записных книжек).Get all pages that contain the term recipe that were created by a specific app (search is available for consumer notebooks only).

[GET] ../pages?search=recipe&filter=createdByAppId eq 'WLID-000000004C12821A'

search и selectsearch & select

Получение заголовка, клиентских ссылок OneNote и ссылки contentUrl для всех страниц, содержащих термин golgi app (search доступен только для пользовательских записных книжек).Get the title, OneNote client links, and contentUrl link for all pages that contain the term golgi app (search is available for consumer notebooks only).

[GET] ../pages?search=golgi app&select=title,links,contentUrl

expandexpand

Получение всех записных книжек, а также разворачивание их разделов и групп разделов.Get all notebooks and expand their sections and section groups.

[GET] ../notebooks?expand=sections,sectionGroups

Получение определенной группы разделов и разворачивание ее разделов и групп разделов.Get a specific section group and expand its sections and section groups.

[GET] ../sectionGroups/{sectiongroup-id}?expand=sections,sectionGroups

Получение страницы и разворачивание ее родительского раздела и родительской записной книжки.Get a page and expand its parent section and parent notebook.

[GET] ../pages/{page-id}?expand=parentSection,parentNotebook

expand (несколько уровней)expand (multiple levels)

Получение всех записных книжек и разворачивание их разделов и групп разделов, а также разворачивание всех разделов в каждой группе разделов.Get all notebooks and expand their sections and section groups, and expand all sections in each section group.

[GET] ../notebooks?expand=sections,sectionGroups(expand=sections)

Примечание. Разворачивание родительских элементов объектов или разворачивание дочерних элементов объектов создает циклическую ссылку и не поддерживается.Note: Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand и select (несколько уровней)expand & select (multiple levels)

Получение имени и ссылки self для определенной группы разделов, а также получение имени и ссылок self для всех ее разделов.Get the name and self link for a specific section group, and get the name and self links for all its sections.

[GET] ../sectionGroups/{sectiongroup-id}?expand=sections(select=name,self)&select=name,self

Получение имени и ссылки self для всех разделов, а также получение имени и времени создания родительской записной книжки каждого раздела.Get the name and self link for all sections, and get the name and created time of each section's parent notebook.

[GET] ../sections?expand=parentNotebook(select=name,createdTime)&select=name,self

Получение названий и идентификаторов всех страниц, а также получение названия родительского раздела и родительской записной книжки.Get the title and ID for all pages, and get the name of the parent section and parent notebook.
[GET] ../pages?select=id,title&expand=parentSection(select=name),parentNotebook(select=name)

expand и levels (несколько уровней)expand & levels (multiple levels)

Получение всех записных книжек, разделов и групп разделов.Get all notebooks, sections, and section groups.

[GET] ../notebooks?expand=sections,sectionGroups(expand=sections,sectionGroups(levels=max;expand=sections))

filterfilter

Получение всех разделов, созданных в октябре 2014 г.Get all sections that were created in October 2014.

[GET] ../sections?filter=createdTime ge 2014-10-01 and createdTime le 2014-10-31

Получение страниц, созданных определенным приложением с 1 января 2015 г.Get the pages that were created by a specific app since January 1, 2015.

[GET] ../pages?filter=createdByAppId eq 'WLID-0000000048118631' and createdTime ge 2015-01-01

filter и expandfilter & expand

Получение всех страниц определенной записной книжки.Get all pages in a specific notebook. По умолчанию API возвращает 20 записей.The API returns 20 entries by default.

[GET] ../pages?filter=parentNotebook/id eq '{notebook-id}'&expand=parentNotebook

Получение имени и ссылки pagesUrl для всех разделов в записной книжке School.Get the name and pagesUrl link for all sections from the School notebook. При сравнении строк OData учитывается регистр, поэтому рекомендуем использовать функцию tolower.OData string comparisons are case-sensitive, so use the tolower function as a best practice.

[GET] ../notebooks?filter=tolower(name) eq 'school'&expand=sections(select=name,pagesUrl)

filter, select и orderbyfilter & select & orderby

Получение имени и ссылки pagesUrl для всех разделов, имена которых содержат термин spring.Get the name and pagesUrl link for all sections that contain the term spring in the section name. Упорядочивание разделов по дате последнего изменения.Order sections by last modified date.

[GET] ../sections?filter=contains(tolower(name),'spring')&select=name,pagesUrl&orderby=lastModifiedTime desc

orderbyorderby

Получение первых 20 страниц, отсортированных по свойству createdByAppId и времени создания (по убыванию).Get the first 20 pages ordered by createdByAppId property and then by most recent created time. По умолчанию API возвращает 20 записей.The API returns 20 entries by default.

[GET] ../pages?orderby=createdByAppId,createdTime desc

search, filter и topsearch & filter & top

Получение пяти последних страниц, созданных с 1 января 2015 г. и содержащих фразу cell division.Get the five newest pages created since January 1, 2015 that contain the phrase cell division. По умолчанию API возвращает 20 записей. Максимальное количество записей — 100.The API returns 20 entries by default with a maximum of 100. Порядок сортировки по умолчанию для страниц: lastModifiedTime desc (search доступен только для пользовательских записных книжек).The default sort order for pages is lastModifiedTime desc (search is available for consumer notebooks only).

[GET] ../pages?search="cell division"&filter=createdTime ge 2015-01-01&top=5

search, filter, top и skipsearch & filter & top & skip

Получение пяти следующих страниц в результирующем наборе (search доступен только для пользовательских записных книжек).Get the next five pages in the result set (search is available for consumer notebooks only).

[GET] ../pages?search=biology&filter=createdTime ge 2015-01-01&top=5&skip=5

Получение еще пяти (search доступен только для пользовательских записных книжек).And the next five (search is available for consumer notebooks only).

[GET] ../pages?search=biology&filter=createdTime ge 2015-01-01&top=5&skip=10

Примечание. Если параметры search и filter применяются к одному запросу, результаты включают только те объекты, которые соответствуют обоим условиям.Note: If both search and filter are applied to the same request, the results include only those entities that match both criteria.

selectselect

Получение имени, времени создания и ссылки self для всех разделов в записных книжках пользователя.Get the name, created time, and self link for all sections in the user's notebooks.

[GET] ../sections?select=name,createdTime,self

Получение названия, времени создания и клиентских ссылок OneNote для определенной страницы.Get the title, created time, and OneNote client links for a specific page.

[GET] ../pages/{page-id}?select=title,createdTime,links

select, expand и filter (несколько уровней)select & expand & filter (multiple levels)

Получение имени и ссылки pagesUrl для всех разделов в записной книжке по умолчанию пользователя.Get the name and pagesUrl link for all sections in the user's default notebook.

[GET] ../notebooks?select=name&expand=sections(select=name,pagesUrl)&filter=isDefault eq true

top, select и orderbytop & select & orderby

Получение названия и ссылки self для первых 50 страниц, упорядоченных по названию в алфавитном порядке.Get the title and self link for the first 50 pages, ordered alphabetically by title. По умолчанию API возвращает 20 записей. Максимальное количество записей — 100.The API returns 20 entries by default with a maximum of 100. По умолчанию для страниц используется порядок сортировки lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

[GET] ../pages?top=50&select=title,self&orderby=title

skip, top, select и orderbyskip & top & select & orderby

Получение страниц с 51 по 100. По умолчанию API возвращает 20 записей, а максимальное количество составляет 100.Get pages 51 to 100. The API returns 20 entries by default with a maximum of 100.

[GET] ../pages?skip=50&top=50&select=title,self&orderby=title

Примечание. Запросы GET для страниц, которые восстанавливают количество записей по умолчанию (то есть в них не указывается выражение top), возвращают в ответе ссылку @odata.nextLink, с помощью которой можно получить следующие 20 записей.Note: GET requests for pages that retrieve the default number of entries (that is, they don't specify a top expression) return an @odata.nextLink link in the response that you can use to get the next 20 entries.

Поддерживаемые параметры строки запроса ODataSupported OData query string options

Вы можете настраивать запросы GET к Microsoft Graph, используя параметры строки запроса OData, и получать только нужную информацию.When sending GET requests to Microsoft Graph, you can use OData query string options to customize your query and get just the information you need. Они также могут повышать производительность, уменьшая количество вызовов службы и размер полезных данных ответа.They can also improve performance by reducing the number of calls to the service and the size of the response payload.

Примечание. Для удобства чтения в примерах из этой статьи не используется код %20, которым нужно заменять пробелы в строке запроса URL: filter=isDefault%20eq%20trueNote: For readability, the examples in this article don't use the %20 percent-encoding required for spaces in the URL query string: filter=isDefault%20eq%20true

Параметр запросаQuery option Пример и описаниеExample and description
countcount

count=true

Количество записей в коллекции. Значение возвращается в свойстве **@odata.count** отклика.The count of entities in the collection. The value is returned in the **@odata.count** property in the response.

expandexpand

expand=sections,sectionGroups

Свойства навигации, которые следует вернуть в тексте ответа.The navigation properties to return inline in the response. Для выражений expand поддерживаются следующие свойства:The following properties are supported for expand expressions:
страницы: parentNotebook, parentSection;- Pages: parentNotebook, parentSection
разделы: parentNotebook, parentSectionGroup;- Sections: parentNotebook, parentSectionGroup
группы разделов: sections, sectionGroups, parentNotebook, parentSectionGroup;- Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
записные книжки: sections, sectionGroups.- Notebooks: sections, sectionGroups

По умолчанию запросы GET для страниц разворачивают parentSection и выделяют свойства раздела id, name и self. По умолчанию запросы GET для разделов и групп разделов разворачивают как parentNotebook, так и parentSectionGroup, а также выделяют родительские свойства id, name и self.By default, GET requests for pages expands parentSection and select the section's id, name, and self properties. Default GET requests for sections and section groups expand both parentNotebook and parentSectionGroup, and select the parents' id, name, and self properties.

Может использоваться для одного объекта или коллекции.Can be used for a single entity or a collection.
Свойства следует разделять запятыми.Separate multiple properties with commas.
В именах свойств учитывается регистр.Property names are case-sensitive.

filterfilter

filter=isDefault eq true

Логическое выражение, указывающее, следует ли включать запись в набор результатов.A Boolean expression for whether to include an entry in the result set. Поддерживаются следующие функции и операторы OData:Supports the following OData operators and functions:
— операторы сравнения: eq, ne, gt, ge, lt, le;- Comparison operators: eq, ne, gt, ge, lt, le
— логические операторы: and, or, not;- Logical operators: and, or, not
— строковые функции: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat.- String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

В случае имен свойств и сравнения строк OData учитывается регистр.Property names and OData string comparisons are case-sensitive. Рекомендуем использовать функцию OData tolower для сравнения строк.We recommend using the OData tolower function for string comparisons.

Пример: filter=tolower(name) eq 'spring'.Example: filter=tolower(name) eq 'spring'

orderbyorderby

orderby=title,createdTime desc

Свойства для сортировки с необязательным порядком сортировки **asc** (по умолчанию) или **desc**. Вы можете сортировать по любому свойству сущности в запрошенной коллекции.The properties to sort by, with an optional asc (default) or desc sort order. You can sort by any property of the entity in the requested collection.

По умолчанию для записных книжек, разделов и групп разделов используется порядок сортировки name asc, а для страниц — lastModifiedTime desc (сначала отображается последняя измененная страница).The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

Разделяйте свойства запятыми и указывайте их в порядке применения.Separate multiple properties with commas, and list them in the order that you want them applied. В именах свойств учитывается регистр.Property names are case-sensitive.

searchsearch

search=cell div

Доступен только для пользовательских записных книжек.Available for consumer notebooks only.

Термин или фраза, которую нужно найти в заголовке и тексте страницы, замещающем тексте изображений и распознанном тексте. По умолчанию поисковые запросы возвращают результаты, отсортированные по релевантности.The term or phrase to search for in the page title, page body, image alt text, and image OCR text. By default, search queries return results sorted by relevance.

OneNote использует полнотекстовый поиск Bing для поддержки поиска фраз, выделения корней, игнорирования орфографических ошибок, релевантности и ранжирования, разбиения слов, разных языков и других функций полнотекстового поиска.OneNote uses Bing full-text search to support phrase search, stemming, spelling forgiveness, relevance and ranking, word breaking, multiple languages, and other full-text search features. В строках search учитывается регистр.Search strings are case-insensitive.

Применяется только к страницам записных книжек, принадлежащих пользователю.Applies only to pages in notebooks owned by the user. Индексированное содержимое является личным и доступно только владельцу.Indexed content is private and can only be accessed by the owner. Страницы, защищенные паролем, не индексируются.Password-protected pages are not indexed. Применяется только к конечной точке pages.Applies only to the pages endpoint.

selectselect

select=id,title

Возвращаемые свойства.The properties to return. Может использоваться для одного объекта или коллекции.Can be used for a single entity or for a collection. Свойства следует разделять запятыми.Separate multiple properties with commas. В именах свойств учитывается регистр.Property names are case-sensitive.

skipskip

skip=10

Количество записей, которое следует пропустить в наборе результатов.The number of entries to skip in the result set. Обычно используется для разбиения результатов на страницы.Typically used for paging results.

toptop

top=50

Количество записей, которое следует вернуть в наборе результатов, до 100.The number of entries to return in the result set, up to a maximum of 100. Значение по умолчанию — 20.The default value is 20.

В Microsoft Graph также доступен параметр строки запроса pagelevel, с помощью которого можно получить уровень и порядок страниц в родительском разделе.Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. Применяется только к запросам страниц в определенном разделе и запросам определенной страницы.Applies only to queries for pages in a specific section or queries for a specific page.

ПримерыExamples

  • GET ../sections/{section-id}/pages?pagelevel=true
  • GET ../pages/{page-id}?pagelevel=true

Поддерживаемые операторы и функции ODataSupported OData operators and functions

Microsoft Graph поддерживает указанные ниже функции и операторы OData в выражениях filter.Microsoft Graph supports the following OData operators and functions in filter expressions. Используя выражения OData, помните:When using OData expressions, remember:

  • Пробелы в строке запроса URL необходимо заменять кодом %20.Spaces in the URL query string must be replaced with the %20 encoding.

    Пример: filter=isDefault%20eq%20true.Example: filter=isDefault%20eq%20true

  • В случае имен свойств и сравнения строк OData учитывается регистр.Property names and OData string comparisons are case-sensitive. Рекомендуем использовать функцию OData tolower для сравнения строк.We recommend using the OData tolower function for string comparisons.

    Пример: filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

Оператор сравненияComparison operator ПримерExample
eqeq
(равно)(equal to)
createdByAppId eq '{app-id}'
nene
(не равно)(not equal to)
userRole ne 'Owner'
gtgt
(больше)(greater than)
createdTime gt 2014-02-23
gege
(больше или равно)(greater than or equal to)
lastModifiedTime ge 2014-05-05T07:00:00Z
ltlt
(меньше)(less than)
createdTime lt 2014-02-23
lele
(меньше или равно)(less than or equal to)
lastModifiedTime le 2014-02-23

Логический операторLogical operator ПримерExample
иand createdTime le 2014-01-30 and createdTime gt 2014-01-23
Кроме того:or createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'
notnot not contains(tolower(title),'school')

| Строкова функцияString function | ПримерExample | |------|------| | containscontains | `contains(tolower(title),'spring')` | | endswithendswith | `endswith(tolower(title),'spring')` | | startswithstartswith | `startswith(tolower(title),'spring')` | | lengthlength | `length(title) eq 19` | | indexofindexof | `indexof(tolower(title),'spring') eq 1` | | substringsubstring | `substring(tolower(title),1) eq 'spring'` | | tolowertolower | `tolower(title) eq 'spring'` | | touppertoupper | `toupper(title) eq 'SPRING'` | | trimtrim | `trim(tolower(title)) eq 'spring'` | | concatconcat | `concat(title,'- by MyRecipesApp') eq 'Carrot Cake Recipe - by MyRecipesApp'` |

Свойства объектов OneNoteOneNote entity properties

Выражения запроса filter, select, expand и orderby могут включать свойства объектов OneNote.The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

ПримерExample

../sections?filter=createdTime ge 2015-01-01&select=name,pagesUrl&orderby=lastModifiedTime desc

Для имен свойств в выражениях запроса учитывается регистр.Property names are case-sensitive in query expressions.

Список свойств и типы свойств см. в следующих статьях документации по API REST Microsoft Graph:For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

Параметр строки запроса expand можно использовать со следующими свойствами навигации:The expand query string option can be used with the following navigation properties:

  • страницы: parentNotebook, parentSection;Pages: parentNotebook, parentSection
  • разделы: parentNotebook, parentSectionGroup;Sections: parentNotebook, parentSectionGroup
  • группы разделов: sections, sectionGroups, parentNotebook, parentSectionGroup;Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
  • записные книжки: sections, sectionGroups.Notebooks: sections, sectionGroups

Информация о запросах GET и соответствующих ответахRequest and response information for GET requests

Данные запросаRequest data ОписаниеDescription
ПротоколProtocol Все запросы используют протокол SSL/TLS для HTTPS.All requests use the SSL/TLS HTTPS protocol.
Заголовок AuthorizationAuthorization header

Bearer {token}, где {token} — действительный маркер доступа OAuth 2.0 для зарегистрированного приложения.Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

Если он отсутствует или является недействительным, запрос завершится ошибкой с кодом состояния 401.If missing or invalid, the request fails with a 401 status code. См. статью Проверка подлинности и разрешения.See Authentication and permissions.

Заголовок AcceptAccept header

application/json — для объектов OneNote и их наборов.application/json for OneNote entities and entity sets

text/html — для содержимого страницы.text/html for page content


Данные в откликеResponse data ОписаниеDescription
Код успешного завершенияSuccess code Код состояния HTTP 200A 200 HTTP status code.
Текст ответаResponse body Представление объекта или набора объектов в формате JSON, HTML-код страницы или двоичные данные файлового ресурса.An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
ОшибкиErrors Если запрос завершается с ошибкой, API возвращает ошибки в объекте **@api.diagnostics** в тексте ответа.If the request fails, the API returns errors in the **@api.diagnostics** object in the response body.
Заголовок X-CorrelationIdX-CorrelationId header GUID, уникальный идентификатор запроса.A GUID that uniquely identifies the request. Это значение можно использовать вместе со значением заголовка Date при устранении неполадок совместно со службой поддержки Майкрософт.You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Составление корневого URL-адреса для службы заметок Microsoft GraphConstructing the Microsoft Graph notes service root URL

Для всех вызовов заметок Microsoft Graph используется следующий формат корневого URL-адреса:The Microsoft Graph notes root URL uses the following format for all calls to Microsoft Graph notes:

https://graph.microsoft.com/{version}/me/onenote/

Сегмент version URL-адреса представляет нужную версию Microsoft Graph.The version segment in the URL represents the version of Microsoft Graph that you want to use. Используйте значение v1.0 для стабильного кода в рабочей среде.Use v1.0 for stable production code. Используйте значение beta, чтобы опробовать функцию, находящуюся на стадии разработки.Use beta to try out a feature that's in development. Функции бета-версии могут меняться, поэтому не следует использовать их в производственном коде.Features and functionality in beta may change, so you shouldn't use it in your production code.

Используйте значение me для содержимого OneNote, доступного текущему пользователю (если он является владельцем или с ним поделились этим содержимым).Use me for OneNote content that the current user can access (owned and shared). Используйте значение users/{id} для содержимого OneNote, которым указанный (в URL-адресе) пользователь поделился с текущим пользователем.Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Используйте Microsoft Graph для получения ИД пользователей.Use Microsoft Graph to get user IDs.

Разрешения для запросов GETPermissions for GET requests

Чтобы получить содержимое или структуру OneNote, необходимо запросить соответствующие разрешения.To get OneNote content or structure, you'll need to request appropriate permissions.

Указанные ниже разрешения позволяют выполнять запросы GET к Microsoft Graph.The following scopes allow GET requests to Microsoft Graph. Выберите минимальный уровень разрешений, необходимый для работы вашего приложения.Choose the lowest level of permissions that your app needs to do its work.

Варианты:Choose from:

  • Notes.readNotes.read
  • Notes.ReadWriteNotes.ReadWrite
  • Notes.ReadWrite.AllNotes.ReadWrite.All

Дополнительные сведения об областях разрешений и принципе их использования см. в справочнике по разрешениям Microsoft Graph.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

См. такжеSee also