Abrufen von OneNote-Inhalt und -Struktur

Artikel
11/07/2024

Gilt für: Heimanwender-Notizbücher auf OneDrive | Enterprise-Notizbücher auf Microsoft 365

Um OneNote-Inhalte und -Struktur mithilfe der Microsoft Graph OneNote-API abzurufen, senden Sie eine GET-Anforderung an den Zielendpunkt. Beispiel:

GET ../onenote/pages/{id}

Wenn die Anforderung erfolgreich ist, gibt Microsoft Graph einen HTTP-Statuscode „200 OK“ zurück, sowie die Entitäten oder Inhalte, die Sie angefordert haben. OneNote-Entitäten werden als JSON-Objekte zurückgegeben, die der Spezifikation der OData-Version 4.0 entsprechen.

Mithilfe von Abfragezeichenfolgenoptionen können Sie Ihre Abfragen filtern und die Leistung verbessern.

Hinweis

Wenn Sie eine Lösung erstellen, die eines der folgenden Szenarien unterstützt, gelten die OneNote-API-Einschränkungen:

Sichern/Wiederherstellen von OneNote-Abschnitten
Sichern/Wiederherstellen von OneNote-Notizbüchern

Informationen zu Sicherungs- und Wiederherstellungsvorgängen finden Sie unter Bewährte Methoden zum Ermitteln von Dateien und Erkennen von Änderungen im großen Stil.

Erstellen des Anforderungs-URI

Um den Anforderungs-URI zu erstellen, beginnen Sie mit der Stamm-URL des Diensts:

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

Fügen Sie dann den Endpunkt der Ressource an, die Sie abrufen möchten. (Ressourcenpfade werden im nächsten Abschnitt gezeigt.)

Ihr vollständiger Anforderungs-URI gleicht einem der folgenden Beispiele:

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.

Ressourcenpfade für GET-Anforderungen

Verwenden Sie die folgenden Ressourcenpfade, um Seiten, Abschnitte, Abschnittsgruppen, Notizbücher und Bild- oder Dateiressourcen abzurufen.

Seitensammlung
Seitenentität
Seitenvorschau
HTML-Inhalt einer Seite
Abschnittsammlung
Abschnittentität
Abschnittsgruppen-Sammlung
Abschnittsgruppen-Entität
Notebook-Sammlung
Notebook-Entität
Bild- oder andere Dateiressource

Seitensammlung

Rufen Sie Seiten (Metadaten) aus allen Notizbüchern ab.

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

Rufen Sie Seiten (Metadaten) aus einem bestimmten Abschnitt ab.

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

Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc.

Die Standardabfrage erweitert den übergeordneten Abschnitt und wählt die Eigenschaften id, name und self des Abschnitts aus.

Standardmäßig werden nur die ersten 20 Einträge für GET pages-Anforderungen zurückgegeben. 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.

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.

Beispiel

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

Seitenentität

Abrufen der Metadaten für eine bestimmte Seite.

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

Seiten können die Eigenschaften parentNotebook und parentSection erweitern.

Die Standardabfrage erweitert den übergeordneten Abschnitt und wählt die Eigenschaften id, name und self des Abschnitts aus.

Verwenden Sie pagelevel, um die Einzugsebene der Seite und ihre Reihenfolge im übergeordneten Abschnitt zurückzugeben.

Beispiel

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

Seitenvorschau

Rufen Sie Text- und Bild-Vorschauinhalt für eine Seite ab.

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

Die JSON-Antwort enthält den Vorschauinhalt, anhand dessen Benutzer feststellen können, was sich auf der Seite befindet.

