Abrufen von OneNote-Inhalten und -Strukturen mit Microsoft GraphGet OneNote content and structure with Microsoft Graph

Gilt für: Heimanwender-Notizbücher in OneDrive | Unternehmensnotizbücher in Office 365Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Um OneNote-Inhalte und -Strukturen abzurufen, senden Sie eine GET-Anforderung an den Zielendpunkt.To get OneNote content and structure, you send a GET request to the target endpoint. Beispiel:For example:

GET ../onenote/pages/{id}

Wenn die Anforderung erfolgreich ist, gibt Microsoft Graph den HTTP-Statuscode 200 und die Entitäten bzw. Inhalte zurück, die Sie angefordert haben.If the request is successful, Microsoft Graph returns a 200 HTTP status code and the entities or content that you requested. OneNote-Entitäten werden als JSON-Objekte zurückgegeben, die der Spezifikation der OData-Version 4.0 entsprechen.OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

Mithilfe von Abfragezeichenfolgenoptionen können Sie Ihre Abfragen filtern und die Leistung verbessern.By using query string options, you can filter your queries and improve performance.

Erstellen des Anforderungs-URIConstruct the request URI

Um den Anforderungs-URI zu erstellen, beginnen Sie mit der Stamm-URL des Diensts:To construct the request URI, start with the service root URL:

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


Fügen Sie dann den Endpunkt der Ressource an, die Sie abrufen möchten.Then append the endpoint of the resource you want to retrieve. (Ressourcenpfade werden im nächsten Abschnitt gezeigt.)(Resource paths are shown in the next section.)

Ihr vollständiger Anforderungs-URI gleicht einem der folgenden Beispiele: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

Hinweis: Hier erfahren Sie mehr über die Stamm-URL des Diensts.Note: Learn more about the service root URL.

Ressourcenpfade für GET-AnforderungenResource paths for GET requests

Verwenden Sie die folgenden Ressourcenpfade, um Seiten, Abschnitte, Abschnittsgruppen, Notizbücher und Bild- oder Dateiressourcen abzurufen.Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

SeitensammlungPage collection

Rufen Sie Seiten (Metadaten) aus allen Notizbüchern ab.Get pages (metadata) across all notebooks.

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


Rufen Sie Seiten (Metadaten) aus einem bestimmten Abschnitt ab.Get pages (metadata) from a specific section.

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


Die `search`-Abfragezeichenfolgenoption ist nur für Heimanwender-Notizbücher verfügbar.The `search` query string option is available for consumer notebooks only.

Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc.The default sort order for pages is lastModifiedTime desc.

Die Standardabfrage erweitert den übergeordneten Abschnitt und wählt die Eigenschaften id, name und self des Abschnitts aus.The default query expands the parent section and selects the section's id, name, and self properties.

Standardmäßig werden nur die ersten 20 Einträge für GET pages-Anforderungen zurückgegeben.By default, only the top 20 entries are returned for GET pages requests. Anforderungen, die keine top-Abfragezeichenfolgenoption enthalten, geben einen @odata.nextLink-Link in der Antwort zurück, mit dem Sie die nächsten 20 Einträge abrufen können.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.

Verwenden Sie für die Sammlung der Seiten in einem Abschnitt pagelevel, um die Einzugsebene von Seiten und ihre Reihenfolge innerhalb des Abschnitts zurückzugeben.For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

BeispielExample

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

SeitenentitätPage entity

Abrufen der Metadaten für eine bestimmte Seite.Get the metadata for a specific page.

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


Seiten können die Eigenschaften parentNotebook und parentSection erweitern.Pages can expand the parentNotebook and parentSection properties.

Die Standardabfrage erweitert den übergeordneten Abschnitt und wählt die Eigenschaften id, name und self des Abschnitts aus.The default query expands the parent section and selects the section's id, name, and self properties.

Verwenden Sie pagelevel, um die Einzugsebene der Seite und ihre Reihenfolge im übergeordneten Abschnitt zurückzugeben.Use pagelevel to return the indentation level of the page and its order within its parent section.

BeispielExample

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

SeitenvorschauPage preview

Rufen Sie Text- und Bild-Vorschauinhalt für eine Seite ab.Get text and image preview content for a page.

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


