Extraction du contenu et de la structure OneNote avec Microsoft GraphGet OneNote content and structure with Microsoft Graph

**S’applique à ** blocs-notes consommateur sur OneDrive | Blocs-notes d’entreprise sur Office 365Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Pour obtenir la structure et le contenu OneNote, vous envoyez une requête GET au point de terminaison cible.To get OneNote content and structure, you send a GET request to the target endpoint. Par exemple :For example:

GET ../onenote/pages/{id}

Si la demande réussit, Microsoft Graph renvoie un code d’état HTTP 200 et les entités ou le contenu que vous avez demandés.If the request is successful, Microsoft Graph returns a 200 HTTP status code and the entities or content that you requested. Les entités OneNote sont renvoyées sous forme d’objets JSON conformes à la spécification de la version 4.0 de OData.OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

Vous pouvez filtrer vos requêtes et améliorer les performances à l’aide des options de chaîne de requête.By using query string options, you can filter your queries and improve performance.

Construire l’URI de la requêteConstruct the request URI

Pour construire l’URI de la requête, commencez avec l’URL racine du service :To construct the request URI, start with the service root URL:

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


Ajoutez ensuite le point de terminaison de la ressource que vous souhaitez récupérer.Then append the endpoint of the resource you want to retrieve. (Les chemins d’accès aux ressources sont indiqués dans la section suivante.)(Resource paths are shown in the next section.)

L’URI complète de votre requête ressemble à l’un de ces exemples :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

Remarque : en savoir plus sur l’URL racine du service.Note: Learn more about the service root URL.

Chemins d’accès aux ressources pour les requêtes GETResource paths for GET requests

Utilisez les chemins d’accès aux ressources suivants pour obtenir des pages, sections, groupes de sections, blocs-notes et ressources d’image ou de fichier.Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

Collection de pagesPage collection

Recherchez des pages (métadonnées) sur tous les blocs-notes.Get pages (metadata) across all notebooks.

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


Recherchez des pages (métadonnées) dans une section spécifique.Get pages (metadata) from a specific section.

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


L’option de chaîne de requête `search` est disponible pour les blocs-notes consommateur uniquement.The `search` query string option is available for consumer notebooks only.

L’ordre de tri par défaut pour les pages est lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

La requête par défaut développe la section parent et sélectionne les propriétés id, name et self de la section.The default query expands the parent section and selects the section's id, name, and self properties.

Par défaut, seules les 20 premières entrées sont renvoyées pour les requêtes Obtenir des pages.By default, only the top 20 entries are returned for GET pages requests. Les requêtes qui ne spécifient pas une option de chaîne de requête top renvoient un lien @odata.nextLink dans la réponse que vous pouvez utiliser pour obtenir les 20 entrées suivantes.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.

Pour la collection de pages dans une section, utilisez pagelevel pour renvoyer le niveau de retrait des pages et leur ordre dans la section.For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

ExempleExample

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

Entité PagePage entity

Obtenez les métadonnées pour une page spécifique.Get the metadata for a specific page.

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


Les pages peuvent développer les propriétés parentNotebook et parentSection.Pages can expand the parentNotebook and parentSection properties.

La requête par défaut développe la section parent et sélectionne les propriétés id, name et self de la section.The default query expands the parent section and selects the section's id, name, and self properties.

Utilisez pagelevel pour renvoyer le niveau de retrait de la page et son ordre dans sa section parent.Use pagelevel to return the indentation level of the page and its order within its parent section.

ExempleExample

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

Aperçu de la pagePage preview

Recherchez le contenu texte et image de prévisualisation pour une page.Get text and image preview content for a page.

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


La réponse JSON contient le contenu de prévisualisation, que vous pouvez utiliser pour aider les utilisateurs à identifier les éléments contenus dans la page.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 propriété previewText contient un extrait de texte de la page.The previewText property contains a text snippet from the page. Microsoft Graph renvoie des phrases complètes, jusqu’à un maximum de 300 caractères.Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