{
  "@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. Microsoft Graph gibt vollständige Ausdrücke im Umfang von maximal 300 Zeichen zurück.

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 Bildressource. Sie können diesen Link in HTML-Code verwenden. Andernfalls gibt href NULL zurück.

Beispiel

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

HTML-Inhalt einer Seite

Rufen Sie den HTML-Code einer Seite ab.

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

(Weitere Informationen zu zurückgegebenen HTML-Inhalten)

Verwenden Sie die Abfragezeichenfolgenoption includeIDs=true, um die zum Aktualisieren der Seite generierten IDs abzurufen.

Abschnittsammlung

Rufen Sie alle Abschnitte aus allen Notizbüchern im Besitz des Benutzers ab, einschließlich der Abschnitte in geschachtelten Abschnittsgruppen.

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

Rufen Sie alle Abschnitte, die sich direkt unter einer bestimmten Abschnittsgruppe befinden ab.

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

Rufen Sie alle Abschnitte ab, die sich direkt unter einem bestimmten Notizbuch befinden.

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

Abschnitte können die Eigenschaften parentNotebook und parentSectionGroup erweitern.

Die Standardsortierreihenfolge für Abschnitte ist name asc.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.

Abschnittentität

Rufen Sie einen bestimmten Abschnitt ab.

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

Abschnitte können die Eigenschaften parentNotebook und parentSectionGroup erweitern.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.

Abschnittsgruppen-Sammlung

Rufen Sie alle Abschnittsgruppen aus allen Notizbüchern im Besitz des Benutzers ab, einschließlich geschachtelter Abschnittsgruppen.

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

Rufen Sie alle Abschnittsgruppen ab, die sich direkt unter einem bestimmten Notizbuch befinden.

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

Abschnittsgruppen können die Eigenschaften sections, sectionGroups, parentNotebook und parentSectionGroup erweitern.

Die Standardsortierreihenfolge für Abschnittsgruppen ist name asc.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.

Abschnittsgruppen-Entität

Rufen Sie eine bestimmte Abschnittsgruppe ab.

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

Abschnittsgruppen können die Eigenschaften sections, sectionGroups, parentNotebook und parentSectionGroup erweitern.

Die Standardabfrage erweitert das übergeordnete Notizbuch und die übergeordnete Abschnittsgruppe und wählt deren Eigenschaften id, name und self aus.

Notebook-Sammlung

Rufen Sie alle Notizbücher ab, deren Eigentümer der Benutzer ist.

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

Notizbücher können die Eigenschaften sections und sectionGroups erweitern.

Die Standardsortierreihenfolge für Notizbücher ist name asc.

Notebook-Entität

Rufen Sie ein bestimmtes Notizbuch ab.

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

Notizbücher können die Eigenschaften sections und sectionGroups erweitern.

Bild- oder andere Dateiressource

Rufen Sie die Binärdaten einer bestimmten Ressource ab.

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

Sie finden den Ressourcen-URI der Datei im Ausgabe-HTML-Code der Seite.

Beispielsweise enthält ein img-Tag Endpunkte für das Originalbild im data-fullres-src-Attribut und das optimierte Bild im src-Attribut.

Beispiel

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

Beispiel

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

Beim Abrufen einer Dateiressource müssen Sie keinen Accept-Inhaltstyp in der Anforderung angeben.

Weitere Informationen über GET-Anforderungen finden Sie unter den folgenden Ressourcen in der Referenz zur Microsoft Graph-API:

Beispiele für GET-Anforderungen

Sie können OneNote-Entitäten abfragen, um nur die informationen zu erhalten, die Sie benötigen. Die folgenden Beispiele zeigen einige Verwendungsmöglichkeiten für unterstützte Abfragezeichenfolgenoptionen in GET-Anforderungen für Microsoft Graph.

Zur Erinnerung:

Alle GET-Anforderungen beginnen mit der Stamm-URL des Diensts.

Beispiele: https://www.onenote.com/api/v1.0/me/notes und https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/
Leerzeichen in der URL-Abfragezeichenfolge müssen mit %20 codiert sein.

Beispiel: filter=title%20eq%20'biology'
Bei Eigenschaftennamen und OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.

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

filter

Ruft alle Seiten ab, die von einer bestimmten App erstellt wurden.

[GET] ../pages?filter=createdByAppId eq 'WLID-000000004C12821A'

select

Rufen Sie den Titel, OneNote-Clientlinks und contentUrl-Link für alle Seiten ab.

[GET] ../pages?select=title,links,contentUrl

expand

Abrufen aller Notizbücher und Erweitern ihrer Abschnitte und Abschnittsgruppen.

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

Abrufen einer bestimmten Abschnittsgruppe und Erweitern ihrer Abschnitte und Abschnittsgruppen:

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

Abrufen einer Seite und Erweitern Ihres übergeordneten Abschnitts und übergeordneten Notizbuchs.

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

expand (mehrere Ebenen)

Abrufen aller Notizbücher und Erweitern ihrer Abschnitte und Abschnittsgruppen sowie aller Abschnitte in jeder Abschnittsgruppe.

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

Hinweis

Das Erweitern von übergeordneten Elementen von untergeordneten Entitäten oder das Erweitern von untergeordneten Elementen von übergeordneten Entitäten erstellt einen Zirkelverweis und wird nicht unterstützt.

expand & select (mehrere Ebenen)

Abrufen des Namens und des self-Links für eine bestimmte Abschnittsgruppe sowie des Namens und self-Links für alle enthaltenen Abschnitte.

[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] ../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] ../pages?select=id,title&expand=parentSection(select=name),parentNotebook(select=name)

