Table of contents
TOC
Inhaltsverzeichnis reduzieren
Inhaltsverzeichnis erweitern
Zuletzt aktualisiert: 25.07.2018

Abrufen von OneNote-Inhalt und -Struktur mit der OneNote-API

Gilt für: Privatanwender-Notizbücher auf OneDrive | Enterprise-Notizbücher auf Office 365

Um den Inhalt und die Struktur von OneNote abzurufen, senden Sie eine GET-Anfrage an den Ziel-Endpunkt. Beispiel:

GET ../notes/pages/{id}

Wenn die Anfrage erfolgreich war, gibt die OneNote-API einen 200 HTTP-Statuscode und die Entitäten oder Inhalte zurück, die Sie angefordert haben. OneNote-Objekte werden als JSON-Objekte zurückgegeben, die der OData Version 4.0-Spezifikation entsprechen.

Durch die Verwendung von Abfrage-Zeichenfolgeoptionen können Sie Ihre Abfragen filtern und die Leistung verbessern.

Erstellen des Anforderungs-URI

Um die Anforderungs-URI zu erstellen, beginnen Sie mit der Dienst-Root-URL:

Notebooks auf OneDrive
https://www.onenote.com/api/v1.0/me/notes/

Notebooks auf OneDrive for Business
https://www.onenote.com/api/v1.0/me/notes/
https://www.onenote.com/api/v1.0/users/{id}/notes/

SharePoint Website-Notebooks
https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

Vereinheitlichte Gruppen-Notebooks
https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/


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


Ihre vollständige Anforderungs-URI wird wie eines dieser Beispiele aussehen:

https://www.onenote.com/api/v1.0/me/notes/notebooks/{id}/sections

https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/pages

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/pages?select=title,self

Weitere Informationen zur Stamm-URL des Dienstes.

Ressourcenpfade für GET-Anforderungen

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

Seiten-Sammlung  |  Seiten-Entität  |  Seiten-Vorschau  |  Seiten-HTML-Inhalt  |   Abschnitts-Sammlung  |  Abschnitts-Entität  |  Abschnittsgruppen-Sammlung  |   Abschnittsgruppen-Entität  |  Notizbuch-Sammlung  |  Notizbuch-Entität  |   Bild- oder andere Datei-Ressource

Page-Sammlung

Seiten (Metadaten) über alle Notizbücher abrufen

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

Seiten (Metadaten) von einem bestimmten Abschnitt abrufen

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


Die Abfrage-Zeichenfolgeoption search ist nur für Verbraucher-Notizbücher verfügbar.

Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc.

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

Standardmäßig werden nur die obersten 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.

Für die Seiten-Sammlung in einem Abschnitt verwenden Sie pagelevel, um die Einrückungsebene der Seiten und ihre Reihenfolge innerhalb des Abschnitts zurückzugeben. Beispiel: GET ../sections/{section-id}/pages?pagelevel=true.


Seiten-Entitä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, nameund self aus.

Verwenden Sie pagelevel, um die Einrückungsebene der Seite und ihre Reihenfolge innerhalb ihres übergeordneten Abschnitts zurückzugeben. Beispiel: GET ../pages/{page-id}?pagelevel=true.


Seitenvorschau

Text- und Bildvorschauinhalte für eine bestimmte Seite abrufen

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


Die JSON-Antwort enthält den Vorschauinhalt, mit dem Sie den Benutzern helfen können, die Inhalte der Seite zu identifizieren.

