Table of contents
TOC
Свернуть оглавление
Развернуть оглавление
Последнее обновление: 23.08.2018

Следующий формат URL-адреса корневого каталога для обслуживания OneNote используется для всех вызовов API OneNote.

https://www.onenote.com/api/{version}/{location}/notes/


СегментversionURL-адреса представляет собой версию API OneNote, которую вы хотите использовать.

  • Используйтеv1.0 для разработки стабильного рабочего кода.
  • Используйте значение beta, чтобы опробовать функцию, находящуюся на стадии разработки. Функции бета-версии могут меняться, поэтому не следует использовать их в вашем рабочем коде.


Сегментlocation URL-адреса представляет собой местоположение записных книжек, к которым вы хотите получить доступ.

Записные книжки OneDrive для бизнеса
Использованиеmeдля содержимого OneNote, принадлежащего текущему пользователю.

Использование users/{id} для содержимого OneNote, которым указанный (в URL-адресе) пользователь поделился с текущим пользователем. ИспользуйтеAzure AD Graph API для получения идентификаторов пользователей.

Записные книжки на сайте SharePoint
Сайты групп и другие сайты SharePoint могут содержать записные книжки OneNote в своих библиотеках документов.

Использование myOrganization/siteCollections/{id}/sites/{id} для содержимого OneNote на сайте в в клиенте, к которому подключен текущий пользователь. Поддерживается только текущий клиент, доступ к которому осуществляется с помощью myOrganizationключевого слова. Узнайте, как получить Идентификаторы сайта.

Групповые записные книжки Office 365
Группы Office 365 являются частью взаимодействия, связанного с Office 365. Участники группы могут делиться записными книжками, файлами и электронной почтой.

Использование myOrganization/groups/{id} для содержимого OneNote в указанной группе, членом которой является текущий пользователь. Группы Office 365 (которые возвращают унифицированный groupType) являются единственным поддерживаемым типом группы. ИспользуйтеAzure AD Graph API для получения идентификаторов группы.


Используйте метод FromUrlдля получения семейства сайтов и идентификаторов сайта
Вы можете использовать метод FromUrl для получения семейства сайтов и идентификаторов сайтов для указанного абсолютного URL-адреса сайта. Вы должны осуществить этот вызов только при необходимости, а затем сохранить значения для будущего использования.

Формат URL-адреса сайта зависит от вашей конфигурации, например, https://domain.sharepoint.com/site-a или https://domain.com/sites/site-a.

Пример запроса:

GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')
Authorization: Bearer {token}
Accept: application/json

Пример ответа:

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.SiteMetadata",
  "siteCollectionId":"09d1a587-a84b-4264-3d15-669429be8cc5",
  "siteId":"d9e4d5c8-683f-4363-89ae-18c4e3da91e9"
}

Требования к использованию FromUrl и работа с записными книжками сайта SharePoint:

  • Вы можете создавать только записные книжки OneNote, группы разделов, разделы и страницы на сайтах с библиотекой документов по умолчанию. (Некоторые шаблоны сайтов не создают библиотеку документов по умолчанию.) Однако, запросы GET возвращают содержимое OneNote из всех библиотек документов на сайте.
  • URL-адреса корневого каталога для обслуживания OneNote неизменяем, что означает, что вы не можете использовать путь сайта REST API и затем добавить на него notes конечную точку.
  • Пользователь, от имени которого вы осуществляете вызов, должен быть участником сайта.
  • FromUrl работает только с проиндексированными сайтами. Для индексации нового сайта может потребоваться несколько часов.
© 2018 Microsoft