Die JSON-Antwort enthält den Vorschauinhalt, anhand dessen Benutzer feststellen können, was sich auf der Seite befindet.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"
    }
  }
}

Die previewText-Eigenschaft enthält einen Textausschnitt von der Seite.The previewText property contains a text snippet from the page. Microsoft Graph gibt vollständige Ausdrücke im Umfang von maximal 300 Zeichen zurück.Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

Wenn die Seite über ein Bild verfügt, das zum Erstellen einer Vorschau der Benutzeroberfläche verwendet werden kann, enthält die href-Eigenschaft im previewImageUrl-Objekt einen Link zu einer öffentlichen, vorab authentifizierten Bildressource.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. Sie können diesen Link in HTML-Code verwenden.You can use this link in HTML. Andernfalls gibt href NULL zurück.Otherwise, href returns null.

BeispielExample

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

HTML-Inhalt einer SeitePage HTML content

Rufen Sie den HTML-Code einer Seite ab.Get the HTML content of a page.

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

(Weitere Informationen zu zurückgegebenen HTML-Inhalten)(learn more about returned HTML content)


Verwenden Sie die Abfragezeichenfolgenoption includeIDs=true, um die zum Aktualisieren der Seite generierten IDs abzurufen.Use the includeIDs=true query string option to get generated IDs used to update the page.

AbschnittsammlungSection collection

Rufen Sie alle Abschnitte aus allen Notizbüchern im Besitz des Benutzers ab, einschließlich der Abschnitte in geschachtelten Abschnittsgruppen.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]


Rufen Sie alle Abschnitte, die sich direkt unter einer bestimmten Abschnittsgruppe befinden ab.Get all sections that are directly under a specific section group.

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


Rufen Sie alle Abschnitte ab, die sich direkt unter einem bestimmten Notizbuch befinden.Get all sections that are directly under a specific notebook.

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


Abschnitte können die Eigenschaften parentNotebook und parentSectionGroup erweitern.Sections can expand the parentNotebook and parentSectionGroup properties.

Die Standardsortierreihenfolge für Abschnitte ist name asc.The default sort order for sections is name asc.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

AbschnittentitätSection entity

Rufen Sie einen bestimmten Abschnitt ab.Get a specific section.

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


Abschnitte können die Eigenschaften parentNotebook und parentSectionGroup erweitern.Sections can expand the parentNotebook and parentSectionGroup properties.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Abschnittsgruppen-SammlungSectionGroup collection

Rufen Sie alle Abschnittsgruppen aus allen Notizbüchern im Besitz des Benutzers ab, einschließlich geschachtelter Abschnittsgruppen.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]


Rufen Sie alle Abschnittsgruppen ab, die sich direkt unter einem bestimmten Notizbuch befinden.Get all section groups that are directly under a specific notebook.

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


Abschnittsgruppen können die Eigenschaften sections, sectionGroups, parentNotebook und parentSectionGroup erweitern.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

Die Standardsortierreihenfolge für Abschnittsgruppen ist name asc.The default sort order for section groups is name asc.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Abschnittsgruppen-EntitätSectionGroup entity

Rufen Sie eine bestimmte Abschnittsgruppe ab.Get a specific section group.

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


Abschnittsgruppen können die Eigenschaften sections, sectionGroups, parentNotebook und parentSectionGroup erweitern.Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Notebook-SammlungNotebook collection

Rufen Sie alle Notizbücher ab, deren Eigentümer der Benutzer ist.Get all the notebooks that are owned by the user.

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


Notizbücher können die Eigenschaften sections und sectionGroups erweitern.Notebooks can expand the sections and sectionGroups properties.

Die Standardsortierreihenfolge für Notizbücher ist name asc.The default sort order for notebooks is name asc.

Notebook-EntitätNotebook entity

Rufen Sie ein bestimmtes Notizbuch ab.Get a specific notebook.

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


Notizbücher können die Eigenschaften sections und sectionGroups erweitern.Notebooks can expand the sections and sectionGroups properties.

Bild- oder andere DateiressourceImage or other file resource

Rufen Sie die Binärdaten einer bestimmten Ressource ab.Get the binary data of a specific resource.

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


