Obtener el contenido y la estructura de OneNote con Microsoft GraphGet OneNote content and structure with Microsoft Graph

Se aplica a: Blocs de notas para consumidores de OneDrive | Blocs de notas empresariales de Office 365Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Para obtener la estructura y el contenido de OneNote, envíe una solicitud GET al extremo de destino.To get OneNote content and structure, you send a GET request to the target endpoint. Por ejemplo:For example:

GET ../onenote/pages/{id}

Si la solicitud es correcta, Microsoft Graph devuelve un código de estado HTTP 200 y las entidades o el contenido que ha solicitado.If the request is successful, Microsoft Graph returns a 200 HTTP status code and the entities or content that you requested. Las entidades de OneNote se devuelven como objetos JSON que cumplen la especificación de la versión 4.0 de OData.OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

Puede filtrar las consultas y mejorar el rendimiento usando las opciones de la cadena de consulta.By using query string options, you can filter your queries and improve performance.

Crear el URI de la solicitudConstruct the request URI

Para crear el URI de la solicitud, comience con la dirección URL raíz del servicio:To construct the request URI, start with the service root URL:

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


Después, anexe el extremo del recurso que desea recuperar.Then append the endpoint of the resource you want to retrieve. (Las rutas de acceso de recursos se muestran en la siguiente sección).(Resource paths are shown in the next section.)

Su URI de solicitud completa tendrá un aspecto similar a uno de estos ejemplos: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

Nota: Obtenga más información sobre la URL de raíz del servicio.Note: Learn more about the service root URL.

Rutas de acceso de recursos para las solicitudes GETResource paths for GET requests

Use las siguientes rutas de acceso de recursos para obtener páginas, secciones, grupos de secciones, blocs de notas, imágenes u otros recursos de archivos.Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

Colección de páginasPage collection

Obtenga páginas (metadatos) en todos los blocs de notas.Get pages (metadata) across all notebooks.

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


Obtenga páginas (metadatos) de una sección específica.Get pages (metadata) from a specific section.

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


La opción de cadena de consulta `search` solo está disponible para los blocs de notas de clientes.The `search` query string option is available for consumer notebooks only.

El criterio de ordenación predeterminado para páginas es lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

La consulta predeterminada expande la sección principal y selecciona y selecciona las propiedades id, name y self de la sección.The default query expands the parent section and selects the section's id, name, and self properties.

De forma predeterminada, solo se devuelven las 20 entradas principales para las solicitudes GET pages.By default, only the top 20 entries are returned for GET pages requests. Las solicitudes que no se especifican una opción de cadena de consulta superior devuelven un vínculo @odata.nextLink en la respuesta que puede usar para obtener las siguientes 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 la colección de páginas de una sección, use pagelevel para obtener el nivel de sangría de las páginas y su orden en la sección.For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

EjemploExample

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

Entidad de páginaPage entity

Obtenga los metadatos de una página específica.Get the metadata for a specific page.

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


Las páginas pueden expandir las propiedades parentNotebook y parentSection.Pages can expand the parentNotebook and parentSection properties.

La consulta predeterminada expande la sección principal y selecciona y selecciona las propiedades id, name y self de la sección.The default query expands the parent section and selects the section's id, name, and self properties.

Use pagelevel para obtener el nivel de sangría de la página y su orden en la sección principal.Use pagelevel to return the indentation level of the page and its order within its parent section.

EjemploExample

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

Vista previa de la páginaPage preview

Obtenga el contenido de vista previa de texto e imágenes de una página.Get text and image preview content for a page.

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


La respuesta JSON contiene el contenido de la vista previa, que puede usar para ayudar a los usuarios a identificar los elementos en la 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"
    }
  }
}

La propiedad previewText contiene un fragmento de texto de la página.The previewText property contains a text snippet from the page. Microsoft Graph devuelve frases completas, hasta un máximo de 300 caracteres.Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

