Поддерживаемые операции REST

Статья
04/05/2015

Область применения: пользовательские записные книжки в OneDrive и корпоративные записные книжки в Office 365.

В этой статье перечислены операции REST, которые вы можете использовать с API OneNote.

Важно!

Служба API Console более не доступна. Подробнее см. статью Мы прекращаем поддержку классических API-консолей.

Операции со страницами

GET /pages

Получение всех страниц.

GET /pages?search

Поиск страниц. (Только для объекта-получателя OneDrive)

GET /sections/{id}/pages

Получение всех страниц в определенном разделе.

GET /sections/{id}/pages?pagelevel

Получение уровня отступов и порядка страниц в разделе. GET /pages/{id}?pagelevel также поддерживается.

GET /pages/{id}

Получение указанной страницы.

GET /pages/{id}/preview

Получение текста и содержимого предварительной версии образа для указанной страницы.

GET /pages/{id}/content

Получение HTML-содержимого для указанной страницы.

POST /pages

Создание страницы в разделе по умолчанию. (Личные записные книжки на OneDrive или OneDrive для бизнеса)

POST /pages?sectionName

Создание страницы в именованном разделе в записной книжке по умолчанию. (Личные записные книжки на OneDrive или OneDrive для бизнеса)

POST /sections/{id}/pages

Создание страницы в определенном разделе.

POST /pages/{id}/copyToSection

Копировать страницу в раздел (Только Office 365)

PATCH /pages/{id}/content

Обновление HTML-содержимого страницы.

DELETE /pages/{id}

Удаление определенной страницы.

Предупреждение

Использование OneNote API для безвозвратного удаления страниц. Удаленные страницы не могут быть восстановлены.

Узнайте больше о запросах GET (включая поддерживаемые параметры строки запроса) и о том, как создавать страницы, обновлять содержимое страниц и копировать страницы.

Операции с разделами

GET /sections

Получение всех разделов.

GET /notebooks/{id}/sections

Получение всех разделов в указанной записной книжке.

GET /sectionGroups/{id}/sections

Получение всех разделов в указанной группе разделов.

GET /sections/{id}

Получение определенного раздела.

POST /notebooks/{id}/sections

Создание раздела в указанной записной книжке.

POST /sectionGroups/{id}/sections

Создание раздела в определенной группе разделов.

PATCH /sections/{id}

Изменение названия раздела. Отправьте новое имя, используя тип содержимогоприложение/JSON в тексте сообщения, например: { "name": "New section name" }

POST /sections/{id}/copyToNotebook

Копирование раздела в записную книжку. (только для Office 365)

POST /sections/{id}/copyToSectionGroup

Копирование раздела в группу разделов. (только для Office 365)

GET /sections/{id}/permissions

Получение разрешений для раздела. (только для Office 365)

GET /sections/{id}/permissions/{id}

Получение конкретных разрешений для раздела. (только для Office 365)

POST /sections/{id}/permissions

Создание или обновление разрешения для раздела. (только для Office 365)

DELETE /sections/{id}/permissions/{id}

Удаление разрешения для раздела. (только для Office 365)

Узнайте больше о запросах GET (включая поддерживаемые параметры строки запроса) и о том, как копировать разделы.

Операции с группами разделов

GET /sectionGroups

Получение всех групп раздела.

GET /notebooks/{id}/sectionGroups

Получение всех групп раздела в указанной записной книжке.

GET /sectionGroups/{id}/sectionGroups

Получение всех групп раздела в указанной группе раздела.

GET /sectionGroups/{id}

Получение определенной группы разделов.

POST /notebooks/{id}/sectionGroups

Создание группы раздела в указанной записной книжке.

POST /sectionGroups/{id}/sectionGroups

Создание группы раздела в указанной группе раздела.

GET /sectiongroups/{id}/permissions

Получение разрешений для группы раздела. (только для Office 365)

GET /permissions/{id}

Получение указанных разрешений для группы раздела. (только для Office 365)

POST /permissions

Создание или обновление разрешения для группы раздела. (только для Office 365)

DELETE /permissions/{id}

Удаление разрешения для группы раздела. (только для Office 365)

Узнайте больше о запросах GET (включая поддерживаемые параметры строки запроса).

Операции с записными книжками

GET /notebooks

Получение всех записных книжек.

GET /notebooks/{id}

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

POST /notebooks

Создание записной книжки.

POST /notebooks/{id}/copyNotebook

Копирование записной книжки. (только для Office 365)

GET /notebooks/{id}/permissions

Получение разрешений для записной книжки. (только для Office 365)

GET /permissions/{id}

Получение указанного разрешения для записной книжки. (только для Office 365)

POST /permissions

Создание или обновление разрешения для записной книжки. (только для Office 365)

DELETE /permissions/{id}

Удаление разрешения для записной книжки. (только для Office 365)

Узнайте больше о запросах GET (включая поддерживаемые параметры строки запроса) и о том, как копировать записные книжки.

Примечание

Используйте classNotebooks конечную точку для работы с записными книжками для занятий и staffNotebooks конечную точку для работы со служебными записными книжками.

Операции с ресурсами

GET /resources/{id}/content

Получение двоичного содержимого образа или файлового ресурса.

Узнайте больше о запросах GET и о том, как добавлять образы и файлы на страницу.

Поделиться через