Sie finden den Ressourcen-URI der Datei im Ausgabe-HTML-Code der Seite.You can find the file's resource URI in the page's output HTML.

Beispielsweise enthält ein img-Tag Endpunkte für das Originalbild im data-fullres-src-Attribut und das optimierte Bild im src-Attribut.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.

BeispielExample

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

Und ein object-Tag enthält den Endpunkt für die Dateiressource im data-Attribut.And an object tag includes the endpoint for the file resource in the data attribute.

BeispielExample

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

Hinweis: Das Abrufen einer Sammlung von Ressourcen wird nicht unterstützt.Note: Getting a collection of resources is not supported.

Beim Abrufen einer Dateiressource müssen Sie keinen Accept-Inhaltstyp in der Anforderung angeben.When you get a file resource, you don't need to include an Accept content type in the request.

Weitere Informationen über GET-Anforderungen finden Sie unter den folgenden Ressourcen in der Referenz zur Microsoft Graph-API:For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

Beispiele für GET-AnforderungenExample GET requests

Sie können Abfragen für OneNote-Entitäten stellen und Seiteninhalte durchsuchen, um genau die gesuchten Informationen zu erhalten.You can query for OneNote entities and search page content to get just the information you need. Die folgenden Beispiele zeigen einige Verwendungsmöglichkeiten für unterstützte Abfragezeichenfolgenoptionen in GET-Anforderungen für Microsoft Graph.The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

Zur Erinnerung:Remember:

  • Alle GET-Anforderungen beginnen mit der Stamm-URL des Diensts.All GET requests start with the service root URL.

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

  • Leerzeichen in der URL-Abfragezeichenfolge müssen mit %20 codiert sein.Spaces in the URL query string must use %20 encoding.

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

  • Bei Eigenschaftennamen und OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet.Property names and OData string comparisons are case-sensitive. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.We recommend using the OData tolower function for string comparisons.

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

search & filtersearch & filter

Abrufen aller Seiten, die den Begriff recipe enthalten und von einer bestimmten App erstellt wurden (search ist nur für Heimanwender-Notizbücher verfügbar).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

Abrufen des Titels, der OneNote-Clientlinks und des contentUrl-Links für alle Seiten, die den Begriff golgi app enthalten (search ist nur für Heimanwender-Notizbücher verfügbar).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

Abrufen aller Notizbücher und Erweitern ihrer Abschnitte und Abschnittsgruppen.Get all notebooks and expand their sections and section groups.

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

Abrufen einer bestimmten Abschnittsgruppe und Erweitern ihrer Abschnitte und Abschnittsgruppen:Get a specific section group and expand its sections and section groups.

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

Abrufen einer Seite und Erweitern Ihres übergeordneten Abschnitts und übergeordneten Notizbuchs.Get a page and expand its parent section and parent notebook.

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

expand (mehrere Ebenen)expand (multiple levels)

Abrufen aller Notizbücher und Erweitern ihrer Abschnitte und Abschnittsgruppen sowie aller Abschnitte in jeder Abschnittsgruppe.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)

Hinweis: Das Erweitern übergeordneter Elemente von untergeordneten Entitäten oder das Erweitern von untergeordneten Elementen von übergeordneten Entitäten erstellt einen Zirkelbezug und wird nicht unterstützt.Note: Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand & select (mehrere Ebenen)expand & select (multiple levels)

Abrufen des Namens und des self-Links für eine bestimmte Abschnittsgruppe sowie des Namens und self-Links für alle enthaltenen Abschnitte.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

Abrufen des Namens und des self-Links für alle Abschnitte sowie des Namens und der Erstellungszeit des übergeordneten Notizbuchs jedes Abschnitts.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

Abrufen des Titels und der ID für alle Seiten sowie Abrufen des Namens des übergeordneten Abschnitts und des übergeordneten Notizbuchs.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 (mehrere Ebenen)expand & levels (multiple levels)

Abrufen aller Notizbücher, Abschnitte und Abschnittsgruppen.Get all notebooks, sections, and section groups.

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

filterfilter

Abrufen aller Abschnitte, die im Oktober 2014 erstellt wurden.Get all sections that were created in October 2014.

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

