Obter a estrutura e o conteúdo do OneNote com o Microsoft GraphGet OneNote content and structure with Microsoft Graph

Aplica-se a: Blocos de anotações de consumidor no OneDrive | Blocos de anotações empresariais no Microsoft 365Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Microsoft 365

Para obter a estrutura e o conteúdo do OneNote, envie uma solicitação GET ao ponto de extremidade de destino.To get OneNote content and structure, you send a GET request to the target endpoint. Por exemplo:For example:

GET ../onenote/pages/{id}

Se a solicitação for bem-sucedida, o Microsoft Graph retornará um código de status de HTTP 200 e as entidades ou o conteúdo que você solicitou.If the request is successful, Microsoft Graph returns a 200 HTTP status code and the entities or content that you requested. As entidades do OneNote são retornadas como objetos JSON que estão em conformidade com a especificação OData versão 4.0.OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

Usando as opções de cadeia de caracteres de consulta, você pode filtrar as consultas e melhorar o desempenho.By using query string options, you can filter your queries and improve performance.

Construir a URI de solicitaçãoConstruct the request URI

Para construir a URI de solicitação, comece com a URL raiz do serviço:To construct the request URI, start with the service root URL:

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


Em seguida, acrescente o ponto de extremidade do recurso que você deseja recuperar.Then append the endpoint of the resource you want to retrieve. (Os caminhos recurso são mostrados na próxima seção).(Resource paths are shown in the next section.)

Sua URI de solicitação completa parecerá com um dos seguintes exemplos: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

Observação: saiba mais sobre a URL raiz de serviço.Note: Learn more about the service root URL.

Caminhos de recursos para solicitações GETResource paths for GET requests

Use os caminhos de recursos a seguir para obter páginas, seções, grupos de seções, blocos de anotações e recursos de arquivo ou imagem.Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

Coleção de páginasPage collection

Obter páginas (metadados) em todos os blocos de anotações.Get pages (metadata) across all notebooks.

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


Obter páginas (metadados) de uma seção específica.Get pages (metadata) from a specific section.

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


A opção de cadeia de caracteres de consulta `search` está disponível somente para blocos de anotações de consumidor.The `search` query string option is available for consumer notebooks only.

A ordem de classificação padrão é lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

A consulta padrão expande a seção pai e seleciona as propriedades id, name e self da seção.The default query expands the parent section and selects the section's id, name, and self properties.

Por padrão, somente as primeiras 20 entradas são retornadas para solicitações GET pages.By default, only the top 20 entries are returned for GET pages requests. Solicitações que não especificam uma opção principal de sequência de caracteres de consulta retornam um link @odata.nextLink na resposta que você pode usar para obter as próximas 20 entradas.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.

Para a coleção de páginas em uma seção, use pagelevel para retornar o nível de recuo de páginas e sua ordem dentro da seção.For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

ExemploExample

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

Entidade PagePage entity

Obtenha os metadados de uma página específica.Get the metadata for a specific page.

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


As páginas podem expandir as propriedades parentNotebook e parentSection.Pages can expand the parentNotebook and parentSection properties.

A consulta padrão expande a seção pai e seleciona as propriedades id, name e self da seção.The default query expands the parent section and selects the section's id, name, and self properties.

Use pagelevel para retornar o nível de recuo da página e sua ordem dentro da seção pai.Use pagelevel to return the indentation level of the page and its order within its parent section.

ExemploExample

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

Visualização de páginaPage preview

Obtenha conteúdo de visualização de texto e imagem de uma página.Get text and image preview content for a page.

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


A resposta JSON contém conteúdo de visualização que você pode usar para ajudar os usuários a identificar o que está na página.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"
    }
  }
}

A propriedade previewText contém um trecho de texto proveniente da página.The previewText property contains a text snippet from the page. O Microsoft Graph retorna frases completas, no máximo de 300 caracteres.Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

Se a página tem uma imagem que pode ser usada para criar uma IU de visualização, a propriedade href no objeto previewImageUrl contém um link para um recurso de imagem público.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 image resource. Você pode usar esse link em HTML.You can use this link in HTML. Caso contrário, href retorna nulo.Otherwise, href returns null.

ExemploExample

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

Conteúdo HTML da páginaPage HTML content

Obtenha o conteúdo HTML da página.Get the HTML content of a page.

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

(saiba mais sobre conteúdo HTML retornado)(learn more about returned HTML content)