Si la página tiene una imagen que puede usarse para crear una vista previa de la interfaz de usuario, la propiedad href en el objeto previewImageUrl contiene un vínculo a un recurso de imagen público que ya se ha autenticado.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, pre-authenticated image resource. Puede usar este vínculo en HTML.You can use this link in HTML. En caso contrario, href devuelve un valor nulo.Otherwise, href returns null.

EjemploExample

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

Contenido HTML de la páginaPage HTML content

Obtenga el contenido HTML de una página.Get the HTML content of a page.

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

(obtenga más información sobre contenido HTML devuelto)(learn more about returned HTML content)


Use la opción de cadena de consulta includeIDs=true para obtener ID generadas que se usan para actualizar la página.Use the includeIDs=true query string option to get generated IDs used to update the page.

Use la opción de cadena de consulta preAuthenticated=true para obtener las direcciones URL públicas para los recursos de imagen que están en la página.Use the preAuthenticated=true query string option to get public URLs to the image resources that are on the page. Las direcciones URL públicas son válidas durante una hora.The public URLs are valid for one hour.

Colección de secciónSection collection

Obtenga todas las secciones de todos los blocs de notas que posee el usuario, incluyendo las secciones en grupos de secciones anidados.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]


Obtenga todas las secciones que están directamente en un grupo de secciones específico.Get all sections that are directly under a specific section group.

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


Obtenga todas las secciones que están directamente en un bloc de notas específico.Get all sections that are directly under a specific notebook.

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


Las secciones pueden expandir las propiedades parentNotebook y parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

El criterio de ordenación predeterminado para secciones es name asc.The default sort order for sections is name asc.

La consulta predeterminada expande el bloc de notas principal y el grupo de secciones principal y selecciona y selecciona sus propiedades id, name y self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Entidad de secciónSection entity

Obtenga una sección específica.Get a specific section.

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


Las secciones pueden expandir las propiedades parentNotebook y parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

La consulta predeterminada expande el bloc de notas principal y el grupo de secciones principal y selecciona y selecciona sus propiedades id, name y self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Colección de SectionGroupSectionGroup collection

Obtenga todos los grupos de secciones de todos los blocs de notas que posee el usuario, incluyendo los grupos de secciones anidados.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]


Obtenga todos los grupos de secciones que están directamente en un bloc de notas específico.Get all section groups that are directly under a specific notebook.

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


Los grupos de secciones pueden expandir las propiedades sections, sectionGroups, parentNotebook y parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

El criterio de ordenación predeterminado para grupos de secciones es name asc.The default sort order for section groups is name asc.

La consulta predeterminada expande el bloc de notas principal y el grupo de secciones principal y selecciona y selecciona sus propiedades id, name y self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Entidad de SectionGroupSectionGroup entity

Obtenga un grupo de secciones específico.Get a specific section group.

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


Los grupos de secciones pueden expandir las propiedades sections, sectionGroups, parentNotebook y parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

La consulta predeterminada expande el bloc de notas principal y el grupo de secciones principal y selecciona y selecciona sus propiedades id, name y self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Colección de blocs de notasNotebook collection

Obtenga todos los blocs de notas que posee el usuario.Get all the notebooks that are owned by the user.

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


Los blocs de notas pueden expandir las propiedades sections y sectionGroups.Notebooks can expand the sections and sectionGroups properties.

El criterio de ordenación predeterminado para blocs de notas es name asc.The default sort order for notebooks is name asc.

Entidad de bloc de notasNotebook entity

Obtenga un bloc de notas específico.Get a specific notebook.

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


Los blocs de notas pueden expandir las propiedades sections y sectionGroups.Notebooks can expand the sections and sectionGroups properties.

Imágenes u otros recursos de archivoImage or other file resource

Acceda a los datos binarios de un recurso específico.Get the binary data of a specific resource.

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