Si la page comporte une image qui peut être utilisée pour créer une interface utilisateur de prévisualisation, la propriété href dans l’objet previewImageUrl contient un lien vers une ressource image publique, déjà authentifiée.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. Vous pouvez utiliser ce lien dans du code HTML.You can use this link in HTML. Sinon, href renvoie la valeur null.Otherwise, href returns null.

ExempleExample

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

Contenu HTML de la pagePage HTML content

Recherchez le contenu HTML d’une page.Get the HTML content of a page.

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

(en savoir plus sur le contenu HTML renvoyé)(learn more about returned HTML content)


Utilisez l’option de chaîne de requête includeIDs = true pour obtenir des ID générés utilisés pour mettre à jour la page.Use the includeIDs=true query string option to get generated IDs used to update the page.

Utilisez l’option de chaîne de requête preAuthenticated=true pour obtenir des URL publiques vers les ressources image qui se trouvent sur la page.Use the preAuthenticated=true query string option to get public URLs to the image resources that are on the page. Les URL publiques sont valides pendant une heure.The public URLs are valid for one hour.

Collection de sectionsSection collection

Recherchez toutes les sections de tous les blocs-notes appartenant à l’utilisateur, y compris les sections contenues dans des groupes de sections imbriqués.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]


Recherchez toutes les sections qui sont directement sous un groupe de sections spécifique.Get all sections that are directly under a specific section group.

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


Recherchez toutes les sections qui sont directement sous un bloc-notes spécifique.Get all sections that are directly under a specific notebook.

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


Les sections peuvent développer les propriétés parentNotebook et parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

L’ordre de tri par défaut pour les sections est name asc.The default sort order for sections is name asc.

La requête par défaut développe le bloc-notes parent et le groupe de sections parent et sélectionne les propriétés id, name et self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Entité SectionSection entity

Recherchez une section spécifique.Get a specific section.

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


Les sections peuvent développer les propriétés parentNotebook et parentSectionGroup.Sections can expand the parentNotebook and parentSectionGroup properties.

La requête par défaut développe le bloc-notes parent et le groupe de sections parent et sélectionne les propriétés id, name et self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Collection de groupes de sectionsSectionGroup collection

Recherchez tous les groupes de sections de tous les blocs-notes appartenant à l’utilisateur, y compris les groupes de sections imbriqués.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]


Recherchez tous les groupes de sections qui sont directement sous un bloc-notes spécifique.Get all section groups that are directly under a specific notebook.

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


Les groupes de sections peuvent développer les propriétés sections, sectionGroups, parentNotebook et parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

L’ordre de tri par défaut pour les groupes de sections est name asc.The default sort order for section groups is name asc.

La requête par défaut développe le bloc-notes parent et le groupe de sections parent et sélectionne les propriétés id, name et self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Entité SectionGroupSectionGroup entity

Recherchez un groupe de sections spécifique.Get a specific section group.

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


Les groupes de sections peuvent développer les propriétés sections, sectionGroups, parentNotebook et parentSectionGroup.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

La requête par défaut développe le bloc-notes parent et le groupe de sections parent et sélectionne les propriétés id, name et self.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Collection de blocs-notesNotebook collection

Recherchez tous les blocs-notes appartenant à l’utilisateur.Get all the notebooks that are owned by the user.

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


Les blocs-notes peuvent développer les propriétés sections et sectionGroups.Notebooks can expand the sections and sectionGroups properties.

L’ordre de tri par défaut pour les bloc-notes est name asc.The default sort order for notebooks is name asc.

Entité NotebookNotebook entity

Recherchez un bloc-notes spécifique.Get a specific notebook.

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


Les blocs-notes peuvent développer les propriétés sections et sectionGroups.Notebooks can expand the sections and sectionGroups properties.

Ressource image ou autre ressource de fichierImage or other file resource

Recherchez les données binaires d’une ressource spécifique.Get the binary data of a specific resource.

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


