Mit Mitarbeiter-Notebooks arbeiten

  • Artikel

Gilt für: Unternehmensnotizbücher auf Office 365

Schulen, Hochschulen und Universitäten weltweit nutzen Mitarbeiter-Notebooks, um Produktivität, Engagement und Zusammenarbeit zu fördern.

Sie können den Mitarbeiter-Notebooks-Endpunkt verwenden, um allgemeine Aufgaben für Mitarbeiter-Notebooks durchzuführen, wie das Erstellen von Mitarbeiter-Notebooks und das Hinzufügen oder Entfernen von Führungskräften oder Mitgliedern.

Hinweis

Die OneNote-API stellt den Mitarbeiter-Notebooks -Endpunkt für Operationen zur Verfügung, die speziell für Mitarbeiter-Notebooks sind.

Zusammensetzen des Anforderungs-URI

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

  2. Fügen Sie den Mitarbeiter-Notebooks-Endpunkt hinzu, gefolgt von einem Ressourcenpfad, wie benötigt:

    Erstellen von Mitarbeiter-Notebooks

    ../staffNotebooks[?omkt,sendemail]

    Aktualisieren eines Mitarbeiter-Notebooks

    ../staffNotebooks/{notebook-id}

    Ein oder mehrere Mitarbeiter-Notebooks erhalten

    ../staffNotebooks

    ../staffNotebooks/{notebook-id}

    Löschen eines Mitarbeiter-Notebooks

    ../staffNotebooks/{notebook-id}

    Mitglieder oder Führungskräfte hinzufügen

    ../staffNotebooks/{notebook-id}/members

    ../staffNotebooks/{notebook-id}/leaders

    Mitglieder oder Führungskräfte entfernen

    ../staffNotebooks/{notebook-id}/members/{member-id}

    ../staffNotebooks/{notebook-id}/leaders/{leader-id}

    Bereiche einfügen

    ../staffNotebooks/{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/staffNotebooks/{id}/leaders/{id}

https://www.onenote.com/api/v1.0/users/{id}/notes/staffNotebooks/{id}/members

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

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

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

Hinweis

Weitere Informationen zur Stamm-URL des Service finden Sie unter diesem Link.

Erstellen von Mitarbeiter-Notebooks

Um ein Mitarbeiter-Notebook zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt Mitarbeiter-Notebooks.

POST ../staffNotebooks[?omkt,sendemail]

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

{
    "name": "notebook-name",
    "memberSections": [ 
        "section1-name", 
        "section2-name"
    ],
    "leaders": [
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        }
    ],
    "members": [
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group" 
        },
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        },
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        }
   ], 
   "hasLeaderOnlySectionGroup": true
}
Parameter Beschreibung
Name Der Name des Notizbuchs.
MitgliedBereiche Ein Array, das einen oder mehrere Bereichsnamen enthält. Diese Bereiche werden in der Bereichsgruppe jedes Mitglieds angelegt.
Führungskräfte Ein Array, das ein oder mehrere Hauptobjekte enthält.
Elemente Ein Array, das ein oder mehrere Hauptobjekte enthält. Für jedes Mitglied wird eine Bereichsgruppe angelegt.
hasLeaderOnlySectionGroup true um eine nur Führungskraft-Bereichsgruppe zu erstellen, die nur für Führungskräfte sichtbar ist.
omkt URL-Abfrageparameter, der die Sprache für das Notizbuch angibt. Der Standardwert lautet en-us. Beispiel: ?omkt=es-es
EMailSenden URL-Abfrageparameter, der angibt, ob beim Erstellen des Notebooks eine E-Mail-Benachrichtigung an die dem Notebook zugeordneten Führungskräfte und Mitglieder gesendet werden soll. Der Standardwert lautet false.

Führungskräfte und Mitglieder werden durch Hauptobjekte repräsentiert, die die folgenden Eigenschaften enthalten:
Parameter Beschreibung
ID Der Hauptname des Office 365-Benutzers.

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

Unterstützte Sprachen

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

POST ../staffNotebooks?omkt=de-de

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