Use a opção de cadeia de caracteres de consulta includeIDs=true para obter IDs gerados usados para atualizar a página.Use the includeIDs=true query string option to get generated IDs used to update the page.

Conjunto da seçãoSection collection

Obtenha todas as seções de todos os blocos de anotações de propriedade de um usuário, incluindo seções em grupos de seções aninhadas.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]


Obtenha todas as seções que estão diretamente em um grupo de seções específico.Get all sections that are directly under a specific section group.

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


Obtenha todas as seções que estão diretamente em um bloco de anotações específico.Get all sections that are directly under a specific notebook.

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


As seções podem expandir as propriedades parentNotebook e parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

A ordem de classificação padrão para seções é name asc.The default sort order for sections is name asc.

A consulta padrão expande o bloco de anotações pai e o grupo de seções pai e seleciona as propriedades id, name e self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Entidade SectionSection entity

Obtenha uma seção específica.Get a specific section.

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


As seções podem expandir as propriedades parentNotebook e parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

A consulta padrão expande o bloco de anotações pai e o grupo de seções pai e seleciona as propriedades id, name e self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Coleção SectionGroupSectionGroup collection

Obtenha todos os grupos de seções de todos os blocos de anotações que são de propriedade de um usuário, incluindo grupos de seções aninhadas.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]


Obtenha todos os grupos de seções que estão diretamente em um bloco de anotações específico.Get all section groups that are directly under a specific notebook.

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


Os grupos de seções podem expandir as propriedades sections, sectionGroups, parentNotebook e parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

A ordem de classificação padrão para grupos de seções é name asc.The default sort order for section groups is name asc.

A consulta padrão expande o bloco de anotações pai e o grupo de seções pai e seleciona as propriedades id, name e self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Entidade SectionGroupSectionGroup entity

Obtenha um grupo de seções específico.Get a specific section group.

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


Os grupos de seções podem expandir as propriedades sections, sectionGroups, parentNotebook e parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

A consulta padrão expande o bloco de anotações pai e o grupo de seções pai e seleciona as propriedades id, name e self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Coleção de blocos de anotaçõesNotebook collection

Obtenha todos os blocos de anotações de propriedade do usuário.Get all the notebooks that are owned by the user.

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


Os blocos de anotações podem expandir as propriedades sections e sectionGroups.Notebooks can expand the sections and sectionGroups properties.

A ordem de classificação padrão para blocos de anotações é name asc.The default sort order for notebooks is name asc.

Entidade NotebookNotebook entity

Obtenha um bloco de anotações específico.Get a specific notebook.

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


Os blocos de anotações podem expandir as propriedades sections e sectionGroups.Notebooks can expand the sections and sectionGroups properties.

Imagem ou outro recurso de arquivoImage or other file resource

Obtenha os dados binários de um recurso específico.Get the binary data of a specific resource.

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


Você pode encontrar a URI do recurso do arquivo na página de HTML de saída.You can find the file's resource URI in the page's output HTML.

Por exemplo, um rótulo img inclui os pontos de extremidade para a imagem original no atributo data-fullres-src e a imagem otimizada no atributo 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.

ExemploExample

<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" ... />

E um rótulo object inclui o ponto de extremidade para o recurso do arquivo no atributo data.And an object tag includes the endpoint for the file resource in the data attribute.

ExemploExample

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

Observação: não há suporte para obter uma coleção de recursos.Note: Getting a collection of resources is not supported.

Quando um recurso de arquivo é obtido, não é necessário incluir um tipo de conteúdo Accept na solicitação.When you get a file resource, you don't need to include an Accept content type in the request.

Para obter mais informações sobre solicitações GET, confira os seguintes recursos na referência do Microsoft Graph API REST:For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

Exemplo de solicitações GETExample GET requests

Você pode consultar entidades do OneNote e o conteúdo de página de pesquisa para obter apenas as informações que você precisa.You can query for OneNote entities and search page content to get just the information you need. Os exemplos a seguir mostram algumas maneiras de usar opções de cadeia de caracteres de consulta com suporte em solicitações GET para o Microsoft Graph.The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

