Table of contents
TOC
Recolher sumário
Expandir sumário
Última Atualização: 10/07/2018

A URL da raiz do serviço do OneNote usa o formato a seguir para todas as chamadas para o OneNote.

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


O segmento version na URL representa a versão da API do OneNote que você deseja usar.

  • Use v1.0 para um código de produção estável.
  • Use beta para experimentar um recurso que está em desenvolvimento. Os recursos e as funcionalidades na versão beta podem sofrer alterações, então você não deve usá-la no seu código de produção.


O segmento location na URL representa a localização dos blocos de anotações que você deseja acessar.

Blocos de anotações no OneDrive for Business
Use me para conteúdos do OneNote pertencentes ao usuário atual.

Use users/{id} para conteúdos do OneNote que o usuário especificado (na URL) compartilhou com o usuário atual. Use a API do Azure AD Graph para obter IDs de usuários.

Blocos de anotações do site do SharePoint
Sites de equipe e outros sites do SharePoint podem conter blocos de anotações do OneNote em suas bibliotecas de documentos.

Use myOrganization/siteCollections/{id}/sites/{id} para conteúdos do OneNote em um site no locatário em que o usuário atual está conectado. Apenas o inquilino atual tem suporte, acessado com a palavra-chave myOrganization. Aprenda como obter IDs de site.

Blocos de anotações de grupo do Office 365
Os grupos do Office 365 fazem parte da experiência conectada do Office 365. Os membros do grupo podem compartilhar blocos de anotações, arquivos e e-mails.

Use myOrganization/groups/{id} para conteúdos do OneNote no grupo especificado do qual o usuário atual é membro. Os grupos do Office 365 (que retornam o grouptype unificado) são o único tipo de grupo com suporte. Use a API do Azure AD Graph para obter IDs de grupos.


Use o método FromUrl para obter o conjunto de sites e as IDs dos sites
Você pode usar o método FromUrl para obter o conjunto de sites e os IDs dos sites para uma URL absoluta do site especificado. Você deve fazer essa chamada somente quando necessário e armazenar os valores para uso futuro.

O formato da URL do site depende da sua configuração, por exemplo https://domain.sharepoint.com/site-a ou https://domain.com/sites/site-a.

Exemplo de solicitação:

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

Exemplo de resposta:

{
  "@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"
}

Requisitos para uso de FromUrl e como trabalhar com os blocos de anotações do site do SharePoint:

  • Você só pode criar blocos de anotações, grupos de seções, seções e páginas do OneNote em sites que tenham uma biblioteca de documentos padrão. (Alguns modelos de site não criam uma biblioteca de documentos padrão.) No entanto, as solicitações GET retornam o conteúdo do OneNote de todas as bibliotecas de documentos no site.
  • A URL da raiz do serviço do OneNote é imutável, o que significa que você não pode usar um caminho do site da API REST do SharePoint e depois rastrear o ponto de extremidade notes nele.
  • O usuário para quem você está fazendo a chamada deve ser membro do site.
  • O método FromUrl funciona apenas com sites que foram indexados. Pode levar várias horas para indexar um site novo.
© 2018 Microsoft