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

Mit Kursnotizbüchern arbeiten

Gilt für: Unternehmensnotizbücher auf Office 365

Schulen, Hochschulen und Universitäten weltweit nutzen Kursnotizbücher, um Produktivität, Engagement und Zusammenarbeit zu fördern. Sie können Kursnotizbücher für jeden Kurs, jedes Projekt, jeden Begriff und jede Zuordnung verwenden.

Sie können den classNotebooks-Endpunkt verwenden, um allgemeine Aufgaben für Kursnotizbücher durchzuführen, wie das Erstellen von Kursnotizbüchern und das Hinzufügen oder Entfernen von Kursteilnehmern.

Die OneNote-API stellt den classNotebooks-Endpunkt für Operationen zur Verfügung, die speziell für Kursnotizbücher sind.

Erstellen der URI-Anforderung

Um die URI-Anforderung zu erstellen, beginnen Sie mit der Stamm-Dienst-URL für Ihre Plattform:

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 classNotebooks-Endpunkt hinzu, gefolgt von einem Ressourcenpfad, wie benötigt:

Kursnotizbücher erstellen

../classNotebooks[?omkt,sendemail]

Ein Kursnotizbuch aktualisieren

../classNotebooks/{notebook-id}

Ein oder mehrere Kursnotizbücher abrufen

../classNotebooks

../classNotebooks/{notebook-id}

Kursnotizbuch löschen

../classNotebooks/{notebook-id}

Kursteilnehmer oder Lehrer hinzufügen

../classNotebooks/{notebook-id}/students

../classNotebooks/{notebook-id}/teachers

Kursteilnehmer oder Lehrer entfernen

../classNotebooks/{notebook-id}/students/{student-id}

../classNotebooks/{notebook-id}/teachers/{teacher-id}

Bereiche einfügen

../classNotebooks/{notebook-id}/copySectionsToContentLibrary


Ihre vollständige Anfrage-URI wird ungefähr so aussehen wie in diesen Beispielen:

https://www.onenote.com/api/v1.0/me/notes/classNotebooks/{id}/teachers/{id}

https://www.onenote.com/api/v1.0/users/{id}/notes/classNotebooks/{id}/students

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

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/classNotebooks/{id}

https://www.onenote.com/api/v1.0/me/notes/classNotebooks/{id}/copySectionsToContentLibrary

Weitere Informationen zur Stamm-URL des Dienstes.

Kursnotizbücher erstellen

Um ein Kursnotizbuch zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt classNotebooks.

POST ../classNotebooks[?omkt,sendemail]

Senden Sie im Nachrichtentext ein JSON-Objekt mit den Erstellungsparametern des Kursnotizbuchs.

{
    "name": "notebook-name",
    "studentSections": [ 
        "section1-name", 
        "section2-name"
    ],
    "teachers": [
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        }
    ],
    "students": [
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group" 
        },
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        },
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        }
   ], 
   "hasTeacherOnlySectionGroup": true
}
ParameterBeschreibung
NameDer Name des Notizbuchs.
studentSectionsEin Array, das einen oder mehrere Bereichsnamen enthält. Diese Bereiche werden in der Abschnittsgruppe jedes Kursteilnehmers angelegt.
LehrerEin Array, das ein oder mehrere Hauptobjekte enthält.
KursteilnehmerEin Array, das ein oder mehrere Hauptobjekte enthält. Für jeden Kursteilnehmer wird eine Abschnittsgruppe angelegt.
hasTeacherOnlySectionGrouptrue um eine Nur Lehrer-Abschnittsgruppe zu erstellen, die nur für Lehrer sichtbar ist.
omktURL-Abfrageparameter, der die Sprache für das Notizbuch angibt. Der Standardwert lautet en-us. Beispiel: ?omkt=es-es
sendemailURL-Abfrageparameter, der angibt, ob beim Erstellen des Notizbuchs eine E-Mail-Benachrichtigung an die dem Notizbuch zugeordneten Lehrer und Kursteilnehmer gesendet werden soll. Der Standardwert lautet false.