{
  "@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 Eigenschaft previewText enthält einen Textauszug aus der Seite. Die OneNote-API gibt vollständige Phrasen mit maximal 300 Zeichen zurück.

Wenn die Seite ein Bild hat, das zum Erstellen einer Vorschau-UI verwendet werden kann, enthält die Eigenschaft href im Objekt previewImageUrl einen Link zu einer öffentlichen, vorauthentifizierten Bildressource. Sie können diesen Link in HTML verwenden, z.B.: <img src="https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png" />. Ansonsten gibt href null zurück.


HTML-Inhalt einer Seite

HTML-Inhalt einer bestimmten Seite abrufen

../pages/{page-id}/content[?includeIDs,preAuthenticated]
      (Mehr erfahren über zurückgegebenen HTML-Inhalt)


Verwenden Sie die Abfrage-Zeichenfolgeoption includeIDs=true, um generierte IDs zum Aktualisieren der Seitezu erhalten.

Verwenden Sie die Abfrage-Zeichenfolgeoption preAuthenticated==true, um öffentliche URLs zu den Bildressourcen zu erhalten, die sich auf der Seite befinden. Die öffentlichen URLs sind eine Stunde lang gültig.


Section-Sammlung

Abrufen aller Abschnitte aus allen Notizbüchern, die dem Benutzer gehören, einschließlich der Abschnitte in verschachtelten Abschnittsgruppen

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

Abrufen aller Abschnitte, die sich direkt unter einer bestimmten Abschnittsgruppe befinden

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

Abrufen aller Abschnitte, 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 Bereichsgruppe und wählt deren id, nameund self Eigenschaften aus.


Abschnittsentität

Abrufen eines bestimmten Abschnitts

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


Abschnitte können die Eigenschaften parentNotebook und parentSectionGroup erweitern.

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


SectionGroup-Sammlung

Abrufen aller Abschnittsgruppen von allen Notizbüchern, die sich im Besitz des Benutzers befinden, einschließlich verschachtelter Abschnittsgruppen

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

Alle Sektionsgruppen abrufen, 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, parentNotebookund parentSectionGroup erweitern.

Die Standard-Sortierreihenfolge für Abschnittsgruppen ist name asc.

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


SectionGroup-Entität

Abrufen einer bestimmten Abschnittsgruppe

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


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

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


Notebook-Sammlung

Alle Notizbücher abrufen, die dem Benutzer gehören

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

Sie können den classNotebooks Endpunkt verwenden, um Kurs-Notizbücher abzurufen.


Notizbuch-Entität

Ein bestimmtes Notizbuch abrufen

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


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

Sie können den classNotebooks Endpunkt verwenden, um ein Kurs-Notizbuch abzurufen.


Bild- oder andere Datei-Ressource

Abrufen der Binärdaten einer bestimmten Ressource

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


Die Ressourcen-URI der Datei finden Sie in der Seite Ausgabe-HTML.

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 Datei-Ressource im Attribut data. Beispiel:

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

Um öffentliche, vorauthentifizierte URLs für die Bildressourcen auf einer Seite zu erhalten, fügen Sie preAuthenticated=true in die Abfragezeichenfolge ein, wenn Sie den Seiteninhalt abrufen (Beispiel: GET ../pages/{page-id}/content?preAuthenticated=true). Die öffentlichen URLs, die im Ausgabe-HTML-Code zurückgegeben werden, sind eine Stunde lang gültig. Ohne dieses Flag können Bilder nicht direkt in einem Browser gerendert werden, da sie wie die restlichen Seiteninhalte privat sind und eine Autorisierung erforderlich ist, um sie abzurufen.

Eine Sammlung von Ressourcen wird nicht unterstützt.

Wenn Sie eine Datei-Ressource erhalten, müssen Sie keinen Accept Inhaltstyp in die Anforderung aufnehmen.

Weitere Informationen über GET-Anforderungen finden Sie unter GET Pages, GET Sections, GET SectionGroupsund GET Notebooks im OneNote-API interaktiven REST-Verweis.

Beispiele für GET-Anforderungen

Sie können nach OneNote-Elementen und Seiteninhalten suchen, um genau die Informationen zu erhalten, die Sie benötigen. Die folgenden Beispiele zeigen einige Möglichkeiten, wie Sie unterstützte Abfrage-Zeichenfolgeoptionen in GET-Anforderungen an die OneNote-API verwenden können.

Denken Sie daran:

  • Alle GET-Anforderungen beginnen mit der Stamm-URL des Diensts.
      Beispiele: https://www.onenote.com/api/v1.0/me/notes
                      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 Eigenschaftsnamen und OData-Zeichenfolge-Vergleichen wird zwischen Groß- und Kleinschreibung unterschieden. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.
      Beispiel: filter=tolower(name) eq 'spring'

search & filter

Abrufen aller Seiten, die den Begriff recipe enthalten und von einer bestimmten App erstellt wurden. (search ist nur für Verbraucher-Notizbücher verfügbar)

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

search & 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 Verbraucher-Notizbücher verfügbar)