Lembre-se:Remember:

  • Todas as solicitações GET começam com a URL raiz de serviço raiz.All GET requests start with the service root URL.

    Exemplos: https://www.onenote.com/api/v1.0/me/notes e 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/

  • Os espaços na cadeia de caracteres de consulta da URL devem usar a codificação de %20.Spaces in the URL query string must use %20 encoding.

    Exemplo: filter=title%20eq%20'biology'Example: filter=title%20eq%20'biology'

  • Os nomes de propriedade e as comparações de cadeias de caracteres de OData diferenciam maiúsculas de minúsculas.Property names and OData string comparisons are case-sensitive. É recomendável usar a função tolower do OData para comparações de cadeia de caracteres.We recommend using the OData tolower function for string comparisons.

    Exemplo: filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

search e filtersearch & filter

Obtenha todas as páginas que contêm o termo recipe que foram criadas por um aplicativo específico (search está disponível somente para blocos de anotações de consumidor).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 e selectsearch & select

Obtenha o título, links de cliente do OneNote e o link contentUrl para todas as páginas que contêm o termo golgi app (search está disponível somente para blocos de anotações de consumidor).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

Obtenha todos os blocos de anotações e expanda suas seções e grupos de seções.Get all notebooks and expand their sections and section groups.

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

Obtenha um grupo de seções específico e expanda suas seções e grupos de seções.Get a specific section group and expand its sections and section groups.

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

Obtenha uma página e expanda sua seção pai e o bloco de anotações pai.Get a page and expand its parent section and parent notebook.

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

expand (vários níveis)expand (multiple levels)

Obtenha todos os blocos de anotações e expanda suas seções e grupos de seções, e expanda todas as seções em cada grupo de seções.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)

Observação: expandir pais de entidades filho ou filhos de entidades pai cria uma referência circular e não tem suporte.Note: Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand e select (vários níveis)expand & select (multiple levels)

Obtenha o nome e o link self para um grupo de seções específico, e obtenha o nome e os links self para todas as suas seções.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

Obtenha o nome e o link self para todas as seções e o nome e o tempo criados de cada bloco de anotações pai da seção.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

Obtenha o título e uma ID de todas as páginas, e o nome da seção pai e do bloco de anotações pai.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 e levels (vários níveis)expand & levels (multiple levels)

Obtenha todos os blocos de anotações, seções e grupos de seção.Get all notebooks, sections, and section groups.

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

filterfilter

Obtenha todas as seções que foram criadas em outubro de 2014.Get all sections that were created in October 2014.

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

Obtenha as páginas que foram criadas por um aplicativo específico desde 1º de janeiro de 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 e expandfilter & expand

Obtenha todas as páginas em um bloco de anotações específico.Get all pages in a specific notebook. A API retorna 20 entradas por padrão.The API returns 20 entries by default.

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

Obtenha o nome e o link pagesUrl para todas as seções do bloco de anotações School.Get the name and pagesUrl link for all sections from the School notebook. Comparações de cadeias de caracteres de OData diferenciam maiúsculas de minúsculas, portanto, use a função tolower como uma prática recomendada.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 e orderbyfilter & select & orderby

Obtenha o nome e o link pagesUrl para todas as seções que contêm o termo spring no nome da seção.Get the name and pagesUrl link for all sections that contain the term spring in the section name. Ordenar seções de pedidos por última data modificada.Order sections by last modified date.

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

orderbyorderby

Obtenha as primeiras 20 páginas pela propriedade createdByAppId e, depois, pela hora de criação mais recente.Get the first 20 pages ordered by createdByAppId property and then by most recent created time. A API retorna 20 entradas por padrão.The API returns 20 entries by default.

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

search, filter e topsearch & filter & top

Obtenha as cinco páginas mais recentemente criadas desde 1º de janeiro de 2015 com a frase cell division.Get the five newest pages created since January 1, 2015 that contain the phrase cell division. A API retorna 20 entradas por padrão com um máximo de 100.The API returns 20 entries by default with a maximum of 100. A ordem de classificação padrão de páginas é lastModifiedTime desc (search está disponível somente para blocos de anotações de consumidor).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 e skipsearch & filter & top & skip

Obtenha as cinco próximas páginas do conjunto de resultados (search está disponível somente para blocos de anotações de consumidor).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

E as cinco seguintes (search está disponível somente para blocos de anotações de consumidor).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

Observação: se search e filter são aplicadas à mesma solicitação, os resultados incluem apenas as entidades que correspondem aos dois critérios.Note: If both search and filter are applied to the same request, the results include only those entities that match both criteria.

selectselect

Obtenha nome, hora de criação e link self de todas as seções nos blocos de anotações do usuário.Get the name, created time, and self link for all sections in the user's notebooks.

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