Lehrer und Schüler werden durch Hauptobjekte repräsentiert, die die folgenden Eigenschaften enthalten:

ParameterBeschreibung
IDDer Hauptname des Office 365-Benutzers.

Siehe Azure AD Graph API-Dokumentation, um mehr über Benutzer und Gruppen zu erfahren.
principalTypePerson oder Group

Unterstützte Sprachen

Mit dem Parameter omkt={language-code} URL-Abfrage können Sie ein Kursnotizbuch in einer bestimmten Sprache erstellen. Zum Beispiel:

POST ../classNotebooks?omkt=de-de

Die folgenden Sprachcodes werden unterstützt. Die Voreinstellung ist en-us.

CodeSprache
bg-bgБългарски (Bulgarien)
cs-czČeština (Tschechiche Republik)
da-dkDansk (Dänemark)
de-deDeutsch (Deutschland)
el-grΕλληνικά (Griechenland)
en-usDeutsch (Deutschland)
es-esEspañol (Spanien)
et-eeEesti (Estland)
fi-fiSuomi (Finnland)
fr-frFranzösisch (Frankreich)
hi-inहिंदी (Indien)
hr-hrHrvatski (Kroatien)
hu-huMagyar (Ungarn)
id-idBahasa Indonesien (Indonesien)
it-itItaliano (Italien)
ja-jp日本語 (Japan)
kk-kzҚазақ (Kasachstan)
ko-kr한국어 (Korea)
lt-ltLietuvių (Litauen)
lv-lvLatviešu (Lettland)
ms-myBahasa Melayu (Indonesien)
nb-noNorsk (Norwegen)
nl-nlNiederländisch (Niederlande)
pl-plPolski (Polen)
pt-brPortuguês (Brasilien)
pt-ptPortugiesisch (Portugal)
ro-roRomână (Rumänien)
ru-ruРусский (Russland)
sk-skSlovenčina (Republik Slowakei)
sl-siSlowenisch (Slowenien)
sr-Latn-RSSrpski (Serbien und Montenegro)
sv-seSvenska (Schweden)
th-thไทย (Thailand)
tr-trTürkçe (Türkei)
uk-uaУкраїнська (Ukraine)
vi-vnTiếng Việt (Vietnam)
zh-cn简体中文 (China)
zh-tw繁體中文 (China)

Beispiel

Die folgende Anfrage erzeugt ein Kursnotizbuch mit dem Namen Math 101.

POST ../v1.0/users/{teacher-id}/notes/classNotebooks?sendemail=true
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "name": "Math 101",
    "studentSections": [
        "Handouts",
        "Class Notes",
        "Homework",
        "Quizzes"
    ],
    "teachers": [
        {
            "id": "teacher1@contoso.com",
            "principalType": "Person"
        }
    ],
    "students": [
        {
            "id": "student1@contoso.com",
            "principalType": "Person"
        },
        {
            "id": "student2@contoso.com",
            "principalType": "Person" 
        },
        {
            "id": "student3@contoso.com",
            "principalType": "Person"
        },
        {
            "id": "student4@contoso.com",
            "principalType": "Person"
        }
    ],
    "hasTeacherOnlySectionGroup": true
}

Dadurch wird ein Kursnotizbuch mit vier Kursteilnehmerabschnittsgruppen erstellt, die jeweils einen Handzettel-, Kursnotizen-, Hausaufgaben- und Quizbereich enthalten. Die für jeden Kursteilnehmer erstellte Abschnittsgruppe ist nur für den Kursteilnehmer und den Lehrer zugänglich. Außerdem wird eine Nur Lehrer-Abschnittsgruppe erstellt, die nur für den Lehrer sichtbar ist. Der Abfrageparameter sendemail=true gibt an, dass eine E-Mail-Benachrichtigung an die Lehrer und die Kursteilnehmer gesendet wird, wenn das Notizbuch erstellt wird.

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für POST /classNotebooks -Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Content-Type-Headerapplication/json
Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 201 HTTP-Statuscode.
AntworttextEine OData-Darstellung des neuen Notizbuchs im JSON-Format.