[GET] ../pages?search=golgi app&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)

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.

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

Alle Seiten in einem bestimmten Notizbuch abrufen. Die API gibt standardmäßig 20 Einträge zurück.

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

Abrufen des Namens und des pagesUrl-Links für alle Abschnitte aus dem Notizbuch School. 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 nach letztem Änderungsdatum.

[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 Einträge zurück.

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

search & filter & top

Abrufen der fünf neuesten Seiten, die seit dem 1. Januar 2015 erstellt wurden und die den Ausdruck cell division enthalten. Die API gibt standardmäßig 20 und maximal 100 Einträge zurück. Die Standardsortierreihenfolge für Seiten ist lastModifiedTime desc. (search ist nur für Verbraucher-Notizbücher verfügbar)

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

search & filter & top & skip

Abrufen der nächsten fünf Seiten im Resultset. (search ist nur für Verbraucher-Notizbücher verfügbar)

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

Und der nächsten fünf. (search ist nur für Verbraucher-Notizbücher verfügbar)

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

Wenn search und filter auf dieselbe Anforderung angewendet werden, enthält das Ergebnis 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

GET-Anforderungen für Seiten, die die Standardanzahl von Einträgen abrufen (d.h., sie enthalten keinen top-Ausdruck), gebenen einen @odata.nextLink-Link in der Antwort zurück, mit dem Sie die nächsten 20 Einträge abrufen können.

Unterstützte Optionen für OData-Abfragezeichenfolgen

Wenn Sie GET-Anfragen an die OneNote-API senden, können Sie OData-Abfrage-Zeichenfolgenoptionen verwenden, um Ihre Abfrage anzupassen und genau die Informationen zu erhalten, die Sie benötigen. Sie können auch eine Leistungssteigerung erzielen, indem die Anzahl der Aufrufe an den Dienst und die Größe der Antwortnutzlast reduziert wird.

Aus Gründen der Lesbarkeit verwenden die Beispiele in diesem Artikel nicht die %20-Prozent-Codierung, die für Leerzeichen in der URL-Abfrage-Zeichenfolge erforderlich ist: filter=isDefault%20eq%20true

AbfrageoptionBeispiel und Beschreibung
count

count=true

Die Anzahl der Einträge in der Auflistung. 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 den Eigenschaftsnamen wird zwischen Groß- und Kleinschreibung unterschieden.

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
- Zeichenfolge-Funktionen: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

Bei Eigenschaftsnamen und OData-Zeichenfolge-Vergleichen wird zwischen Groß- und Kleinschreibung unterschieden. 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 den Eigenschaftsnamen wird zwischen Groß- und Kleinschreibung unterschieden.

search

search=cell div

Nur für Verbraucher-Notizbücher verfügbar.

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.

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. Suchbegriffe sind unabhängig von Groß- und Kleinschreibung.

Gilt nur für Seiten in Notizbüchern, die dem Benutzer gehören (nicht für den Benutzer freigegeben). Indizierte Inhalte sind privat und nur für den Besitzer zugänglich. Passwortgeschützte Seiten werden nicht indiziert. Gilt nur für den Endpunkt pages.

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 den Eigenschaftsnamen wird zwischen Groß- und Kleinschreibung unterschieden.

skip

skip=10

Die Anzahl der Einträge, die im Resultset übersprungen werden sollen. Wird typischerweise für Paging-Ergebnisse verwendet.

Nach oben

top=50

Die Anzahl der zurückzugebenden Einträge im Resultset, maximal 100. Der Standardwert ist 20.

OneNote bietet auch die Abfrage-Zeichenfolgeoption pagelevel, mit der Sie die Ebene und Reihenfolge der Seiten innerhalb des übergeordneten Abschnitts ermitteln können. Gilt nur für Abfragen für Seiten in einem bestimmten Abschnitt oder für Abfragen für eine bestimmte Seite. Beispiel:

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

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

Unterstützte OData-Operatoren und -Funktionen

Die OneNote-API unterstützt die folgenden OData-Operatoren und Funktionen in filter -Ausdrücken. Wenn Sie OData-Ausdrücke verwenden, denken Sie daran:

  • Leerzeichen in der URL-Abfagezeichenfolge müssen durch die Codierung %20 ersetzt werden.
      Beispiel: filter=isDefault%20eq%20true
  • Bei Eigenschaftsnamen und OData-Zeichenfolge-Vergleichen wird zwischen Groß- und Kleinschreibung unterschieden. Wir empfehlen die Verwendung der OData-Funktion tolower für Zeichenfolgenvergleiche.
      Beispiel: filter=tolower(name) eq 'spring'
VergleichsoperatorBeispiel
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 OperatorBeispiel
undcreatedTime le 2014-01-30 and createdTime gt 2014-01-23
odercreatedByAppId eq '{app-id}' or createdByAppId eq '{app-id}'
notnot contains(tolower(title),'school')
String-FunktionBeispiel
containscontains(tolower(title),'spring')
endswithendswith(tolower(title),'spring')
startswithstartswith(tolower(title),'spring')
lengthlength(title) eq 19
indexofindexof(tolower(title),'spring') eq 1
substringsubstring(tolower(title),1) eq 'spring'
tolowertolower(title) eq 'spring'
touppertoupper(title) eq 'SPRING'
trimtrim(tolower(title)) eq 'spring'
concatconcat(title,'- by MyRecipesApp') eq 'Carrot Cake Recipe - by MyRecipesApp'

Eigenschaften von Seiten, Abschnitten, Abschnittsgruppen und Notizbüchern

Die Abfrageausdrücke filter, select, expand und orderby können Eigenschaften von OneNote-Elementen enthalten. Beispiel:

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

Bei den Eigenschaftsnamen wird bei Abfrageausdrücken zwischen Groß- und Kleinschreibung unterschieden.

Die Liste der Eigenschaften und Eigenschaftsarten finden Sie unter:

Die Abfragezeichenfolgenoption expand kann mit folgenden Navigationseigenschaften verwendet werden:

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

Anfrage- und Antwortinformationen für GET-Anforderungen

AnforderungsdatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Header „Authorization“

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung und Berechtigungen.

Header „Accept“

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

- text/html für Seiteninhalte

AntwortdatenBeschreibung
ErfolgscodeHTTP-Statuscode 200.
AntworttextEine OData-Darstellung der Entität oder Entität im JSON-Format, der Seite HTML oder der Datei-Ressourcen-Binärdaten.
FehlerWenn 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 Datums-Headers verwenden, wenn Sie mit Microsoft-Support arbeiten, um Probleme zu beheben.

Erstellen der OneNote-Stamm-Dienst-URL

Die Stamm-URL des OneNote-Diensts verwendet das folgende Format für alle Aufrufe der OneNote-API.

https://www.onenote.com/api/{version}/{location}/notes/


Das version Segment in der URL steht für die Version der OneNote-API, die Sie verwenden möchten.

  • 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 sie nicht in Ihrem Produktionscode verwenden sollten.


Das location Segment in der URL steht für den Auftenhaltsort der Notebooks, auf die Sie zugreifen möchten.

Notebooks auf OneDrive (Consumer)
Verwenden Sie me für OneNote-Inhalt, auf den der aktuelle Benutzer zugreifen kann (eigene und freigegebene Inhalte).

Notebooks auf OneDrive for Business
Verwenden Sie me für OneNote-Inhalte, die dem aktuellen Benutzer gehören.

Verwenden Sie users/{id} für OneNote-Inhalte, die der (in der URL) angegebene Benutzer für den aktuellen Benutzer freigegeben hat. Verwenden Sie die Azure AD Graph API, um Benutzer-IDs zu erhalten.

SharePoint Website-Notebooks
Teamwebsites und andere SharePoint-Websites können OneNote-Notebooks in ihren Dokumentbibliotheken enthalten.

Verwenden Sie myOrganization/siteCollections/{id}/sites/{id} für OneNote-Inhalte auf einer Website des Mandanten, bei dem der aktuelle Benutzer angemeldet ist. Es wird nur der aktuelle Mandant unterstützt, auf den über das Schlüsselwort myOrganization zugegriffen wird. Erfahren Sie, wie Sie Website-IDs erhalten.

Office 365 Gruppen-Notebooks
Office 365 Gruppen sind Teil der vernetzten Office 365 Erfahrung. Gruppenmitglieder können Notebooks, Dateien und E-Mails freigeben.

Verwenden Sie myOrganization/groups/{id} für OneNote-Inhalte in der angegebenen Gruppe, in der der aktuelle Benutzer Mitglied ist. Office 365 Gruppen (die den vereinheitlichten groupType zurückgeben) sind der einzige unterstützte Gruppentyp. Verwenden Sie die Azure AD Graph API, um Gruppen-IDs zu erhalten.


Verwenden Sie die Methode FromUrl, um die Websitesammlung und die Site-IDs zu erhalten

Sie können die Methode FromUrl verwenden, um die Websitesammlung und die Site-IDs für eine angegebene absolute Site-URL zu erhalten. Sie sollten diesen Aufruf nur bei Bedarf durchführen und dann die Werte für die zukünftige Verwendung speichern.

Das Format der Site-URL hängt von Ihrer Konfiguration ab, zum Beispiel https://domain.sharepoint.com/site-a oder https://domain.com/sites/site-a.

Beispielanfrage:

GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')
Authorization: Bearer {token}
Accept: application/json

Beispielantwort:

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.SiteMetadata",
  "siteCollectionId":"09d1a587-a84b-4264-3d15-669429be8cc5",
  "siteId":"d9e4d5c8-683f-4363-89ae-18c4e3da91e9"
}