Obtenha título, hora de criação e links do cliente do OneNote para uma página específica.Get the title, created time, and OneNote client links for a specific page.

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

select, expand e filter (vários níveis)select & expand & filter (multiple levels)

Obtenha nome e link pagesUrl para todas as seções do bloco de anotações do usuário.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 e orderbytop & select & orderby

Obtenha o título e o link self das 50 primeiras páginas, classificadas em ordem alfabética por título.Get the title and self link for the first 50 pages, ordered alphabetically by title. A API retorna 20 entradas por padrão com um máximo de 100.The API returns 20 entries by default with a maximum of 100. A ordem de classificação padrão é lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

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

skip, top, select e orderbyskip & top & select & orderby

Obtenha páginas de 51 a 100.Get pages 51 to 100. A API retorna 20 entradas por padrão com um máximo de 100.The API returns 20 entries by default with a maximum of 100.

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

Observação: As solicitações GET para páginas que recuperam o número padrão de entradas (ou seja, elas não especificam uma expressão top) retornam um link @odata.nextLink na resposta que você pode usar para obter as próximas 20 entradas.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.

Opções de cadeia de caracteres de consulta OData com suporte.Supported OData query string options

Quando enviar solicitações GET para Microsoft Graph, você pode usar as opções de cadeia de caracteres de consulta de OData para personalizar sua consulta e obter apenas as informações que você precisa.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. Também podem melhorar o desempenho, reduzindo o número de chamadas para o serviço e o tamanho da carga de resposta.They can also improve performance by reducing the number of calls to the service and the size of the response payload.

Observação: para facilitar a leitura, os exemplos neste artigo não usam a codificação de %20 necessária para espaços na cadeia de caracteres de consulta da 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

Opção de consultaQuery option Exemplo e descriçãoExample and description
countcount

count=true

A contagem de entidades da coleção.The count of entities in the collection. O valor é retornado na propriedade odata.coun@ t na resposta.The value is returned in the @odata.count property in the response.

expandexpand

expand=sections,sectionGroups

Propriedades de navegação para retornar embutidas na resposta.The navigation properties to return inline in the response. As propriedades a seguir têm suporte para expressões expand:The following properties are supported for expand expressions:
– Páginas: parentNotebook, parentSection- Pages: parentNotebook, parentSection
– Seções: parentNotebook, parentSectionGroup- Sections: parentNotebook, parentSectionGroup
– Grupos de seções: sections, sectionGroups, parentNotebook, parentSectionGroup- Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
– Blocos de anotações: sections, sectionGroups- Notebooks: sections, sectionGroups

Por padrão, as solicitações GET de páginas expandem parentSection e selecionam as propriedades id, name e self.By default, GET requests for pages expands parentSection and select the section's id, name, and self properties. Solicitações GET padrão de seções e grupos de seções expandem parentNotebook e parentSectionGroup e selecionam as propriedades pai id, name e self.Default GET requests for sections and section groups expand both parentNotebook and parentSectionGroup, and select the parents' id, name, and self properties.

Pode ser usado para uma única entidade ou uma coleção.Can be used for a single entity or a collection.
Separar com vírgulas várias propriedades.Separate multiple properties with commas.
Os nomes de propriedades diferenciam maiúsculas de minúsculas.Property names are case-sensitive.

filterfilter

filter=isDefault eq true

Uma expressão booliana para se deseja incluir uma entrada no conjunto de resultados.A Boolean expression for whether to include an entry in the result set. Compatível com os seguintes operadores e funções OData:Supports the following OData operators and functions:
– Operadores de comparação: eq, ne, gt, ge, lt, le- Comparison operators: eq, ne, gt, ge, lt, le
– Operadores lógicos: and, or, not- Logical operators: and, or, not
– Funções de cadeia de caracteres: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat- String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

Os nomes de propriedade e as comparações de cadeias de caracteres de OData diferenciam maiúsculas de minúsculas.Property names and OData string comparisons are case-sensitive. É recomendável usar a função tolower do OData para comparações de cadeia de caracteres.We recommend using the OData tolower function for string comparisons.

Exemplo: filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

orderbyorderby

orderby=title,createdTime desc

As propriedades para classificar por, com uma ordem de classificação opcional asc (padrão) ou desc.The properties to sort by, with an optional asc (default) or desc sort order. Você pode classificar por qualquer propriedade da entidade na coleção solicitada.You can sort by any property of the entity in the requested collection.

