Operações REST suportadas

  • Artigo

Aplica-se a: Blocos de anotações de consumidor no OneDrive | Blocos de anotações empresariais no Office 365

Este artigo lista as operações REST que você pode usar com a API do OneNote.

Importante

O Serviço do Console de API não está mais disponível. Para obter mais informações, consulte Estamos desativando as Consoles de API clássicas.

Operações de página

GET /pages

Obter todas as páginas.

GET /pages?search

Pesquisar páginas. (somente no OneDrive do consumidor)

GET /sections/{id}/pages

Obter todas as páginas em uma seção específica.

GET /sections/{id}/pages?pagelevel

Obter o nível de recuo e a ordem das páginas em uma seção. GET /pages/{id}?pagelevel também é suportado.

GET /pages/{id}

Obtenha uma página específica.

GET /pages/{id}/preview

Obter a visualização prévia do conteúdo texto e imagem para uma página específica.

GET /pages/{id}/content

Obter o conteúdo HTML de uma página específica.

POST /pages

Criar uma página na seção padrão. (apenas para blocos de anotações pessoais no OneDrive ou no OneDrive for Business)

POST /pages?sectionName

Criar uma página em uma seção nomeada no bloco de anotações padrão. (apenas para blocos de anotações pessoais no OneDrive ou no OneDrive for Business)

POST /sections/{id}/pages

Crie uma página em uma seção específica.

POST /pages/{id}/copyToSection

Copiar uma página para uma seção. (apenas no Office 365)

PATCH /pages/{id}/content

Atualize o conteúdo HTML de uma página.

DELETE /pages/{id}

Excluir uma página específica.

Aviso

A exclusão de páginas usando a API do OneNote é permanente. As páginas excluídas não podem ser recuperadas.


Saiba mais sobre solicitações GET (incluindo opções com cadeias de caracteres de consulta suportadas) e como criar páginas, atualizar o conteúdo da página e copiar páginas.

Operações de seção

GET /sections

Obter todas as seções.

GET /notebooks/{id}/sections

Obter todas as seções em um bloco de anotações específico.

GET /sectionGroups/{id}/sections

Obter todas as seções de um grupo específico de seções.

GET /sections/{id}

Obter uma seção específica.

POST /notebooks/{id}/sections

Criar uma seção em um bloco de anotações específico.

POST /sectionGroups/{id}/sections

Crie uma seção em um grupo de seções específico.

PATCH /sections/{id}

Altere o nome de uma seção. Envie o novo nome usando o tipo de conteúdo application/json no corpo da mensagem, assim: { "name": "New section name" }

POST /sections/{id}/copyToNotebook

Copiar uma seção para um bloco de anotações. (apenas no Office 365)

POST /sections/{id}/copyToSectionGroup

Copiar uma seção para um grupo de seções. (apenas no Office 365)

GET /sections/{id}/permissions

Obter permissões para a seção. (apenas no Office 365)

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

Obter uma permissão específica para a seção. (apenas no Office 365)

POST /sections/{id}/permissions

Criar ou atualizar uma permissão para a seção. (apenas no Office 365)

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

Excluir uma permissão para a seção. (apenas no Office 365)


Saiba mais sobre solicitações GET (incluindo opções com cadeias de caracteres de consulta suportadas) e como copiar seções.

Operações de grupo de seções

GET /sectionGroups

Obter todos os grupos de seções.

GET /notebooks/{id}/sectionGroups

Obter todos os grupos de seções em um bloco de anotações específico.

GET /sectionGroups/{id}/sectionGroups

Obter todos os grupos de seções em um grupo de seções específico.

GET /sectionGroups/{id}

Obter um grupo de seções específico.

POST /notebooks/{id}/sectionGroups

Criar um grupo de seções em um bloco de anotações específico.

POST /sectionGroups/{id}/sectionGroups

Crie um grupo de seções em um grupo de seções específico.

GET /sectiongroups/{id}/permissions

Obter permissões para o grupo de seções. (apenas no Office 365)

GET /permissions/{id}

Obter uma permissão específica para o grupo de seções. (apenas no Office 365)

POST /permissions

Criar ou atualizar uma permissão para o grupo de seções. (apenas no Office 365)

DELETE /permissions/{id}

Excluir uma permissão para o grupo de seções. (apenas no Office 365)


Saiba mais sobre solicitações GET (incluindo opções de cadeias de caracteres de consulta suportadas).

Operações de bloco de anotações

GET /notebooks

Obter todos os blocos de anotações.

GET /notebooks/{id}

Obter um bloco de anotações específico.

POST /notebooks

Crie um bloco de anotações.

POST /notebooks/{id}/copyNotebook

Copiar um bloco de anotações. (apenas no Office 365)

GET /notebooks/{id}/permissions

Obter permissões para o bloco de anotações. (apenas no Office 365)

GET /permissions/{id}

Obter uma permissão específica para o bloco de anotações. (apenas no Office 365)

POST /permissions

Criar ou atualizar uma permissão para o bloco de anotações. (apenas no Office 365)

DELETE /permissions/{id}

Excluir uma permissão para o bloco de anotações. (apenas no Office 365)


Saiba mais sobre solicitações GET (incluindo opções de cadeias de caracteres de consulta suportadas) e como copiar blocos de anotações.

Observação

Use o ponto de extremidade classNotebooks para trabalhar com blocos de anotações de classe e o ponto de extremidade staffNotebooks para trabalhar com blocos de anotações da equipe.

Operações de recursos

GET /resources/{id}/content

Obtenha o conteúdo binário de uma imagem ou arquivo.


Saiba mais sobre solicitações GET e como adicionar imagens e arquivos a uma página.

Confira também