Voraussetzungen für die Verwendung von FromUrl und die Arbeit mit SharePoint Site Notebooks:

  • Sie können nur OneNote-Notebooks, Abschnittsgruppen, Abschnitte und Seiten auf Websites erstellen, die über eine Standarddokumentbibliothek verfügen. (Einige Site-Vorlagen erstellen keine Standarddokumentbibliothek.) GET-Anfragen liefern jedoch OneNote-Inhalte aus allen Dokumentbibliotheken auf der Website.
  • Die Stamm-Url des OneNote-Diensts ist unveränderlich, d. h. Sie können keinen SharePoint REST-API-Site-Pfad verwenden und dann den notes Endpunkt darauf anheften.
  • Der Benutzer, in dessen Namen Sie aufrufen, muss Mitglied der Site sein.
  • FromUrl arbeitet nur mit indizierten Sites. Es kann mehrere Stunden dauern, eine neue Site zu indizieren.

Berechtigungen für GET-Anforderungen

Um den Inhalt oder die Struktur von OneNote zu erhalten, müssen Sie die entsprechenden Berechtigungen anfordern.

Die folgenden Bereiche erlauben GET-Anforderungen an die OneNote-API. Wählen Sie die unterste Ebene an Berechtigungen aus, die Ihre App für ihre Arbeit benötigt.

PlattformBerechtigungsbereich
Verbraucheroffice.onenote, office.onenote_update_by_app, office.onenote_update
UnternehmenNotes.Read, Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, Notes.ReadWrite.All

Weitere Informationen zu Berechtigungsbereichen und deren Funktionsweise finden Sie unter OneNote-Berechtigungsbereiche.

Weitere Ressourcen

© 2018 Microsoft