A ordem de classificação padrão para blocos de anotações, grupos de seções e seções é name asc, e para páginas é lastModifiedTime desc (última página modificada primeiro).The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

Separe as várias propriedades com vírgulas e liste-as na ordem de aplicação desejada.Separate multiple properties with commas, and list them in the order that you want them applied. Os nomes de propriedades diferenciam maiúsculas de minúsculas.Property names are case-sensitive.

searchsearch

search=cell div

Disponível somente para blocos de anotações de consumidor.Available for consumer notebooks only.

O termo ou frase para pesquisar no título da página, corpo da página, texto alt da imagem e texto da imagem OCR.The term or phrase to search for in the page title, page body, image alt text, and image OCR text. Por padrão, consultas de pesquisa retornam resultados classificados por relevância.By default, search queries return results sorted by relevance.

O OneNote usa a pesquisa de texto completo do Bing para dar suporte a pesquisa de frase, lematização, tolerância de ortografia, relevância e classificação, quebra de palavras, vários idiomas e outros recursos de pesquisa de texto completo.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. As cadeias de caracteres de pesquisa diferenciam maiúsculas de minúsculas.Search strings are case-insensitive.

Aplica-se somente a páginas em blocos de anotações de propriedade do usuário.Applies only to pages in notebooks owned by the user. O conteúdo indexado é privado e só pode ser acessado pelo proprietário.Indexed content is private and can only be accessed by the owner. As páginas protegidas por senha não são indexadas.Password-protected pages are not indexed. Aplicável somente ao ponto de extremidade pages.Applies only to the pages endpoint.

selectselect

select=id,title

As propriedades a serem retornadas.The properties to return. Pode ser usado para uma única entidade ou para uma coleção.Can be used for a single entity or for a collection. Separar com vírgulas várias propriedades.Separate multiple properties with commas. Os nomes de propriedades diferenciam maiúsculas de minúsculas.Property names are case-sensitive.

skipskip

skip=10

O número de entradas para ignorar no conjunto de resultados.The number of entries to skip in the result set. Costumam ser usadas para resultados de paginação.Typically used for paging results.

toptop

top=50

O número de entradas para retornar do conjunto de resultados, até um máximo de 100.The number of entries to return in the result set, up to a maximum of 100. O valor padrão é 20.The default value is 20.

O Microsoft Graph também fornece a opção de cadeia de caracteres de consulta pagelevel que você pode usar para obter o nível e ordem das páginas dentro da seção pai.Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. Aplicam-se apenas às consultas de páginas em uma seção específica ou consultas para uma página específica.Applies only to queries for pages in a specific section or queries for a specific page.

ExemplosExamples

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

Funções e operadores de OData compatíveisSupported OData operators and functions

Microsoft Graph é compatível com os seguintes operadores e funções do OData nas expressões de filter.Microsoft Graph supports the following OData operators and functions in filter expressions. Ao usar expressões de OData, lembre-se:When using OData expressions, remember:

  • Os espaços na cadeia de caracteres de consulta da URL devem ser substituídos pela codificação %20.Spaces in the URL query string must be replaced with the %20 encoding.

    Exemplo: filter=isDefault%20eq%20trueExample: filter=isDefault%20eq%20true

  • Os nomes de propriedade e as comparações de cadeias de caracteres de OData diferenciam maiúsculas de minúsculas.Property names and OData string comparisons are case-sensitive. É recomendável usar a função tolower do OData para comparações de cadeia de caracteres.We recommend using the OData tolower function for string comparisons.

    Exemplo: filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

Operador de comparaçãoComparison operator ExemploExample
eqeq
(igual a)(equal to)
createdByAppId eq '{app-id}'
nene
(é diferente de)(not equal to)
userRole ne 'Owner'
gtgt
(maior que)(greater than)
createdTime gt 2014-02-23
gege
(maior que ou igual a)(greater than or equal to)
lastModifiedTime ge 2014-05-05T07:00:00Z
ltlt
(menor que)(less than)
createdTime lt 2014-02-23
lele
(menor que ou igual a)(less than or equal to)
lastModifiedTime le 2014-02-23

Operador lógicoLogical operator ExemploExample
eand createdTime le 2014-01-30 and createdTime gt 2014-01-23
oror createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'
notnot not contains(tolower(title),'school')

| Função da cadeia de caracteresString function | ExemploExample | |------|------| | 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'` |

Propriedades de entidade do OneNoteOneNote entity properties