Puede encontrar el URI del recurso de archivo en el resultado HTML de la página.You can find the file's resource URI in the page's output HTML.

Por ejemplo, una etiqueta img incluye extremos del recurso de imagen original en el atributo data-fullres-src y de la imagen optimizada en el 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.

EjemploExample

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

Una etiqueta object incluye el extremo del recurso de archivos en el atributo data.And an object tag includes the endpoint for the file resource in the data attribute.

EjemploExample

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

Para obtener direcciones URL públicas que ya se han autenticado a los recursos de imagen en una página, incluya preAuthenticated=true en la cadena de consulta cuando recupere el contenido de la página (ejemplo: GET ../pages/{page-id}/content?preAuthenticated=true).To get public, pre-authenticated URLs to the image resources on a page, include preAuthenticated=true in the query string when you retrieve the page content (example: GET ../pages/{page-id}/content?preAuthenticated=true). Las direcciones URL públicas que se devuelven en el HTML de salida son válidas durante una hora.The public URLs that are returned in the output HTML are valid for one hour. Sin esta etiqueta, las imágenes devueltas no se representarán directamente en un explorador porque son privadas y se necesita una autorización para recuperarlas, al igual que el contenido de la página.Without this flag, retrieved images won't render directly in a browser because they are private and require authorization to retrieve them, like the rest of the page contents.

Nota: no se admite la obtención de una colección de recursos.Note: Getting a collection of resources is not supported.

Cuando obtiene un recurso de archivos, no es necesario incluir un tipo de contenido Accept en la solicitud.When you get a file resource, you don't need to include an Accept content type in the request.

Para obtener más información sobre las solicitudes GET, consulte los siguientes recursos en la referencia de la API de REST de Microsoft Graph:For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

Solicitudes GET de ejemploExample GET requests

Puede consultar las entidades de OneNote y el contenido de la página de búsqueda para obtener solo la información que necesita.You can query for OneNote entities and search page content to get just the information you need. Los siguientes ejemplos muestran algunas formas en las que puede usar opciones de cadena de consulta compatibles en las solicitudes GET a Microsoft Graph.The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

Recuerde:Remember:

  • Todas las solicitudes GET empiezan con la dirección URL raíz de servicio.All GET requests start with the service root URL.

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

  • Los espacios en la cadena de consulta URL deben usar la codificación %20.Spaces in the URL query string must use %20 encoding.

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

  • Los nombres de propiedad y las comparaciones de cadenas de OData distinguen mayúsculas de minúsculas.Property names and OData string comparisons are case-sensitive. Se recomienda usar la función tolower de OData para comparaciones de cadenas.We recommend using the OData tolower function for string comparisons.

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

search & filtersearch & filter

Obtenga todas las páginas que contienen el término receta creadas por una aplicación específica (search solo está disponible para blocs de notas de cliente).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 & selectsearch & select

Obtenga el título, los vínculos de cliente de OneNote y el vínculo de contentUrl para todas las páginas que contienen el término golgi app (search solo está disponible para blocs de notas de cliente).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

Obtenga todos los blocs de notas y expanda sus secciones y grupos de secciones.Get all notebooks and expand their sections and section groups.

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

Obtienen un grupo de secciones específico y expanden sus secciones y grupos de secciones.Get a specific section group and expand its sections and section groups.

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

Obtenga una página y expanda su sección principal y bloc de notas principal.Get a page and expand its parent section and parent notebook.

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

expand (varios niveles)expand (multiple levels)

Obtenga todos los blocs de notas y expanda sus secciones y grupos de secciones, y expanden todas las secciones en cada grupo de secciones.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)

Nota: No se admite expandir elementos primarios de entidades secundarias o expandir elementos secundarios de entidades primarias. Hacer eso crearía una referencia circular.Note: Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand & select (varios niveles)expand & select (multiple levels)