Abrufen der Seiten, die von einer bestimmten App seit dem 1. Januar 2015 erstellt wurden.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

Rufen Sie alle Seiten in einem bestimmten Notizbuch ab.Get all pages in a specific notebook. Die API gibt standardmäßig 20 Seiten zurück.The API returns 20 entries by default.

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

Rufen Sie den Namens und den pagesUrl-Link für alle Abschnitte aus dem Notizbuch School ab.Get the name and pagesUrl link for all sections from the School notebook. In OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet. Verwenden Sie daher am besten die tolower-Funktion.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

Abrufen des Namens und des pagesUrl-Links für alle Abschnitte, die den Ausdruck spring im Abschnittsnamen enthalten.Get the name and pagesUrl link for all sections that contain the term spring in the section name. Sortieren der Abschnitte nach dem Datum der letzten Änderung.Order sections by last modified date.

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

orderbyorderby

Abrufen der ersten 20 Seiten, sortiert nach der createdByAppId-Eigenschaft und dann nach der letzten Erstellungszeit.Get the first 20 pages ordered by createdByAppId property and then by most recent created time. Die API gibt standardmäßig 20 Seiten zurück.The API returns 20 entries by default.

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

search & filter & topsearch & filter & top

Abrufen der fünf neuesten Seiten, die seit dem 1. Januar 2015 erstellt wurden und die den Ausdruck cell division enthalten.Get the five newest pages created since January 1, 2015 that contain the phrase cell division. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück.The API returns 20 entries by default with a maximum of 100. Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc (search ist nur für Heimanwender-Notizbücher verfügbar).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

Rufen Sie die folgenden fünf Seiten im Resultset ab (search ist nur für Heimanwender-Notizbücher verfügbar).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

Und die folgenden fünf (search ist nur für Heimanwender-Notizbücher verfügbar)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

Hinweis: Wenn search und filter auf dieselbe Anforderung angewendet werden, enthält das Ergebnis nur die Entitäten, die beide Kriterien erfüllen.Note: If both search and filter are applied to the same request, the results include only those entities that match both criteria.

selectselect

Abrufen von Name, Erstellungszeit und self-Link für alle Abschnitte in den Notizbüchern des Benutzers.Get the name, created time, and self link for all sections in the user's notebooks.

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

Abrufen des Titels, der Erstellungszeit und der OneNote-Clientlinks für eine bestimmte Seite.Get the title, created time, and OneNote client links for a specific page.

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

select & expand & filter (mehrere Ebenen)select & expand & filter (multiple levels)

Abrufen von Name und pagesUrl-Link für alle Abschnitte im Standardnotizbuch des Benutzers.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

Abrufen des Titels und des self-Links für die ersten 50 Seiten, alphabetisch sortiert nach Titel.Get the title and self link for the first 50 pages, ordered alphabetically by title. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück.The API returns 20 entries by default with a maximum of 100. Die Standardsortierreihenfolge für Seiten ist 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

Abrufen der Seiten 51 bis 100. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück.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

Hinweis: GET-Anforderungen für Seiten, die die Standardanzahl von Einträgen abrufen (d. h., sie enthalten keinen top-Ausdruck) geben einen **@odata.nextLink**-Link in der Antwort zurück, mit dem Sie die nächsten 20 Einträge abrufen können.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.

Unterstützte Optionen für OData-AbfragezeichenfolgenSupported OData query string options

Beim Senden von GET-Anforderungen an Microsoft Graph können Sie die Abfrage mit Optionen für OData-Abfragezeichenfolgen anpassen und so genau die gewünschten Informationen erhalten.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. Sie können auch eine Leistungssteigerung erzielen, indem die Anzahl der Aufrufe an den Dienst und die Größe der Antwortnutzlast reduziert wird.They can also improve performance by reducing the number of calls to the service and the size of the response payload.

Hinweis: Zur besseren Lesbarkeit wird in den Beispielen in diesem Artikel nicht die erforderliche Prozentcodierung %20 für Leerzeichen in der URL-Abfragezeichenfolge verwendet: 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

AbfrageoptionQuery option Beispiel und BeschreibungExample and description
countcount

count=true