Vous pouvez trouver l’URI de ressource du fichier dans le code HTML de sortie de la page.You can find the file's resource URI in the page's output HTML.

Par exemple, une balise img inclut des points de terminaison pour l’image d’origine dans l’attribut data-fullres-src et l’image optimisée dans l’attribut 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.

ExempleExample

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

Une balise object inclut le point de terminaison pour la ressource de fichier dans l’attribut data.And an object tag includes the endpoint for the file resource in the data attribute.

ExempleExample

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

Pour obtenir les URL publiques, déjà authentifiées, vers les ressources d’image sur une page, incluez l’élément preAuthenticated=true dans la chaîne de requête lorsque vous extrayez le contenu de la page (exemple : 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). Les URL publiques renvoyées dans le code HTML de sortie sont valides pendant une heure.The public URLs that are returned in the output HTML are valid for one hour. Sans cet indicateur, les images extraites ne s’afficheront pas directement dans un navigateur, car, à l’instar du reste du contenu de la page, elles sont privées et une autorisation est requise pour pouvoir les récupérer.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.

Remarque : l’obtention d’une collection de ressources n’est pas prise en charge.Note: Getting a collection of resources is not supported.

Lorsque vous obtenez une ressource de fichier, vous n’avez pas besoin d’inclure un type de contenu Acceptdans la requête.When you get a file resource, you don't need to include an Accept content type in the request.

Pour plus d’informations sur les demandes GET, consultez les ressources suivantes dans la référence Microsoft Graph API REST :For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

Exemple de requêtes GETExample GET requests

Vous pouvez effectuer une requête sur des entités OneNote et rechercher un contenu de page pour obtenir simplement les informations dont vous avez besoin.You can query for OneNote entities and search page content to get just the information you need. Les exemples suivants présentent certaines façons d’utiliser des options de chaîne de requête prises en charge dans des requêtes GET à Microsoft Graph.The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

Rappel :Remember:

  • toutes les requêtes GET commencent par l’URL racine du service.All GET requests start with the service root URL.

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

  • Les espaces dans la chaîne de requête d’URL doivent utiliser le codage %20.Spaces in the URL query string must use %20 encoding.

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

  • Les noms de propriété et les comparaisons de chaînes OData sont sensibles à la casse.Property names and OData string comparisons are case-sensitive. Nous vous recommandons d’utiliser la fonction tolower OData pour les comparaisons de chaînes.We recommend using the OData tolower function for string comparisons.

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

search et filtersearch & filter

Obtenez toutes les pages contenant le terme recipe qui ont été créées par une application spécifique (search est uniquement disponible pour les blocs-notes consommateur).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 et selectsearch & select

Obtenez le titre, les liens du client OneNote et le lien contentUrl pour toutes les pages contenant le terme golgi app (search est également disponible pour les blocs-notes consommateur uniquement).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

Obtenez tous les blocs-notes, puis développez les sections et les groupes de sections.Get all notebooks and expand their sections and section groups.

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

Obtenez un groupe de sections spécifique, puis développez les sections et les groupes de sections.Get a specific section group and expand its sections and section groups.

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

Obtenez une page, puis développez sa section parent et son bloc-notes parent.Get a page and expand its parent section and parent notebook.

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

expand (plusieurs niveaux)expand (multiple levels)

Obtenez tous les blocs-notes et développez leurs sections et groupes de sections, puis développez toutes les sections dans chaque groupe de sections.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)

Remarque : le développement des parents d’entités enfant ou le développement d’enfants d’entités parent crée une référence circulaire et n’est pas pris en charge.Note: Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand & select (plusieurs niveaux)expand & select (multiple levels)

Obtenez le nom et le lien self d’un groupe de sections spécifique, puis obtenez le nom et les liens self de toutes ses sections.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

Obtenez le nom et le lien self de toutes les sections, puis obtenez le nom et l’heure de création du bloc-notes parent de chaque section.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

Obtenez le titre et l’ID de toutes les pages ; obtenez le nom de la section parent et du bloc-notes parent.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 (plusieurs niveaux)expand & levels (multiple levels)