Obtenga el nombre y el vínculo a self para un grupo de secciones específico, y obtenga el nombre y los vínculos a self para todas sus secciones.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

Obtienen el nombre y el vínculo a self para todas las secciones, y obtienen el nombre y la hora de creación del bloc de notas primario de cada sección.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

Obtenga el título y el identificador de todas las páginas, y obtenga el nombre de la sección principal y bloc de notas principal.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 & levels (varios niveles)expand & levels (multiple levels)

Obtenga todos los blocs de notas, grupos de secciones y todas las secciones.Get all notebooks, sections, and section groups.

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

filterfilter

Obtenga todas las secciones creadas en octubre 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

Obtenga todas las páginas creadas por una aplicación específica desde el 1 de enero 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 & expandfilter & expand

Obtenga todas las páginas de un bloc de notas específico.Get all pages in a specific notebook. La API devuelve 20 entradas de forma predeterminada.The API returns 20 entries by default.

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

Obtenga el nombre y el vínculo a pagesUrl para todas las secciones del bloc de notas Escuela.Get the name and pagesUrl link for all sections from the School notebook. Las comparaciones de cadenas OData distinguen mayúsculas de minúsculas, por lo que se recomienda usar la función tolower.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 & orderbyfilter & select & orderby

Obtenga el nombre y el vínculo a pagesUrl para todas las secciones que contienen el término spring en el nombre de la sección.Get the name and pagesUrl link for all sections that contain the term spring in the section name. Ordene las secciones por fecha de última modificación.Order sections by last modified date.

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

orderbyorderby

Obtenga las primeras 20 páginas ordenadas por propiedad createdByAppId y luego por fecha de creación más reciente.Get the first 20 pages ordered by createdByAppId property and then by most recent created time. La API devuelve 20 entradas de forma predeterminada.The API returns 20 entries by default.

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

search & filter & topsearch & filter & top

Obtenga las cinco páginas más recientes creadas desde el 1 de enero de 2015, que contienen la frase división de celda.Get the five newest pages created since January 1, 2015 that contain the phrase cell division. La API devuelve 20 entradas de forma predeterminada con un máximo de 100.The API returns 20 entries by default with a maximum of 100. La ordenación predeterminada para las páginas es lastModifiedTime desc (search solo está disponible para los blocs de notas de cliente).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 & skipsearch & filter & top & skip

Obtenga las siguientes cinco páginas del conjunto de resultados (search solo está disponible para los blocs de notas de cliente).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

Y las cinco siguientes (search solo está disponible para los blocs de notas de clientes)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

Nota: Si se aplican search y filter a la misma solicitud, los resultados incluyen solamente las entidades que coinciden con ambos criterios.Note: If both search and filter are applied to the same request, the results include only those entities that match both criteria.

selectselect

Obtenga el nombre, la hora de creación y el vínculo a self para todas las secciones en los blocs de notas del usuario.Get the name, created time, and self link for all sections in the user's notebooks.

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

Obtenga el título, la hora de creación y los vínculos a clientes de OneNote para una 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 & filter (varios niveles)select & expand & filter (multiple levels)

Obtenga el nombre y el vínculo a pagesUrl para todas las secciones en el bloc de notas predeterminado del usuario.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 & orderbytop & select & orderby

Obtenga el título y el vínculo self de las primeras 50 páginas, ordenadas alfabéticamente por título.Get the title and self link for the first 50 pages, ordered alphabetically by title. La API devuelve 20 entradas de forma predeterminada con un máximo de 100.The API returns 20 entries by default with a maximum of 100. El criterio de ordenación predeterminado para páginas es lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

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

skip & top & select & orderbyskip & top & select & orderby

Obtenga las páginas 51 a 100. La API devuelve 20 entradas de forma predeterminada con un máximo de 100.Get pages 51 to 100. The API returns 20 entries by default with a maximum of 100.

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