Die Anzahl der Einträge in der Auflistung. Der Wert wird in der Antwort in der **@odata.count**-Eigenschaft zurückgegeben.The count of entities in the collection. The value is returned in the **@odata.count** property in the response.

expandexpand

expand=sections,sectionGroups

Die Navigationseigenschaften, die inline in der Antwort zurückgegeben werden sollen.The navigation properties to return inline in the response. Die folgenden Eigenschaften werden für expand-Ausdrücke unterstützt:The following properties are supported for expand expressions:
– Seiten: parentNotebook, parentSection- Pages: parentNotebook, parentSection
– Abschnitte: parentNotebook, parentSectionGroup- Sections: parentNotebook, parentSectionGroup
– Abschnittsgruppen: sections, sectionGroups, parentNotebook, parentSectionGroup- Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
– Notizbücher: sections, sectionGroups- Notebooks: sections, sectionGroups

Standardmäßig erweitern GET-Anforderungen für Seiten parentSection und wählen die Eigenschaften id, name und self des Abschnitts aus.By default, GET requests for pages expands parentSection and select the section's id, name, and self properties. Standardmäßig erweitern GET-Anforderungen für Abschnitte und Abschnittsgruppen parentNotebook und parentSectionGroup und wählen die Eigenschaften id, name und self der übergeordneten Elemente aus.Default GET requests for sections and section groups expand both parentNotebook and parentSectionGroup, and select the parents' id, name, and self properties.

Kann für eine einzelne Entität oder eine Sammlung verwendet werden.Can be used for a single entity or a collection.
Trennen Sie mehrere Eigenschaften durch Kommas.Separate multiple properties with commas.
Bei Eigenschaftennamen wird die Groß-/Kleinschreibung beachtet.Property names are case-sensitive.

filterfilter

filter=isDefault eq true

Ein boolescher Ausdruck, der angibt, ob ein Eintrag in das Resultset aufgenommen werden soll.A Boolean expression for whether to include an entry in the result set. Unterstützt die folgenden OData-Operatoren und -Funktionen:Supports the following OData operators and functions:
– Vergleichsoperatoren: eq, ne, gt, ge, lt, le- Comparison operators: eq, ne, gt, ge, lt, le
– Logische Operatoren: and, or, not- Logical operators: and, or, not
– Zeichenfolgenfunktionen: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat- String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

Bei Eigenschaftennamen und OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet.Property names and OData string comparisons are case-sensitive. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.We recommend using the OData tolower function for string comparisons.

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

orderbyorderby

orderby=title,createdTime desc

Die Eigenschaften, nach denen sortiert werden soll, mit einer optionalen Sortierreihenfolge asc (Standard) oder desc. Sie können nach jeder beliebigen Eigenschaft der Entität in der angeforderten Auflistung sortieren.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.

Die Standardsortierreihenfolge für Notizbücher, Abschnittsgruppen und Abschnitte ist name asc und für Seiten lastModifiedTime desc (zuletzt geänderte Seite zuerst).The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

Trennen Sie mehrere Eigenschaften durch Kommas, und führen Sie sie in der Reihenfolge auf, in der sie angewendet werden sollen.Separate multiple properties with commas, and list them in the order that you want them applied. Bei Eigenschaftennamen wird die Groß-/Kleinschreibung beachtet.Property names are case-sensitive.

searchsearch

search=cell div

Nur für Heimanwender-Notizbücher verfügbar.Available for consumer notebooks only.

Der zu suchende Begriff oder Ausdruck im Seitentitel, Seitentext, Alternativtext für Bilder und OCR-Text für Bilder. Standardmäßig werden die Ergebnisse von Suchabfragen nach Relevanz sortiert zurückgegeben.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 verwendet die Bing-Volltextsuche, um die Suche nach Wortgruppen, Wortstammerkennung, Toleranz gegen Rechtschreibfehler, Relevanz und Bewertung, Worttrennung, mehrere Sprachen und andere Volltext-Suchfunktionen zu unterstützen.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. In Suchzeichenfolgen wird die Groß-/Kleinschreibung beachtet.Search strings are case-insensitive.