Obtenez tous les blocs-notes, sections et groupes de sections.Get all notebooks, sections, and section groups.

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

filtrefilter

Obtenez toutes les sections créées en octobre 2014.Get all sections that were created in October 2014.

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

Obtenez les pages créées par une application spécifique depuis le 1er janvier 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 et expandfilter & expand

Obtenez toutes les pages dans un bloc-notes spécifique.Get all pages in a specific notebook. L’API renvoie 20 entrées par défaut.The API returns 20 entries by default.

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

Obtenez le nom et le lien pagesUrl de toutes les sections dans le bloc-notes School.Get the name and pagesUrl link for all sections from the School notebook. Les comparaisons de chaînes OData sont sensibles à la casse, par conséquent, il est recommandé d’utiliser la fonction 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 et orderbyfilter & select & orderby

Obtenez le nom et le lien pagesUrl de toutes les sections dont le nom contient le terme spring.Get the name and pagesUrl link for all sections that contain the term spring in the section name. Classez les sections par date de dernière modification.Order sections by last modified date.

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

orderbyorderby

Obtenez les 20 premières pages classées selon la propriété createdByAppId et par date de création la plus récente.Get the first 20 pages ordered by createdByAppId property and then by most recent created time. L’API renvoie 20 entrées par défaut.The API returns 20 entries by default.

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

search, filter et topsearch & filter & top

Obtenez les cinq dernières pages créées depuis le 1er janvier 2015 contenant l’expression cell division.Get the five newest pages created since January 1, 2015 that contain the phrase cell division. L’API renvoie 20 entrées par défaut avec un maximum de 100.The API returns 20 entries by default with a maximum of 100. L’ordre de tri par défaut pour les pages est lastModifiedTime desc (search est disponible pour les blocs-notes consommateur uniquement).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 et skipsearch & filter & top & skip

Recherchez les cinq prochaines pages dans le jeu de résultats (search est disponible pour les blocs-notes consommateur uniquement),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

puis les cinq suivants (search est disponible pour les blocs-notes consommateur uniquement).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

Remarque : si search et filter sont appliqués à la même requête, les résultats incluent seulement les entités satisfaisant aux deux critères.Note: If both search and filter are applied to the same request, the results include only those entities that match both criteria.

selectselect

Obtenez le nom, l’heure de création et le lien self de toutes les sections dans les blocs-notes de l’utilisateur.Get the name, created time, and self link for all sections in the user's notebooks.

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

Obtenez le titre, l’heure de création et les liens de client OneNote pour une page spécifique.Get the title, created time, and OneNote client links for a specific page.

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

select & expand & filter (plusieurs niveaux)select & expand & filter (multiple levels)

Obtenez le nom et le lien pagesUrl de toutes les sections dans le bloc-notes par défaut de l’utilisateur.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 et orderbytop & select & orderby

Obtenez le titre et le lien self pour les 50 premières pages, classées par titre, par ordre alphabétique.Get the title and self link for the first 50 pages, ordered alphabetically by title. L’API renvoie 20 entrées par défaut avec un maximum de 100.The API returns 20 entries by default with a maximum of 100. L’ordre de tri par défaut pour les pages est lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

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

skip, top, select et orderbyskip & top & select & orderby

Obtenez les pages 51 à 100. L’API renvoie 20 entrées par défaut avec un maximum 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

Remarque : les requêtes GET des pages qui récupèrent le nombre d’entrées par défaut (c’est-à-dire, qui ne spécifient pas d’expression top) renvoient un lien **@odata.nextLink** dans la réponse que vous pouvez utiliser pour obtenir les 20 entrées suivantes.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.

Options de chaîne de requête OData prises en chargeSupported OData query string options

Lorsque vous envoyez des requêtes GET à Microsoft Graph, vous pouvez utiliser les options de chaîne de requête OData pour personnaliser votre requête et obtenir simplement les informations dont vous avez besoin.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. Elles peuvent également améliorer les performances en réduisant le nombre d’appels au service et la taille de la charge utile de la réponse.They can also improve performance by reducing the number of calls to the service and the size of the response payload.