Note: Las solicitudes GET para páginas que recuperan el número predeterminado de entradas (es decir, no especifican una expresión top) devuelven un vínculo a **@odata.nextLink** en la respuesta que puede usar para obtener las 20 entradas siguientes.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.

Opciones de cadena de consultas OData admitidasSupported OData query string options

Al enviar solicitudes GET a Microsoft Graph, puede usar las opciones de cadena de consultas OData para personalizar la consulta y obtener solo la información que necesita.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. También puede mejorar el rendimiento al reducir el número de llamadas al servicio y el tamaño de la carga de respuesta.They can also improve performance by reducing the number of calls to the service and the size of the response payload.

Note: Para su legibilidad, los ejemplos de este artículo no usan la codificación porcentual de %20 que se requiere para espacios en la cadena de consulta 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

Opción de consultaQuery option Ejemplo y descripciónExample and description
countcount

count=true

El recuento de entidades de la colección. El valor se devuelve en la propiedad **@odata.count** de la respuesta.The count of entities in the collection. The value is returned in the **@odata.count** property in the response.

expandexpand

expand=sections,sectionGroups

Las propiedades de navegación para devolver la respuesta en línea.The navigation properties to return inline in the response. Las siguientes propiedades son compatibles con las expresiones expand:The following properties are supported for expand expressions:
- Páginas: parentNotebook, parentSection- Pages: parentNotebook, parentSection
- Secciones: parentNotebook, parentSectionGroup- Sections: parentNotebook, parentSectionGroup
- Grupos de secciones: sections, sectionGroups, parentNotebook, parentSectionGroup- Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
- Blocs de notas: sections, sectionGroups- Notebooks: sections, sectionGroups

De forma predeterminada, las solicitudes GET para páginas expanden parentSection y seleccionan las propiedades id, name y self de la sección. Las solicitudes GET predeterminadas para secciones y grupos de secciones expanden tanto parentNotebook como parentSectionGroup, y seleccionan las propiedades id, name y self del elemento primario.By default, GET requests for pages expands parentSection and select the section's id, name, and self properties. Default GET requests for sections and section groups expand both parentNotebook and parentSectionGroup, and select the parents' id, name, and self properties.

Puede usarse para una única entidad o una colección.Can be used for a single entity or a collection.
Separe las distintas propiedades mediante comas.Separate multiple properties with commas.
Los nombres de las propiedades distinguen mayúsculas de minúsculas.Property names are case-sensitive.

filterfilter

filter=isDefault eq true

Una expresión booleana por si desea incluir una entrada en el conjunto de resultados.A Boolean expression for whether to include an entry in the result set. Es compatible con las funciones y operadores de OData siguientes:Supports the following OData operators and functions:
- Operadores de comparación: 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
- Funciones de cadena: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat- String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

Los nombres de propiedad y las comparaciones de cadenas de OData distinguen mayúsculas de minúsculas.Property names and OData string comparisons are case-sensitive. Se recomienda usar la función tolower de OData para comparaciones de cadenas.We recommend using the OData tolower function for string comparisons.

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

orderbyorderby

orderby=title,createdTime desc

Las propiedades según las cuales ordenar, con un asc opcional (predeterminado) u orden desc. Puede ordenar según cualquier propiedad de la entidad en la colección solicitada.The properties to sort by, with an optional asc (default) or desc sort order. You can sort by any property of the entity in the requested collection.

El orden predeterminado para blocs de notas, secciones y grupos de secciones es name asc, y para páginas es lastModifiedTime desc (última página modificada primero).The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

Si tiene varias propiedades, sepárelas con comas, y ordénelas de la manera en que desea que se apliquen.Separate multiple properties with commas, and list them in the order that you want them applied. Los nombres de las propiedades distinguen mayúsculas de minúsculas.Property names are case-sensitive.

buscarsearch

search=cell div

Solo está disponible para los blocs de notas de clientes.Available for consumer notebooks only.