Gilt nur für Seiten in Notizbüchern im Besitz des Benutzers.Applies only to pages in notebooks owned by the user. Indizierter Inhalt ist privat und nur für den Besitzer zugänglich.Indexed content is private and can only be accessed by the owner. Kennwortgeschützte Seiten werden nicht indiziert.Password-protected pages are not indexed. Gilt nur für den pages-Endpunkt.Applies only to the pages endpoint.

selectselect

select=id,title

Die Eigenschaften, die zurückgegeben werden sollen.The properties to return. Kann für eine einzelne Entität oder eine Sammlung verwendet werden.Can be used for a single entity or for a collection. Trennen Sie mehrere Eigenschaften durch Kommas.Separate multiple properties with commas. Bei Eigenschaftennamen wird die Groß-/Kleinschreibung beachtet.Property names are case-sensitive.

skipskip

skip=10

Die Anzahl der Einträge, die im Resultset übersprungen werden sollen.The number of entries to skip in the result set. In der Regel für die Seitenverwaltung der Ergebnisse verwendet.Typically used for paging results.

Nach obentop

top=50

Die Anzahl der zurückzugebenden Einträge im Resultset, maximal 100.The number of entries to return in the result set, up to a maximum of 100. Der Standardwert ist 20.The default value is 20.

Microsoft Graph bietet außerdem die pagelevel-Zeichenfolgenoption, mit der Sie die Ebene und die Reihenfolge der Seiten innerhalb des übergeordneten Abschnitts abrufen können.Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. Gilt nur für Abfragen für Seiten in einem bestimmten Abschnitt oder für Abfragen für eine bestimmte Seite.Applies only to queries for pages in a specific section or queries for a specific page.

BeispieleExamples

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

Unterstützte OData-Operatoren und -FunktionenSupported OData operators and functions

Microsoft Graph unterstützt die folgenden OData-Operatoren und Funktionen in filter-Ausdrücken.Microsoft Graph supports the following OData operators and functions in filter expressions. Beachten Sie bei der Verwendung von OData-Ausdrücken Folgendes:When using OData expressions, remember:

  • Leerzeichen in der URL-Abfagezeichenfolge müssen durch die Codierung %20 ersetzt werden.Spaces in the URL query string must be replaced with the %20 encoding.

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

  • Bei Eigenschaftennamen und OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet.Property names and OData string comparisons are case-sensitive. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.We recommend using the OData tolower function for string comparisons.

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

VergleichsoperatorComparison operator BeispielExample
eqeq
(gleich)(equal to)
createdByAppId eq '{app-id}'
nene
(nicht gleich)(not equal to)
userRole ne 'Owner'
gtgt
(größer als)(greater than)
createdTime gt 2014-02-23
gege
(größer als oder gleich)(greater than or equal to)
lastModifiedTime ge 2014-05-05T07:00:00Z
ltlt
(kleiner als)(less than)
createdTime lt 2014-02-23
lele
(kleiner als oder gleich)(less than or equal to)
lastModifiedTime le 2014-02-23

Logischer OperatorLogical operator BeispielExample
undand createdTime le 2014-01-30 and createdTime gt 2014-01-23
oderor createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'
notnot not contains(tolower(title),'school')

| String-FunktionString function | BeispielExample | |------|------| | 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'` |

OneNote-EntitätseigenschaftenOneNote entity properties

Die Abfrageausdrücke filter, select, expand und orderby können Eigenschaften von OneNote-Entitäten enthalten.The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

BeispielExample

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

Bei Eigenschaftennamen in Abfrageausdrücken wird die Groß-/Kleinschreibung beachtet.Property names are case-sensitive in query expressions.

Die Liste der Eigenschaften und Eigenschaftentypen finden Sie unter den folgenden Ressourcen in der Referenz zur Microsoft Graph-API:For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

Die Abfragezeichenfolgenoption expand kann mit folgenden Navigationseigenschaften verwendet werden:The expand query string option can be used with the following navigation properties:

  • Seiten: parentNotebook, parentSectionPages: parentNotebook, parentSection
  • Abschnitte: parentNotebook, parentSectionGroupSections: parentNotebook, parentSectionGroup
  • Abschnittsgruppen: sections, sectionGroups, parentNotebook, parentSectionGroupSection groups: sections, sectionGroups, parentNotebook, parentSectionGroup
  • Notizbücher: sections, sectionGroupsNotebooks: sections, sectionGroups