As expressões de consulta filter, select, expand e orderby podem incluir propriedades de entidades do OneNote.The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

ExemploExample

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

Os nomes de propriedades diferenciam maiúsculas de minúsculas em expressões de consulta.Property names are case-sensitive in query expressions.

Para obter a lista de propriedades e seus tipos, confira os seguintes recursos na referência do Microsoft Graph API REST:For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

A opção de cadeia de caracteres de consulta expand pode ser usada com as seguintes propriedades de navegação:The expand query string option can be used with the following navigation properties:

  • Páginas: parentNotebook, parentSectionPages: parentNotebook, parentSection
  • Seções: parentNotebook, parentSectionGroupSections: parentNotebook, parentSectionGroup
  • Grupos de seções: sections, sectionGroups, parentNotebook, parentSectionGroupSection groups: sections, sectionGroups, parentNotebook, parentSectionGroup
  • Blocos de anotações: sections, sectionGroupsNotebooks: sections, sectionGroups

Informações de solicitação e resposta para solicitações de GETRequest and response information for GET requests

Dados da solicitaçãoRequest data DescriçãoDescription
ProtocoloProtocol Todas as solicitações usam o protocolo HTTPS de SSL/TLS.All requests use the SSL/TLS HTTPS protocol.
Cabeçalho de autorizaçãoAuthorization header

Bearer {token}, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado.Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

Se ele estiver ausente ou for inválido, a solicitação falhará com um código de status 401.If missing or invalid, the request fails with a 401 status code. Confira Autenticação e permissões.See Authentication and permissions.

Cabeçalho AcceptAccept header

application/json para entidades e conjuntos de entidades do OneNoteapplication/json for OneNote entities and entity sets

text/html para conteúdo de páginatext/html for page content


Dados de respostaResponse data DescriçãoDescription
Código de êxitoSuccess code Um código de status de HTTP 200.A 200 HTTP status code.
Corpo da respostaResponse body Uma representação de OData da entidade ou conjunto de entidades no formato JSON, da página HTML ou dados binários do recurso de arquivo.An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
ErrosErrors Se a solicitação falhar, a API retornará erros no objeto errors no @@api.diagnostics no corpo da resposta.If the request fails, the API returns errors in the @api.diagnostics object in the response body.
Cabeçalho X-CorrelationIdX-CorrelationId header Um GUID que identifica de forma exclusiva a solicitação.A GUID that uniquely identifies the request. Você pode usar esse valor juntamente com o valor do cabeçalho Data ao trabalhar com o suporte da Microsoft para solucionar problemas.You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Criar a URL raiz do serviço de anotações do Microsoft GraphConstructing the Microsoft Graph notes service root URL

A URL raiz do serviço de anotações do Microsoft Graph usa o formato a seguir para todas as chamadas para o Microsoft Graph:The Microsoft Graph notes root URL uses the following format for all calls to Microsoft Graph notes:

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

O segmento version na URL representa a versão do Microsoft Graph que você deseja usar.The version segment in the URL represents the version of Microsoft Graph that you want to use. Use v1.0 para o código de produção estável.Use v1.0 for stable production code. Use beta para experimentar um recurso que está em desenvolvimento.Use beta to try out a feature that's in development. Os recursos e a funcionalidade na versão beta podem mudar, por isso, você não deve usá-la no código de produção.Features and functionality in beta may change, so you shouldn't use it in your production code.

Use me para o conteúdo do OneNote que o usuário atual pode acessar (exclusivo e compartilhado).Use me for OneNote content that the current user can access (owned and shared). Use users/{id} para o conteúdo do OneNote que o usuário especificado (na URL) compartilhou com o usuário atual.Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Use o Microsoft Graph para obter as IDs de usuário.Use Microsoft Graph to get user IDs.

Permissões para solicitações GETPermissions for GET requests

Para obter conteúdo ou estrutura do OneNote, você vai precisar solicitar as permissões adequadas.To get OneNote content or structure, you'll need to request appropriate permissions.

Os seguintes escopos permitem solicitações GET para Microsoft Graph.The following scopes allow GET requests to Microsoft Graph. Escolha o nível mais baixo de permissões que seu aplicativo precisa para realizar o trabalho.Choose the lowest level of permissions that your app needs to do its work.

Escolha entre:Choose from:

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

Para saber mais sobre escopos de permissão e como eles funcionam, confira Referência de permissões do Microsoft Graph.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Confira tambémSee also