expand & levels (mehrere Ebenen)

Abrufen aller Notizbücher, Abschnitte und Abschnittsgruppen.

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

filter

Abrufen aller Abschnitte, die im Oktober 2014 erstellt wurden.

[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] ../pages?filter=createdByAppId eq 'WLID-0000000048118631' and createdTime ge 2015-01-01

filter & expand

Rufen Sie alle Seiten in einem bestimmten Notizbuch ab. Die API gibt standardmäßig 20 Seiten zurück.

[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. In OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet. Verwenden Sie daher am besten die tolower-Funktion.

[GET] ../notebooks?filter=tolower(name) eq 'school'&expand=sections(select=name,pagesUrl)

filter & select & orderby

Abrufen des Namens und des pagesUrl-Links für alle Abschnitte, die den Ausdruck spring im Abschnittsnamen enthalten. Sortieren der Abschnitte nach dem Datum der letzten Änderung.

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

orderby

Abrufen der ersten 20 Seiten, sortiert nach der createdByAppId-Eigenschaft und dann nach der letzten Erstellungszeit. Die API gibt standardmäßig 20 Seiten zurück.

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

filter & top

Rufen Sie die fünf neuesten Seiten ab, die seit dem 1. Januar 2015 erstellt wurden. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück. Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc.

[GET] ../pages?filter=createdTime ge 2015-01-01&top=5

Filter & top & skip

Rufen Sie die nächsten fünf Seiten im Resultset ab.

[GET] ../pages?filter=createdTime ge 2015-01-01&top=5&skip=5

Und der nächsten fünf:

[GET] ../pages?filter=createdTime ge 2015-01-01&top=5&skip=10

Hinweis

Wenn sowohl top als auch filter auf dieselbe Anforderung angewendet werden, enthalten die Ergebnisse nur die Entitäten, die beide Kriterien erfüllen.

select

Abrufen von Name, Erstellungszeit und self-Link für alle Abschnitte in den Notizbüchern des Benutzers.

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

Abrufen des Titels, der Erstellungszeit und der OneNote-Clientlinks für eine bestimmte Seite.

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

select & expand & filter (mehrere Ebenen)

Abrufen von Name und pagesUrl-Link für alle Abschnitte im Standardnotizbuch des Benutzers.

[GET] ../notebooks?select=name&expand=sections(select=name,pagesUrl)&filter=isDefault eq true

top & select & orderby

Abrufen des Titels und des self-Links für die ersten 50 Seiten, alphabetisch sortiert nach Titel. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück. Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc.

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

skip & top & select & orderby

Abrufen der Seiten 51 bis 100. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück.

[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 geben keinen top-Ausdruck an), geben einen link @odata.nextLink in der Antwort zurück, mit dem Sie die nächsten 20 Einträge abrufen können.

Unterstützte Optionen für OData-Abfragezeichenfolgen

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. Sie können auch eine Leistungssteigerung erzielen, indem die Anzahl der Aufrufe an den Dienst und die Größe der Antwortnutzlast reduziert wird.

Hinweis

Aus Gründen der Lesbarkeit wird in den Beispielen in diesem Artikel nicht die %20-Prozent-Codierung verwendet, die für Leerzeichen in der URL-Abfragezeichenfolge erforderlich ist: filter=isDefault%20eq%20true

Abfrageoption	Beispiel und Beschreibung
count	`count=true` Die Anzahl der Entitäten in der Sammlung. Der Wert wird in der Antwort in der @odata.count-Eigenschaft zurückgegeben.
expand	`expand=sections,sectionGroups` Die Navigationseigenschaften, die inline in der Antwort zurückgegeben werden sollen. Die folgenden Eigenschaften werden für expand-Ausdrücke unterstützt: – Seiten: parentNotebook, parentSection – Abschnitte: parentNotebook, parentSectionGroup – Abschnittsgruppen: sections, sectionGroups, parentNotebook, parentSectionGroup – Notizbücher: sections, sectionGroups Standardmäßig erweitern GET-Anforderungen für Seiten parentSection und wählen die Eigenschaften id, name und self des Abschnitts aus. 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. Kann für eine einzelne Entität oder eine Sammlung verwendet werden. Trennen Sie mehrere Eigenschaften durch Kommas. Bei Eigenschaftennamen wird die Groß-/Kleinschreibung beachtet.
filter	`filter=isDefault eq true` Ein boolescher Ausdruck, der angibt, ob ein Eintrag in das Resultset aufgenommen werden soll. Unterstützt die folgenden OData-Operatoren und -Funktionen: – Vergleichsoperatoren: eq, ne, gt, ge, lt, le – Logische Operatoren: and, or, not – Zeichenfolgenfunktionen: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat Bei Eigenschaftennamen und OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche. Beispiel: `filter=tolower(name) eq 'spring'`
orderby	`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. Die Standardsortierreihenfolge für Notizbücher, Abschnittsgruppen und Abschnitte ist `name asc` und für Seiten `lastModifiedTime desc` (zuletzt geänderte Seite zuerst). Trennen Sie mehrere Eigenschaften durch Kommas, und führen Sie sie in der Reihenfolge auf, in der sie angewendet werden sollen. Bei Eigenschaftennamen wird die Groß-/Kleinschreibung beachtet.
select	`select=id,title` Die Eigenschaften, die zurückgegeben werden sollen. Kann für eine einzelne Entität oder eine Sammlung verwendet werden. Trennen Sie mehrere Eigenschaften durch Kommas. Bei Eigenschaftennamen wird die Groß-/Kleinschreibung beachtet.
skip	`skip=10` Die Anzahl der Einträge, die im Resultset übersprungen werden sollen. In der Regel für die Seitenverwaltung der Ergebnisse verwendet.
Nach oben	`top=50` Die Anzahl der zurückzugebenden Einträge im Resultset, maximal 100. Der Standardwert ist 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. Gilt nur für Abfragen für Seiten in einem bestimmten Abschnitt oder für Abfragen für eine bestimmte Seite.

Beispiele

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

Unterstützte OData-Operatoren und -Funktionen

Microsoft Graph unterstützt die folgenden OData-Operatoren und Funktionen in filter-Ausdrücken. Beachten Sie bei der Verwendung von OData-Ausdrücken Folgendes:

Leerzeichen in der URL-Abfagezeichenfolge müssen durch die Codierung %20 ersetzt werden.

Beispiel:filter=isDefault%20eq%20true
Bei Eigenschaftennamen und OData-Zeichenfolgenvergleichen wird die Groß-/Kleinschreibung beachtet. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.

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

Vergleichsoperator	Beispiel
eq (gleich)	`createdByAppId eq '{app-id}'`
ne (nicht gleich)	`userRole ne 'Owner'`
gt (größer als)	`createdTime gt 2014-02-23`
ge (größer als oder gleich)	`lastModifiedTime ge 2014-05-05T07:00:00Z`
lt (kleiner als)	`createdTime lt 2014-02-23`
le (kleiner als oder gleich)	`lastModifiedTime le 2014-02-23`

Logischer Operator	Beispiel
und	`createdTime le 2014-01-30 and createdTime gt 2014-01-23`
oder	`createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'`
not	`not contains(tolower(title),'school')`

String-Funktion	Beispiel
contains	`contains(tolower(title),'spring')`
endswith	`endswith(tolower(title),'spring')`
startswith	`startswith(tolower(title),'spring')`
length	`length(title) eq 19`
indexof	`indexof(tolower(title),'spring') eq 1`
substring	`substring(tolower(title),1) eq 'spring'`
tolower	`tolower(title) eq 'spring'`
toupper	`toupper(title) eq 'SPRING'`
trim	`trim(tolower(title)) eq 'spring'`
concat	`concat(title,'- by MyRecipesApp') eq 'Carrot Cake Recipe - by MyRecipesApp'`

OneNote-Entitätseigenschaften

Die Abfrageausdrücke filter, select, expand und orderby können Eigenschaften von OneNote-Entitäten enthalten.

Beispiel

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

Bei Eigenschaftennamen in Abfrageausdrücken wird die Groß-/Kleinschreibung beachtet.

Die Liste der Eigenschaften und Eigenschaftentypen finden Sie unter den folgenden Ressourcen in der Referenz zur Microsoft Graph-API:

Die Abfragezeichenfolgenoption expand kann mit folgenden Navigationseigenschaften verwendet werden:

Seiten: parentNotebook, parentSection
Abschnitte: parentNotebook, parentSectionGroup
Abschnittsgruppen: sections, sectionGroups, parentNotebook, parentSectionGroup
Notizbücher: sections, sectionGroups

Anforderungs- and Antwortinformationen für GET-Anforderungen

Anforderungsdaten Beschreibung

Protokoll Alle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.

Header „Authorization“

Anforderungsdaten	Beschreibung
Protokoll	Alle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Header „Authorization“	`Bearer {token}`, wobei `{token}` ein gültiges OAuth 2.0-Zugriffstoken für Ihre registrierte App ist. Wenn dies fehlt oder ungültig ist, schlägt die Anforderung mit dem Statuscode 401 fehl. Siehe Authentifizierung und Berechtigungen.
Header „Accept“	`application/json` für OneNote-Entitäten und -Entitätenmengen `text/html` für Seiteninhalt

Bearer {token}, wobei {token} ein gültiges OAuth 2.0-Zugriffstoken für Ihre registrierte App ist.

Wenn dies fehlt oder ungültig ist, schlägt die Anforderung mit dem Statuscode 401 fehl. Siehe Authentifizierung und Berechtigungen.

Header „Accept“

application/json für OneNote-Entitäten und -Entitätenmengen

text/html für Seiteninhalt

Antwortdaten	Beschreibung
Erfolgscode	HTTP-Statuscode 200.
Antworttext	Eine OData-Darstellung der Entität oder der Entitätenmenge im JSON-Format, der HTML-Code der Seite oder Binärdaten der Dateiressource.
Fehler	Wenn die Anforderung nicht erfüllt wird, gibt die API Fehler im @api.diagnostics-Objekt im Antworttext zurück.
Header „X-CorrelationId“	Ein globaler Bezeichner (GUID), über den die Anforderung eindeutig identifiziert wird. Sie können diesen Wert zusammen mit dem Wert des Date-Headers verwenden, um zusammen mit dem Microsoft Support Probleme zu behandeln.

Erstellen der Stamm-URL des Microsoft Graph-Notizendiensts

Die Stamm-URL des Microsoft Graph-Notizendienses verwendet das folgende Format für alle Aufrufe von Microsoft Graph-Notizen:

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

Das Segment version in der URL ist die Version von Microsoft Graph, die verwendet werden soll. Verwenden Sie v1.0 für stabilen Produktionscode. Verwenden Sie beta, um ein Feature zu testen, das sich in der Entwicklung befindet. Features und Funktionen in der Betaversion ändern sich möglicherweise, sodass Sie es nicht in Ihrem Produktionscode verwenden sollten.

Verwenden Sie me für OneNote-Inhalt, auf den der aktuelle Benutzer zugreifen kann (eigene und freigegebene Inhalte). Verwenden Sie users/{id} für OneNote-Inhalte, die der (in der URL) angegebene Benutzer für den aktuellen Benutzer freigegeben hat. Verwenden Sie Microsoft Graph, um Benutzer-IDs abzurufen.

Berechtigungen für GET-Anforderungen

Um OneNote-Inhalte oder -Strukturen abzurufen, müssen Sie entsprechende Berechtigungen anfordern.

Die folgenden Bereiche lassen GET-Anforderungen für Microsoft Graph zu. Wählen Sie die niedrigste Berechtigungsstufe, die Ihre App zur Erledigung ihrer Aufgaben benötigt.

Wählen Sie zwischen:

Notes.Read
Notes.ReadWrite
Notes.ReadWrite.All

Weitere Informationen zu Berechtigungsbereichen und deren Funktionsweise finden Sie in der Microsoft Graph-Berechtigungsreferenz.

Freigeben über

Abrufen von OneNote-Inhalt und -Struktur

Erstellen des Anforderungs-URI

Ressourcenpfade für GET-Anforderungen

Seitensammlung

Beispiel

Seitenentität

Beispiel

Seitenvorschau

Beispiel

HTML-Inhalt einer Seite

Abschnittsammlung

Abschnittentität

Abschnittsgruppen-Sammlung

Abschnittsgruppen-Entität

Notebook-Sammlung

Notebook-Entität

Bild- oder andere Dateiressource

Beispiel

Beispiel

Beispiele für GET-Anforderungen

filter

select

expand

expand (mehrere Ebenen)

expand & select (mehrere Ebenen)

expand & levels (mehrere Ebenen)

filter

filter & expand

filter & select & orderby

orderby

filter & top

Filter & top & skip

select

select & expand & filter (mehrere Ebenen)

top & select & orderby

skip & top & select & orderby

Unterstützte Optionen für OData-Abfragezeichenfolgen

Beispiele

Unterstützte OData-Operatoren und -Funktionen

OneNote-Entitätseigenschaften

Beispiel

Anforderungs- and Antwortinformationen für GET-Anforderungen

Erstellen der Stamm-URL des Microsoft Graph-Notizendiensts

Berechtigungen für GET-Anforderungen

Verwandte Inhalte

Feedback

Zusätzliche Ressourcen