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

Erstellen von Teilen-Links auf OneNote-Entitäten

Gilt für: Enterprise Notebooks auf Office 365

Erstellen Sie einen Teilen-Link, um eine OneNote-Datei mit jedermann zu teilen. Sie können diese API verwenden, um anonyme Gastlinks zu erstellen, abzurufen und zu widerrufen. Die Gastlinks gewähren Bearbeitungsberechtigungen oder Ansichtsberechtigungen, ohne dass ein Login erforderlich ist.

GET ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink

POST ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

DELETE ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink

Teilen-Links werden für Office 365 Personal-, Site- und Gruppen-Notebooks unterstützt, nicht aber für Consumer-Notebooks auf OneDrive. Zur Zeit werden nur Sektionsgruppeneinheiten unterstützt.

Erstellen der URI-Anforderung

Um die URI-Anforderung zu erstellen, beginnen Sie mit der Dienst-Root-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/


Als nächstes fügen Sie den Pfad zur Abschnittsgruppen-Entität hinzu, gefolgt von den Teilen-Link-Funktionen.

Ihre vollständige Anfrage-URI wird ungefähr so aussehen wie diese Beispiele:

https://www.onenote.com/api/v1.0/me/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

https://www.onenote.com/api/v1.0/users/{id}/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/sections/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

Weitere Informationen zur Stamm-URL des Dienstes.

Um einen anonymen Link für eine Abschnittsgruppe zu erstellen, senden Sie eine GET-Anforderungen über den entsprechenden Endpunkt.

GET ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink

Der Funktionsparameter accessLevel enum gibt die Zugriffsebene des Teilen-Links an.

Parameter accessLevel enum-WerteDie Zugriffsebene des zu erstellenden Teilen-Links. Wählen Sie entweder Anzeigen oder Bearbeiten.
AnsichtErstellt einen schreibgeschützten Link zum Element.
BearbeitenErstellt einen Lese-/Schreiblink zum Element

Beispiel

Anforderung

GET ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink(accessLevel=Microsoft.OneNote.Api.SharingLinkAccessLevel'View') 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

Antwort

HTTP/1.1 200 Ok

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Edm.String",
  "value":"https://www.contoso.com/_layouts/15/WopiFrame.aspx?folderid=084a6fcc95ab54a678257e1b9cba41e7e&authkey=AXXriBu-O475sT4tfJeJDkA&FixProgId=1"
}

Anforderungs- and Antwortinformationen

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

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).

BerechtigungsbereichNotes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 200 HTTP-Statuscode.
AntworttextEine OData-Darstellung des Wertes im JSON-Format.
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 Microsoft-Support arbeiten, um Probleme zu beheben.

Folgen Sie diesen Schritten, um den vorhandenen Link zu erhalten oder einen zu erstellen, falls dieser nicht existiert. Der anonyme Link kann verwendet werden, um eine OneNote-Datei ohne Anmeldung anzuzeigen.

POST ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

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

Parameter accessLevel enum-WerteDie Zugriffsebene des zu erstellenden Teilen-Links. Wählen Sie entweder Anzeigen oder Bearbeiten.
AnsichtErstellt einen schreibgeschützten Link zum Element.
BearbeitenErstellt einen Lese-/Schreiblink zum Element

Beispiel

Anforderung

POST ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

Antwort

HTTP/1.1 200 Ok

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Edm.String",
  "value":"https://www.contoso.com/_layouts/15/WopiFrame.aspx?folderid=084a6fcc95ab54a678257e1b9cba41e7e&authkey=AXXriBu-O475sT4tfJeJDkA&FixProgId=1"
}

Anforderungs- and Antwortinformationen

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

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).

BerechtigungsbereichNotes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 200 HTTP-Statuscode.
AntworttextEine OData-Darstellung des Wertes im JSON-Format.
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 Microsoft-Support arbeiten, um Probleme zu beheben.

Führen Sie diese Schritte aus, um einen bestehenden Teilen-Link für eine Abschnittsgruppe zu widerrufen.

DELETE ../v1.0/me/notes/sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink

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

Parameter accessLevel enum-WerteDie Zugriffsebene des zu erstellenden Teilen-Links. Wählen Sie entweder Anzeigen oder Bearbeiten.
AnsichtErstellt einen schreibgeschützten Link zum Element.
BearbeitenErstellt einen Lese-/Schreiblink zum Element

Beispiel

Anforderung

DELETE ../v1.0/me/notes/sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink
Authorization: Bearer {token}
Accept: application/json

{ 
  “accessLevel”: “view” 
} 

Antwort

HTTP/1.1 204 No Content

Anforderungs- and Antwortinformationen

Die folgenden Informationen gelten für DELETE /RevokeAnonymousSharingLink Anforderungen.

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

Bei Fehlen oder Ungültigkeit schlägt die Anfrage mit einem 401-Statuscode fehl. Siehe Authentifizierung mit Azure AD (Unternehmensanwendungen).

BerechtigungsbereichNotes.ReadWrite oder Notes.ReadWrite.All
AntwortdatenBeschreibung
ErfolgscodeEin 204 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 Microsoft-Support arbeiten, um Probleme zu beheben.

Aktivieren oder Deaktivieren der externen Freigabe für eine SharePoint-Online-Umgebung

Verwalten der externen Freigabe für Ihre SharePoint-Online-Umgebung

Erstellen der OneNote Dienst-Root-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