Remarque : pour favoriser la lisibilité, les exemples de cet article ne contiennent pas l’encodage de pourcentage %20 requis pour les espaces dans la chaîne de requête de l’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

Option de requêteQuery option Exemple et descriptionExample and description
countcount

count=true

Décompte des entités de la collection. La valeur est renvoyée dans la propriété **@odata.count** de la réponse.The count of entities in the collection. The value is returned in the **@odata.count** property in the response.

expandexpand

expand=sections,sectionGroups

Les propriétés de navigation à renvoyer incorporées dans la réponse.The navigation properties to return inline in the response. Les propriétés suivantes sont prises en charge pour les expressions expand :The following properties are supported for expand expressions:
- Pages : parentNotebook, parentSection- Pages: parentNotebook, parentSection
- Sections : parentNotebook, parentSectionGroup- Sections: parentNotebook, parentSectionGroup
- Groupes de sections : sections, sectionGroups, parentNotebook, parentSectionGroup- Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
- Blocs-notes : sections, sectionGroups- Notebooks: sections, sectionGroups

Par défaut, les requêtes GET de pages développent parentSection et sélectionnent les propriétés id, name et self de la section. Les requêtes GET par défaut pour les sections et groupes de sections développent à la fois parentNotebook et parentSectionGroup, puis sélectionnent les propriétés id, name et self des parents.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.

Utilisable pour une seule entité ou collection.Can be used for a single entity or a collection.
Séparez les propriétés multiples à l’aide de virgules.Separate multiple properties with commas.
Les noms des propriétés sont sensibles à la casse.Property names are case-sensitive.

filtrefilter

filter=isDefault eq true

Expression booléenne indiquant d’inclure ou non une entrée dans le jeu de résultats.A Boolean expression for whether to include an entry in the result set. Prend en charge les fonctions et opérateurs OData suivants :Supports the following OData operators and functions:
- Opérateurs de comparaison : eq, ne, gt, ge, lt, le- Comparison operators: eq, ne, gt, ge, lt, le
- Opérateurs logiques : and, or, not- Logical operators: and, or, not
- Fonctions de chaîne : contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat- String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

Les noms de propriété et les comparaisons de chaînes OData sont sensibles à la casse.Property names and OData string comparisons are case-sensitive. Nous vous recommandons d’utiliser la fonction tolower OData pour les comparaisons de chaînes.We recommend using the OData tolower function for string comparisons.

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

orderbyorderby

orderby=title,createdTime desc

Propriétés régissant l’ordre de tri, avec un ordre de tri facultatif **asc** (défaut) ou **desc**. Vous pouvez trier selon n’importe quelle propriété de l’entité dans la collection demandée.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.

L’ordre de tri par défaut pour les blocs-notes, les groupes de sections et les sections est name asc. Pour les pages, il s’agit de lastModifiedTime desc (en partant de la dernière page modifiée).The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

Séparez les propriétés par des virgules et indiquez-les dans l’ordre dans lequel vous souhaitez les appliquer.Separate multiple properties with commas, and list them in the order that you want them applied. Les noms des propriétés sont sensibles à la casse.Property names are case-sensitive.

recherchesearch

search=cell div

Disponible pour les blocs-notes consommateur uniquement.Available for consumer notebooks only.

Terme ou expression à rechercher dans le titre de la page, le corps de la page, le texte de remplacement de l’image et le texte de reconnaissance optique de caractères de l’image. Par défaut, les requêtes de recherche renvoient des résultats triés par pertinence.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 utilise la recherche en texte intégral Bing pour la prise en charge de la recherche d’une phrase, la recherche de radical, la tolérance orthographique, la pertinence et le classement, les césures, les langues multiples et d’autres fonctionnalités de recherche en texte intégral.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. Les chaînes de recherche sont sensibles à la casse.Search strings are case-insensitive.