Anforderungs- and Antwortinformationen für GET-AnforderungenRequest and response information for GET requests

AnforderungsdatenRequest data BeschreibungDescription
ProtokollProtocol Alle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.All requests use the SSL/TLS HTTPS protocol.
Header „Authorization“Authorization header

Bearer {token}, wobei {token} ein gültiges OAuth 2.0-Zugriffstoken für Ihre registrierte App ist.Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

Wenn dies fehlt oder ungültig ist, schlägt die Anforderung mit dem Statuscode 401 fehl.If missing or invalid, the request fails with a 401 status code. Siehe Authentifizierung und Berechtigungen.See Authentication and permissions.

Header „Accept“Accept header

application/json für OneNote-Entitäten und -Entitätenmengenapplication/json for OneNote entities and entity sets

text/html für Seiteninhalttext/html for page content


AntwortdatenResponse data BeschreibungDescription
ErfolgscodeSuccess code HTTP-Statuscode 200.A 200 HTTP status code.
AntworttextResponse body Eine OData-Darstellung der Entität oder der Entitätenmenge im JSON-Format, der HTML-Code der Seite oder Binärdaten der Dateiressource.An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
FehlerErrors Wenn die Anforderung nicht erfüllt wird, gibt die API Fehler im **@api.diagnostics**-Objekt im Antworttext zurück.If the request fails, the API returns errors in the **@api.diagnostics** object in the response body.
Header „X-CorrelationId“X-CorrelationId header Ein globaler Bezeichner (GUID), über den die Anforderung eindeutig identifiziert wird.A GUID that uniquely identifies the request. Sie können diesen Wert zusammen mit dem Wert des Date-Headers verwenden, um zusammen mit dem Microsoft Support Probleme zu behandeln.You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Erstellen der Stamm-URL des Microsoft Graph-NotizendienstsConstructing the Microsoft Graph notes service root URL

Die Stamm-URL des Microsoft Graph-Notizendienses verwendet das folgende Format für alle Aufrufe von Microsoft Graph-Notizen:The Microsoft Graph notes root URL uses the following format for all calls to Microsoft Graph notes:

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

Das Segment version in der URL ist die Version von Microsoft Graph, die verwendet werden soll.The version segment in the URL represents the version of Microsoft Graph that you want to use. Verwenden Sie v1.0 für stabilen Produktionscode.Use v1.0 for stable production code. Verwenden Sie beta, um ein Feature zu testen, das sich in der Entwicklung befindet.Use beta to try out a feature that's in development. Features und Funktionen in der Betaversion ändern sich möglicherweise, sodass Sie es nicht in Ihrem Produktionscode verwenden sollten.Features and functionality in beta may change, so you shouldn't use it in your production code.

Verwenden Sie me für OneNote-Inhalt, auf den der aktuelle Benutzer zugreifen kann (eigene und freigegebene Inhalte).Use me for OneNote content that the current user can access (owned and shared). Verwenden Sie users/{id} für OneNote-Inhalte, die der (in der URL) angegebene Benutzer für den aktuellen Benutzer freigegeben hat.Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Verwenden Sie Microsoft Graph, um Benutzer-IDs abzurufen.Use Microsoft Graph to get user IDs.

Berechtigungen für GET-AnforderungenPermissions for GET requests

Um OneNote-Inhalte oder -Strukturen abzurufen, müssen Sie entsprechende Berechtigungen anfordern.To get OneNote content or structure, you'll need to request appropriate permissions.

Die folgenden Bereiche lassen GET-Anforderungen für Microsoft Graph zu.The following scopes allow GET requests to Microsoft Graph. Wählen Sie die niedrigste Berechtigungsstufe, die Ihre App zur Erledigung ihrer Aufgaben benötigt.Choose the lowest level of permissions that your app needs to do its work.

Wählen Sie zwischen:Choose from:

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

Weitere Informationen zu Berechtigungsbereichen und deren Funktionsweise finden Sie in der Microsoft Graph-Berechtigungsreferenz.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Siehe auchSee also