Neben regulären Notizbuch-Eigenschaftenhaben Kursnotizbücher auch die folgenden Eigenschaften:
  • studentSections. Die Kursteilnehmerabschnitte in den Notizbüchern.
  • Lehrer. Die Lehrer, die auf das Notizbuch zugreifen können.
  • Kursteilnehmer. Die Kursteilnehmer, die auf das Notizbuch zugreifen können.
  • hasTeacherOnlySectionGroup. true wenn das Notizbuch eine Nur Lehrer-Abschnittsgruppe enthält, sonst false.
FehlerWenn die Anfrage fehlschlägt, gibt die API Fehler im Objekt @api.diagnostics im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Kursnotizbücher aktualisieren

Um ein Kursnotizbuch zu aktualisieren, senden Sie eine PATCH-Anfrage an den Endpunkt classNotebooks/{notebook-id}.

Derzeit kann nur die Eigenschaft hasLeaderOnlySectionGroup in einer PATCH-Anfrage aktualisiert werden.

PATCH ../classNotebooks/{notebook-id}

Senden Sie im Nachrichtentext ein JSON-Objekt mit dem Aktualisierungsparameter.

{
    "hasTeacherOnlySectionGroup": true
}
ParameterBeschreibung
hasTeacherOnlySectionGrouptrue um eine Nur Lehrer-Abschnittsgruppe zu erstellen, die nur für Lehrer sichtbar ist. false wird nicht unterstützt.

Siehe diese Methoden für andere Möglichkeiten, um Kursnotizbücher zu ändern: Kursteilnehmer oder Lehrer hinzufügen, Kursteilnehmer oder Lehrer entfernen, Abschnitte einfügen.

Beispiel

Die folgende Anfrage fügt eine Nur Lehrer -Abschnittsgruppe zum angegebenen Kursnotizbuch hinzu.

PATCH ../v1.0/users/{teacher-id}/notes/classNotebooks/{notebook-id}
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "hasTeacherOnlySectionGroup": true
}

Die neue Abschnittsgruppe Nur Lehrer ist nur für Lehrer sichtbar.

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für PATCH ../classNotebooks/{notebook-id} -Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Content-Type-Headerapplication/json
Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 204 HTTP-Statuscode.
FehlerWenn die Anforderung fehlschlägt, gibt die API Fehler im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Kursnotizbücher abrufen

Um ein oder mehrere Kursnotizbücher abzurufen, senden Sie eine GET-Anfrage an den Endpunkt classNotebooks.

Ein oder mehrere Kursnotizbücher abrufen

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

Ein bestimmtes Kursnotizbuch abrufen

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


Notizbücher können die Eigenschaften teachers und students erweitern. Die Standardsortierreihenfolge ist name asc.

Kursnotizbücher werden auch für GET /notebooks -Anfragen zurückgegeben, aber die Ergebnisse enthalten keine Kursnotizbuch-spezifischen Eigenschaften.

Beispiel

Die folgende Anfrage erhält Kursnotizbücher, die seit dem 1. Januar 2016 erstellt wurden.

GET ../v1.0/users/{teacher-id}/notes/classNotebooks?filter=createdTime%20ge%202016-01-01 
Authorization: Bearer {token}
Accept: application/json

Weitere Informationen zum Abrufen von Notizbücher, einschließlich der unterstützten Abfrage zu Optionen der Zeichenfolge und Beispiele, finden Sie unter OneNote-Inhalt und -Struktur abrufen.

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für GET /classNotebooks -Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 200 HTTP-Statuscode.
AntworttextEine OData-Darstellung der Berechtigungen im JSON-Format.