S’applique uniquement aux pages de blocs-notes appartenant à l’utilisateur.Applies only to pages in notebooks owned by the user. Le contenu indexé est privé et est accessible par le propriétaire uniquement.Indexed content is private and can only be accessed by the owner. Les pages protégées par mot de passe ne sont pas indexées.Password-protected pages are not indexed. S’applique uniquement au point de terminaison pages.Applies only to the pages endpoint.

selectselect

select=id,title

Les propriétés à renvoyer.The properties to return. Utilisable pour une seule entité ou collection.Can be used for a single entity or for a collection. Séparez les propriétés multiples à l’aide de virgules.Separate multiple properties with commas. Les noms des propriétés sont sensibles à la casse.Property names are case-sensitive.

skipskip

skip=10

Nombre d’entrées à ignorer dans le jeu de résultats.The number of entries to skip in the result set. Généralement utilisé pour obtenir des résultats de pagination.Typically used for paging results.

toptop

top=50

Nombre d’entrées à renvoyer dans le jeu de résultats, jusqu’à un maximum de 100.The number of entries to return in the result set, up to a maximum of 100. La valeur par défaut est 20.The default value is 20.

Microsoft Graph fournit également l’option de chaîne de requête pagelevel que vous pouvez utiliser pour obtenir le niveau et l’ordre des pages dans la section parent.Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. S’applique uniquement aux requêtes pour les pages d’une section spécifique ou aux requêtes d’une page spécifique.Applies only to queries for pages in a specific section or queries for a specific page.

ExemplesExamples

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

Fonctions et opérateurs OData pris en chargeSupported OData operators and functions

Microsoft Graph prend en charge les fonctions et opérateurs OData suivants dans les expressions filter.Microsoft Graph supports the following OData operators and functions in filter expressions. Lorsque vous utilisez des expressions OData, gardez à l’esprit les points suivants :When using OData expressions, remember:

  • Les espaces dans la chaîne de requête d’URL doivent être remplacés par le codage %20.Spaces in the URL query string must be replaced with the %20 encoding.

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

  • Les noms de propriété et les comparaisons de chaînes OData sont sensibles à la casse.Property names and OData string comparisons are case-sensitive. Nous vous recommandons d’utiliser la fonction tolower OData pour les comparaisons de chaînes.We recommend using the OData tolower function for string comparisons.

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

Opérateur de comparaisonComparison operator ExempleExample
eqeq
(égal à)(equal to)
createdByAppId eq '{app-id}'
nene
(différent de)(not equal to)
userRole ne 'Owner'
gtgt
(supérieur à)(greater than)
createdTime gt 2014-02-23
gege
(supérieur ou égal à)(greater than or equal to)
lastModifiedTime ge 2014-05-05T07:00:00Z
ltlt
(inférieur à)(less than)
createdTime lt 2014-02-23
lele
(inférieur ou égal à)(less than or equal to)
lastModifiedTime le 2014-02-23

Opérateur logiqueLogical operator ExempleExample
etand createdTime le 2014-01-30 and createdTime gt 2014-01-23
ouor createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'
notnot not contains(tolower(title),'school')

| Fonction de chaîneString function | ExempleExample | |------|------| | 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'` |

Propriétés de l’entité OneNoteOneNote entity properties

Les expressions de requête filter, select, expand et orderby peuvent inclure des propriétés des entités OneNote.The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

ExempleExample

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

Les noms des propriétés sont sensibles à la casse dans les expressions de requête.Property names are case-sensitive in query expressions.

Pour la liste des propriétés et les types de propriété, consultez les ressources suivantes dans la référence Microsoft Graph API REST :For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