El término o la frase para buscar en el título de la página, el cuerpo de la página, el texto alternativo de la imagen y el texto OCR de la imagen. De forma predeterminada, las consultas de búsqueda devuelven resultados ordenados por relevancia.The term or phrase to search for in the page title, page body, image alt text, and image OCR text. By default, search queries return results sorted by relevance.

OneNote usa la búsqueda de texto completo de Bing para admitir búsqueda de frases, lematización, omisión ortográfica, relevancia y clasificación, separación de palabras, varios idiomas y otras características de búsqueda 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. Las cadenas de búsqueda distinguen mayúsculas de minúsculas.Search strings are case-insensitive.

Solo se aplica a las páginas de los blocs de notas que posee el usuario.Applies only to pages in notebooks owned by the user. El contenido indexado es privado y solo puede acceder a él su propietario.Indexed content is private and can only be accessed by the owner. Las páginas protegidas con contraseña no están indexadas.Password-protected pages are not indexed. Solo se aplica al extremo pages.Applies only to the pages endpoint.

selectselect

select=id,title

Las propiedades que se devuelven.The properties to return. Puede usarse para una única entidad o para una colección.Can be used for a single entity or for a collection. Separe las distintas propiedades mediante comas.Separate multiple properties with commas. Los nombres de las propiedades distinguen mayúsculas de minúsculas.Property names are case-sensitive.

skipskip

skip=10

El número de entradas que se omiten del conjunto de resultados.The number of entries to skip in the result set. Se usa normalmente para los resultados de paginación.Typically used for paging results.

toptop

top=50

El número de entradas para devolver en el conjunto de resultados, hasta un máximo de 100.The number of entries to return in the result set, up to a maximum of 100. El valor predeterminado es 20.The default value is 20.

Microsoft Graph también proporciona la opción de cadena de consulta pagelevel que puede usar para obtener el nivel y el orden de las páginas en la sección principal.Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. Solo se aplica a las consultas para las páginas de una sección específica o para una página específica.Applies only to queries for pages in a specific section or queries for a specific page.

EjemplosExamples

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

Operadores y funciones OData compatiblesSupported OData operators and functions

Microsoft Graph admite los siguientes operadores y funciones OData en las expresiones filter.Microsoft Graph supports the following OData operators and functions in filter expressions. Al usar expresiones OData, recuerde:When using OData expressions, remember:

  • Debe reemplazar los espacios en la cadena de consulta URL con la codificación %20.Spaces in the URL query string must be replaced with the %20 encoding.

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

  • Los nombres de propiedad y las comparaciones de cadenas de OData distinguen mayúsculas de minúsculas.Property names and OData string comparisons are case-sensitive. Se recomienda usar la función tolower de OData para comparaciones de cadenas.We recommend using the OData tolower function for string comparisons.

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

Operador de comparaciónComparison operator EjemploExample
eqeq
(igual a)(equal to)
createdByAppId eq '{app-id}'
nene
(no es igual a)(not equal to)
userRole ne 'Owner'
gtgt
(mayor que)(greater than)
createdTime gt 2014-02-23
gege
(mayor o igual que)(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 o igual que)(less than or equal to)
lastModifiedTime le 2014-02-23

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

| Función StringString function | EjemploExample | |------|------| | 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'` |

Propiedades de entidad de OneNoteOneNote entity properties

Las expresiones de consulta filter, select, expand y orderby pueden incluir propiedades de las entidades de OneNote.The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

EjemploExample

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

Los nombres de las propiedades distinguen mayúsculas de minúsculas en las expresiones de consulta.Property names are case-sensitive in query expressions.

Para obtener la lista de propiedades y los tipos de propiedades, consulte los siguientes recursos en la referencia de la API de REST de Microsoft Graph:For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