Code Sprache
bg-bg Български (Bulgarien)
cs-cz Čeština (Tschechiche Republik)
da-dk Dansk (Dänemark)
de-de Deutsch (Deutschland)
el-gr Ελληνικά (Griechenland)
en-us Deutsch (Deutschland)
es-es Español (Spanien)
et-ee Eesti (Estland)
fi-fi Suomi (Finnland)
fr-fr Französisch (Frankreich)
hi-in हिंदी (Indien)
hr-hr Hrvatski (Kroatien)
hu-hu Magyar (Ungarn)
id-id Bahasa Indonesien (Indonesien)
it-it Italiano (Italien)
ja-jp 日本語 (Japan)
kk-kz Қазақ (Kasachstan)
ko-kr 한국어 (Korea)
lt-lt Lietuvių (Litauen)
lv-lv Latviešu (Lettland)
ms-my Bahasa Melayu (Indonesien)
nb-no Norsk (Norwegen)
nl-nl Niederländisch (Niederlande)
pl-pl Polski (Polen)
pt-br Português (Brasilien)
pt-pt Portugiesisch (Portugal)
ro-ro Română (Rumänien)
ru-ru Русский (Russland)
sk-sk Slovenčina (Republik Slowakei)
sl-si Slowenisch (Slowenien)
sr-Latn-RS Srpski (Serbien und Montenegro)
sv-se Svenska (Schweden)
th-th ไทย (Thailand)
tr-tr Türkçe (Türkei)
uk-ua Українська (Ukraine)
vi-vn Tiếng Việt (Vietnam)
zh-cn 简体中文 (China)
zh-tw 繁體中文 (China)

Beispiel

Die folgende Anfrage erzeugt ein Mitarbeiter-Notebook mit dem Namen Mitarbeiterbesprechungen.

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

{
    "name": "Staff Meetings",
    "memberSections": [
        "Staff Notes",
        "Meeting Summaries",
    ],
    "leaders": [
        {
            "id": "leader1@contoso.com",
            "principalType": "Person"
        }
    ],
    "members": [
        {
            "id": "member1@contoso.com",
            "principalType": "Person"
        },
        {
            "id": "member2@contoso.com",
            "principalType": "Person" 
        },
        {
            "id": "member3@contoso.com",
            "principalType": "Person"
        },
        {
            "id": "member4@contoso.com",
            "principalType": "Person"
        }
    ],
    "hasLeaderOnlySectionGroup": true
}

Dadurch wird ein Notizbuch mit vier Bereichsgruppen erstellt, die jeweils einen Abschnitt Handzettel, Mitarbeiter-Notizen und Besprechungs-Zusammenfassungen enthalten. Die für jedes Mitglied erstellte Bereichsgruppe ist nur für das Mitglied und die Führungskraft zugänglich. Außerdem wird eine nur Führungskraft-Bereichsgruppe erstellt, die nur für die Führungskraft sichtbar ist. Der Abfrageparameter sendemail=true gibt an, dass eine E-Mail-Benachrichtigung an die Führungskraft und die Mitglieder gesendet wird, wenn das Notebook erstellt wird.

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für POST /staffNotebooks Anforderungen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Content-Type“ application/json
Header „Accept“ application/json
Berechtigungsbereich Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode HTTP-Statuscode 201.
Antworttext Eine OData-Darstellung des neuen Notebooks im JSON-Format.

Neben regulären Notebook-Eigenschaftenhaben Mitarbeiter-Notebooks auch die folgenden Eigenschaften:
  • MitgliedBereiche. Die Mitgliedbereiche in den Notebooks.
  • Führungskräfte. Die Führungskräfte, die auf das Notebook zugreifen können.
  • Mitglied. Die Mitglieder, die auf das Notebook zugreifen können.
  • hasLeaderOnlySectionGroup. true wenn das Notebook eine nur Führungskraft-Bereichsgruppe enthält, sonst false.
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 Datums-Headers verwenden, wenn Sie mit Microsoft-Support arbeiten, um Probleme zu beheben.

Mitarbeiter-Notebooks aktualisieren

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

Hinweis

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

PATCH ../staffNotebooks/{notebook-id}

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