L’option de chaîne de requête expand peut être utilisée avec les propriétés de navigation suivantes :The expand query string option can be used with the following navigation properties:

  • Pages : parentNotebook, parentSectionPages: parentNotebook, parentSection
  • Sections : parentNotebook, parentSectionGroupSections: parentNotebook, parentSectionGroup
  • Groupes de sections : sections, sectionGroups, parentNotebook, parentSectionGroupSection groups: sections, sectionGroups, parentNotebook, parentSectionGroup
  • Blocs-notes : sections, sectionGroupsNotebooks: sections, sectionGroups

Informations de la requête et de la réponse pour les requêtes GETRequest and response information for GET requests

Données des requêtesRequest data DescriptionDescription
ProtocoleProtocol Toutes les demandes utilisent le protocole HTTPS SSL/TLS.All requests use the SSL/TLS HTTPS protocol.
En-tête AuthorizationAuthorization header

Bearer {token}, où {token} est un jeton d’accès OAuth 2.0 valide pour votre application inscrite.Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

En cas de jeton manquant ou non valide, la requête échoue et le code d’état 401 s’affiche.If missing or invalid, the request fails with a 401 status code. Consultez l’article relatif à l’authentification et aux autorisations.See Authentication and permissions.

En-tête AcceptAccept header

application/json pour les entités OneNote et les ensembles d’entitésapplication/json for OneNote entities and entity sets

text/html pour le contenu de pagetext/html for page content


Données de réponseResponse data DescriptionDescription
Code de succèsSuccess code Code d’état HTTP 200.A 200 HTTP status code.
Corps de la réponseResponse body Une représentation OData de l’entité ou de l’ensemble d’entités défini au format JSON, la page HTML ou les données binaires de la ressource de fichier.An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
ErreursErrors En cas d’échec de la requête, l’API renvoie des erreurs dans l’objet **@api.diagnostics** dans le corps de la réponse.If the request fails, the API returns errors in the **@api.diagnostics** object in the response body.
En-tête X-CorrelationIdX-CorrelationId header GUID qui permet d’identifier la requête de manière unique.A GUID that uniquely identifies the request. Vous pouvez utiliser cette valeur, ainsi que la valeur de l’en-tête Date, quand vous travaillez avec le Support Microsoft pour résoudre des problèmes.You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Construction de l’URL racine du service des notes Microsoft GraphConstructing the Microsoft Graph notes service root URL

L’URL racine des notes Microsoft Graph utilise le format suivant pour tous les appels effectués aux notes 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/

Le segment version dans l’URL représente la version de Microsoft Graph que vous souhaitez utiliser.The version segment in the URL represents the version of Microsoft Graph that you want to use. Utilisez v1.0 pour le code de production stable.Use v1.0 for stable production code. Utilisez beta pour tester une fonctionnalité en cours de développement.Use beta to try out a feature that's in development. Les fonctions et fonctionnalités en version bêta peuvent être sujettes à des modifications. Nous vous recommandons donc de ne pas les utiliser dans votre code de production.Features and functionality in beta may change, so you shouldn't use it in your production code.

Utilisez me pour le contenu OneNote auquel l’utilisateur actuel peut accéder (contenu propriétaire et partagé).Use me for OneNote content that the current user can access (owned and shared). Utilisez users/{id} pour le contenu OneNote que l’utilisateur spécifié (dans l’URL) a partagé avec l’utilisateur actuel.Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Utilisez Microsoft Graph pour obtenir les identifiants utilisateur.Use Microsoft Graph to get user IDs.

Autorisations pour les requêtes GETPermissions for GET requests

Pour obtenir créer la structure ou le contenu OneNote, demandez les autorisations appropriées.To get OneNote content or structure, you'll need to request appropriate permissions.

Les étendues suivantes autorisent les requêtes GET à Microsoft Graph.The following scopes allow GET requests to Microsoft Graph. Choisissez le niveau d’autorisation le plus faible requis par votre application pour faire son travail.Choose the lowest level of permissions that your app needs to do its work.

Choisissez parmi les autorisations suivantes :Choose from:

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

Pour en savoir plus sur les étendues d’autorisation et leur fonctionnement, consultez l’article Référence des autorisations de Microsoft Graph.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Voir aussiSee also