Neben regulären Notizbuch-Eigenschaftenhaben Kursnotizbücher auch die folgenden Eigenschaften:
  • studentSections. Die Kursteilnehmerabschnitte in den Notizbüchern.
  • Lehrer. Die Lehrer, die auf das Notizbuch zugreifen können.
  • Kursteilnehmer. Die Kursteilnehmer, die auf das Notizbuch zugreifen können.
  • hasTeacherOnlySectionGroup. true wenn das Notizbuch eine Nur Lehrer-Abschnittsgruppe enthält, sonst false.
FehlerWenn die Anfrage fehlschlägt, gibt die API Fehler im Objekt @api.diagnostics im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Kursnotizbücher löschen

Um ein Kursnotizbuch zu löschen, senden Sie eine DELETE-Anfrage an den Endpunkt classNotebooks/{notebook-id}.

DELETE ../classNotebooks/{notebook-id}

Beispiel

Die folgende Anfrage löscht das angegebene Kursnotizbuch.

DELETE ../v1.0/users/{teacher-id}/notes/classNotebooks/{notebook-id} 
Authorization: Bearer {token}
Accept: application/json

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für DELETE ../classNotebooks/{notebook-id} -Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 204 HTTP-Statuscode.
FehlerWenn die Anforderung fehlschlägt, gibt die API Fehler im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Kursteilnehmer und Lehrer hinzufügen

Das Hinzufügen von Lehrern und Kursteilnehmern ermöglicht ihnen den Zugriff auf das Kursnotizbuch. Durch das Hinzufügen eines Kursteilnehmers wird auch eine Kursteilnehmerabschnittsgruppe angelegt. Diese Abschnittsgruppe ist nur für den Kursteilnehmer und den Lehrer zugänglich und enthält die für das Notizbuch definierten Abschnitte.

Um einen Kursteilnehmer oder Lehrer zu einem Kursnotizbuch hinzuzufügen, senden Sie eine POST-Anfrage an den entsprechenden Endpunkt.

Kursteilnehmer hinzufügen

POST ../classNotebooks/{notebook-id}/students

Einen Lehrer hinzufügen

POST ../classNotebooks/{notebook-id}/teachers


Senden Sie ein JSON-Hauptobjekt im Nachrichtentext. Sie können einen Kursteilnehmer oder einen Lehrer pro Anfrage hinzufügen.

{
    "id": "alias@tenant",
    "principalType": "Person-or-Group"
}

Lehrer und Schüler werden durch Hauptobjekte repräsentiert, die die folgenden Eigenschaften enthalten:

ParameterBeschreibung
IDDer Hauptname des Office 365-Benutzers. Siehe Azure AD Graph API-Dokumentation, um mehr über Benutzer und Gruppen zu erfahren.
principalTypePerson oder Group

Beispiel

Die folgende Anfrage fügt einen Lehrer zum angegebenen Kursnotizbuch hinzu.

POST ../v1.0/users/{teacher-id}/notes/classNotebooks/{notebook-id}/teachers 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "id": "teacher2@contoso.com",
    "principalType": "Person"
}

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für POST /students und POST /teachers-Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Content-Type-Headerapplication/json
Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 201 HTTP-Statuscode.
AntworttextDer Kursteilnehmer oder Lehrer, der hinzugefügt wurde.
FehlerWenn die Anfrage fehlschlägt, gibt die API Fehler im Objekt @api.diagnostics im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Kursteilnehmer oder Lehrer entfernen

Das Entfernen von Kursteilnehmern und Lehrern aus einem Kursnotizbuch entzieht ihnen den Zugriff auf das Notizbuch, löscht aber keine Inhalte.

Um einen Kursteilnehmer oder Lehrer aus einem Kursnotizbuch zu entfernen, senden Sie eine DELETE-Anfrage an den entsprechenden Endpunkt.

Entfernen eines Kursteilnehmers