{
    "hasLeaderOnlySectionGroup": true
}
Parameter Beschreibung
hasLeaderOnlySectionGroup true um eine nur Führungskraft-Bereichsgruppe zu erstellen, die nur für Führungskräfte sichtbar ist. false wird nicht unterstützt.

Siehe diese Methoden für andere Möglichkeiten zum Ändern von Notebooks: Mitglieder oder Führungskräfte hinzufügen, Mitglieder oder Führungskräfte entfernen, Bereiche einfügen.

Beispiel

Die folgende Anfrage fügt eine nur Führungskraft-Bereichsgruppe zum angegebenen Mitarbeiter-Notebook hinzu.

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

{
    "hasLeaderOnlySectionGroup": true
}

Die neue Bereichsgruppe nur Führungskraft ist nur für Führungskräfte sichtbar.

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für PATCH ../staffNotebooks/{notebook-id} Anforderungen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Content-Type“ application/json
Header „Accept“ application/json
Berechtigungsbereich Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode Ein 204 HTTP-Statuscode.
Fehler Wenn die Anfrage fehlschlägt, gibt die API Fehler 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.

Mitarbeiter-Notebooks erhalten

Um ein oder mehrere Mitarbeiter-Notebooks zu erhalten, senden Sie eine GET-Anfrage an den Endpunkt MitarbeiterNotebooks .

Ein oder mehrere Mitarbeiter-Notebooks erhalten

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

Ein bestimmtes Mitarbeiter-Notebook erhalten

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

Notebooks können die Eigenschaften leaders und members erweitern. Die Standardsortierreihenfolge ist name asc.

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

Beispiel

Die folgende Anfrage erhält Mitarbeiter-Notebooks, die seit dem 1. Januar 2016 erstellt wurden.

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

Weitere Informationen zum Abrufen von Notebooks, einschließlich der unterstützten Abfrage zu Optionen der Zeichenfolge und Beispiele, finden Sie unter Get OneNote Inhalt and Struktur.

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für GET /staffNotebooks Anforderungen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Accept“ application/json
Berechtigungsbereich Notes.Read, Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode HTTP-Statuscode 200.
Antworttext Eine OData-Darstellung der Mitarbeiter-Notebooks im JSON-Format.

Neben regulären Notebook-Eigenschaftenhaben Mitarbeiter-Notebooks auch die folgenden Eigenschaften:
  • MitgliedBereiche. Die Mitgliedbereiche in den Notebooks.
  • Führungskräfte. Die Führungskräfte, die auf das Notebook zugreifen können.
  • Mitglied. Die Mitglieder, die auf das Notebook zugreifen können.
  • hasLeaderOnlySectionGroup. true wenn das Notebook eine nur Führungskraft-Bereichsgruppe enthält, sonst false.
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 Datums-Headers verwenden, wenn Sie mit Microsoft-Support arbeiten, um Probleme zu beheben.

Mitarbeiter-Notebooks löschen

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

DELETE ../staffNotebooks/{notebook-id}

Beispiel

Die folgende Anfrage löscht das angegebene Mitarbeiter-Notebook.

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

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für DELETE ../staffNotebooks/{notebook-id} Anforderungen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Accept“ application/json
Berechtigungsbereich Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode Ein 204 HTTP-Statuscode.
Fehler Wenn die Anfrage fehlschlägt, gibt die API Fehler 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.

Mitglieder und Führungskräfte hinzufügen

Das Hinzufügen von Führungskräften und Mitgliedern ermöglicht ihnen den Zugriff auf das Mitarbeiter-Notebook. Durch das Hinzufügen eines Mitglieds wird auch eine Mitglied-Bereichsgruppe erstellt. Diese Bereichsgruppe ist nur für das Mitglied und die Führungskraft zugänglich und enthält die für das Notebook definierten Bereiche.

Um ein Mitglied oder eine Führungskraft zu einem Notebook hinzuzufügen, senden Sie eine POST-Anfrage an den entsprechenden Endpunkt.

Ein Mitglied hinzufügen

POST ../staffNotebooks/{notebook-id}/members