La opción de cadena de consulta expand se puede usar con las siguientes propiedades de navegación:The expand query string option can be used with the following navigation properties:

  • Páginas: parentNotebook, parentSectionPages: parentNotebook, parentSection
  • Secciones: parentNotebook, parentSectionGroupSections: parentNotebook, parentSectionGroup
  • Grupos de secciones: sections, sectionGroups, parentNotebook, parentSectionGroupSection groups: sections, sectionGroups, parentNotebook, parentSectionGroup
  • Blocs de notas: sections, sectionGroupsNotebooks: sections, sectionGroups

Información de la solicitud y respuesta para las solicitudes GETRequest and response information for GET requests

Datos de solicitudRequest data DescripciónDescription
ProtocoloProtocol Todas las solicitudes usan el protocolo HTTPS SSL/TLS.All requests use the SSL/TLS HTTPS protocol.
Encabezado AuthorizationAuthorization header

Bearer {token}, donde {token} es un token de acceso de OAuth 2.0 válido para la aplicación registrada.Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

Si falta o no es válido, la solicitud producirá errores con el código de estado 401.If missing or invalid, the request fails with a 401 status code. Vea Authentication and permissions (Autenticación y permisos).See Authentication and permissions.

Encabezado AcceptAccept header

application/json para las entidades y los conjuntos de entidades de OneNoteapplication/json for OneNote entities and entity sets

text/html para contenido de la páginatext/html for page content


Datos de respuestaResponse data DescripciónDescription
Código de correctoSuccess code Un código de estado HTTP 200.A 200 HTTP status code.
Cuerpo de la respuestaResponse body Una representación de OData de la entidad o entidad establecida en formato JSON, el HTML de la página, o datos binarios recursos de un recurso de archivo.An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
ErroresErrors Si se produce un error en la solicitud, la API devuelve errors en el objeto **@api.diagnostics** en el cuerpo de la respuesta.If the request fails, the API returns errors in the **@api.diagnostics** object in the response body.
Encabezado X-CorrelationIdX-CorrelationId header GUID que identifica la solicitud de forma única.A GUID that uniquely identifies the request. Puede usar este valor junto con el valor del encabezado de fecha al trabajar con el soporte técnico de 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.

Crear la dirección URL raíz del servicio de notas de Microsoft GraphConstructing the Microsoft Graph notes service root URL

La dirección URL raíz de notas de Microsoft Graph usa el siguiente formato para todas las llamadas a las notas de 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/

El segmento version de la URL representa la versión de Microsoft Graph que se quiere utilizar.The version segment in the URL represents the version of Microsoft Graph that you want to use. Use v1.0 para código de producción estable.Use v1.0 for stable production code. Use beta para probar una característica que esté en desarrollo.Use beta to try out a feature that's in development. Las características y la funcionalidad de la versión beta pueden cambiar, por lo que no se debe usar en el código de producción.Features and functionality in beta may change, so you shouldn't use it in your production code.

Use me para contenido de OneNote al que puede obtener acceso el usuario actual (contenido compartido y del que sea propietario).Use me for OneNote content that the current user can access (owned and shared). Use users/{id} para contenido de OneNote que el usuario especificado (en la URL) compartió con el usuario actual.Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Use Microsoft Graph para obtener identificadores de usuario.Use Microsoft Graph to get user IDs.

Permisos de solicitudes GETPermissions for GET requests

Para obtener el contenido o la estructura de OneNote, debe solicitar los permisos adecuados.To get OneNote content or structure, you'll need to request appropriate permissions.

Los siguientes ámbitos permiten obtener solicitudes a Microsoft Graph.The following scopes allow GET requests to Microsoft Graph. Elija el nivel más bajo de permisos que necesita la aplicación para hacer su trabajo.Choose the lowest level of permissions that your app needs to do its work.

Elija entre:Choose from:

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

Para obtener más información sobre los ámbitos de permiso y cómo funcionan, vea Referencias de permisos de Microsoft Graph.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Vea tambiénSee also