DELETE ../classNotebooks/{notebook-id}/students/{student-id}

Einen Lehrer entfernen

DELETE ../classNotebooks/{notebook-id}/teachers/{teacher-id}


Sie können einen Kursteilnehmer oder einen Lehrer pro Anfrage entfernen.

Beispiel

Die folgende Anfrage entfernt den angegebenen Kursteilnehmer aus dem angegebenen Kursnotizbuch.

DELETE ../v1.0/users/{teacher-id}/notes/classNotebooks/{notebook-id}/students/{student-id} 
Authorization: Bearer {token}
Accept: application/json

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für DELETE /students und DELETE /teachers-Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 204 HTTP-Statuscode.
FehlerWenn die Anfrage fehlschlägt, gibt die API Fehler im Objekt @api.diagnostics im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Bereiche einfügen

Verwenden Sie copySectionsToContentLibrary, um bestimmte Abschnitte aus Office 365-Notizbuchs zu kopieren und in die Inhaltsbibliothek eines Kursnotizbuchs einzufügen. Eine Inhaltsbibliothek ist eine Bereichsgruppe im Kursnotizbuch, die Lese-/Schreibrechte für Lehrer und Leserechte für Kursteilnehmer hat.

Um Abschnitte in ein Notizbuch einzufügen, senden Sie eine POST-Anfrage an den copySectionsToContentLibrary-Endpunkt des Ziel-Notizbuchs. Zum Beispiel:

POST ../classNotebooks/{notebook-id}/copySectionsToContentLibrary

Senden Sie im Nachrichtentext ein JSON-Objekt mit dem Parameter sectionIds.

{
    "sectionIds": [
        "section1-id", 
        "section2-id",
        ...
    ]
}
ParameterBeschreibung
sectionIdsEin Array, das die IDs der Abschnitte enthält, die Sie in das Kursnotizbuch einfügen möchten.

Der Benutzer muss Zugang zu den Zielabschnitten und dem Notizbuch (Besitzer oder Freigegeben) haben. Alle Ziele müssen im selben Mandanten sein.

Beispiel

Die folgende Anfrage fügt zwei Abschnitte in die Inhaltsbibliothek des angegebenen Kursnotizbuchs ein.

POST ../v1.0/me/notes/classNotebooks/{notebook-id}/copySectionsToContentLibrary
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "sectionIds": [
        "1-85ba33b1-4959-4102-8dcd-d98e4e56e56f", 
        "1-8ba42j81-4959-4102-8dcd-d98e4e94s62ef"
    ]
}

Anforderungs- und Antwortinformationen

Die folgenden Informationen gelten für POST /copySectionsToContentLibrary -Anfragen.

Anfordern von DatenBeschreibung
ProtokollAlle Anforderungen verwenden das SSL/TLS HTTPS-Protokoll.
Autorisierungsheader

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 mit Azure AD (Unternehmensanwendungen).

Content-Type-Headerapplication/json
Accept-Headerapplication/json
BerechtigungsbereichNotes.ReadWrite.CreatedByApp, Notes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 201 HTTP-Statuscode.
FehlerWenn die Anfrage fehlschlägt, gibt die API Fehler im Antworttext zurück.
X-CorrelationId-HeaderEine GUID, die die Anforderung eindeutig identifiziert. Sie können diesen Wert zusammen mit dem Wert des Datum-Headers verwenden, wenn Sie mit dem Microsoft-Support arbeiten, um Probleme zu beheben.

Erstellen der OneNote-Stamm-Dienst-URL

Die Stamm-URL des OneNote-OneNote-ServiOneNote-OneNote-Services 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 einen stabilen Produktionscode.
  • Verwenden Sie beta, um ein Feature zu testen, das sich in der Entwicklung befindet. Funktionen und Funktionalität in der Betaversion ändern sich möglicherweise, sodass Sie es 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 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-Services 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.

Zusätzliche Ressourcen

© 2018 Microsoft