Eine Führungskraft hinzufügen

POST ../staffNotebooks/{notebook-id}/leaders

Senden Sie ein JSON-Hauptobjekt im Nachrichtentext. Sie können pro Anfrage ein Mitglied oder eine Führungskraft hinzufügen.

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

Führungskräfte und Mitglieder werden durch Hauptobjekte repräsentiert, die die folgenden Eigenschaften enthalten:

Parameter Beschreibung
ID Der Hauptname des Office 365-Benutzers. Siehe Azure AD Graph API-Dokumentation, um mehr über Benutzer und Gruppen zu erfahren.
principalType Person oder Group

Beispiel

Die folgende Anfrage fügt dem angegebenen Mitarbeiter-Notebook eine Führungskraft hinzu.

POST ../v1.0/users/{leader-id}/notes/staffNotebooks/{notebook-id}/leaders 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

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

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für POST /members und POST /leaders-Anfragen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Content-Type“ application/json
Header „Accept“ application/json
Berechtigungsbereich Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode HTTP-Statuscode 201.
Antworttext Das Mitglied oder die Führungskraft, die hinzugefügt wurden.
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 Datums-Headers verwenden, wenn Sie mit Microsoft-Support arbeiten, um Probleme zu beheben.

Mitglieder oder Führungskräfte entfernen

Das Entfernen von Mitgliedern und Führungskräften aus einem Mitarbeiter-Notebook entzieht ihnen den Zugriff auf das Notiebook, löscht aber keinen Inhalt.

Um ein Mitglied oder eine Führungskraft aus einem Notebook zu entfernen, senden Sie eine DELETE-Anfrage an den entsprechenden Endpunkt.

Mitglied entfernen

DELETE ../staffNotebooks/{notebook-id}/members/{member-id}

Eine Führungskraft entfernen

DELETE ../staffNotebooks/{notebook-id}/leaders/{leader-id}

Sie können pro Anfrage ein Mitglied oder eine Führungskraft entfernen.

Beispiel

Die folgende Aufforderung entfernt das angegebene Mitglied aus dem angegebenen Mitarbeiter-Notebook.

DELETE ../v1.0/users/{leader-id}/notes/staffNotebooks/{notebook-id}/members/{member-id} 
Authorization: Bearer {token}
Accept: application/json

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für DELETE /members und DELETE /leaders-Anfragen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Accept“ application/json
Berechtigungsbereich Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode Ein 204 HTTP-Statuscode.
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 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-Notebooks zu kopieren und in die Inhaltsbibliothek eines Mitarbeiter-Notebooks einzufügen. Eine Inhaltsbibliothek ist eine Bereichsgruppe innerhalb des Mitarbeiter-Notebooks, die Lese-/Schreibrechte für Führungskräfte und Leserechte für Mitglieder hat.

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

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

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

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

Der Benutzer muss Zugang zu den Zielabschnitten und dem Notebook (im Besitz oder gemeinsam genutzt) haben. Alle Ziele müssen im selben Mandanten sein.

Beispiel

Die folgende Anfrage fügt zwei Abschnitte in die Inhaltsbibliothek des angegebenen Mitarbeiter-Notebooks ein.

POST ../v1.0/me/notes/staffNotebooks/{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- and Antwortinformationen

Die folgenden Informationen gelten für POST /copySectionsToContentLibrary Anforderungen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).
Header „Content-Type“ application/json
Header „Accept“ application/json
Berechtigungsbereich Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All


Antwortdaten Beschreibung
Erfolgscode Ein 201 HTTP-Statuscode.
Fehler Wenn die Erstellungsanfrage fehlschlägt, gibt die API Fehler 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 Sie die OneNote-Stamm-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 es nicht in Ihrem Produktionscode verwenden sollten.

Das location Segment in der URL steht für den Aufenthaltsort der Notizbücher, 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 der 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.

  • Vereinheitlichte Gruppen-Notebooks

    • Einheitliche Gruppen (auch als Office 365-Gruppenbezeichnet) sind Bestandteil 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. Einheitliche Gruppen 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.

Beispielanforderung

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.

Siehe auch