Table of contents
TOC
Réduire la table des matières
Développer la table des matières
Dernière mise à jour: 10/07/2018

L’URL racine du service OneNote utilise le format suivant pour tous les appels à l’API OneNote.

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


Le segment version dans l’URL représente la version de l’API OneNote que vous souhaitez utiliser.

  • Utilisez v1.0 pour le code de production stable.
  • Utilisez beta pour tester une fonctionnalité en cours de développement. Les fonctions et fonctionnalités en version bêta peuvent changer. Nous vous recommandons donc de ne pas les utiliser dans votre code de production.


Le segment location dans l’URL représente la localisation des blocs-notes auxquels vous souhaitez accéder.

Blocs-notes sur OneDrive Entreprise
Utilisez me pour le contenu OneNote appartenant à l’utilisateur actuel.

Utilisez users/{id} pour le contenu OneNote que l’utilisateur spécifié (dans l’URL) a partagé avec l’utilisateur actuel. Utilisez l’API de Azure AD Graph pour obtenir les ID utilisateurs.

Blocs-notes de sites SharePoint
Les sites d’équipe et d’autres sites SharePoint peuvent contenir des blocs-notes OneNote dans leurs bibliothèques de documents.

Utilisez myOrganization/siteCollections/{id}/sites/{id} pour le contenu OneNote sur un site du client auquel l’utilisateur actuel est connecté. Seul le client actuel est pris en charge et accessible en utilisant le mot-clé myOrganization. En savoir plus sur l’obtention des ID de sites.

Blocs-notes de groupe Office 365
Les groupes Office 365 font partie de l’expérience connectée Office 365. Les membres du groupe peuvent partager des blocs-notes, des fichiers et des e-mails.

Utilisez myOrganization/groups/{id} pour le contenu OneNote dans le groupe spécifié dont l’utilisateur actuel est membre. Seul le type de groupe Office 365 (qui renvoie le groupType unified) est pris en charge. Utilisez l’API de Azure AD Graph pour obtenir les ID de groupes.


Utilisez la méthode FromUrl pour obtenir la collection de sites et les ID de sites
Vous pouvez utiliser la méthode FromUrl pour obtenir la collection de sites et les ID de sites pour une URL de site absolue spécifiée. Vous devez effectuer cet appel uniquement lorsque cela est nécessaire, puis stocker les valeurs pour une utilisation ultérieure.

Le format de l’URL de site dépend de votre configuration, par exemple https://domain.sharepoint.com/site-a ou https://domain.com/sites/site-a.

Exemple de demande :

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

Exemple de réponse :

{
  "@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"
}

Conditions préalables à l’utilisation de FromUrl et pour travailler avec des blocs-notes de sites SharePoint :

  • Vous pouvez uniquement créer des blocs-notes, des groupes de sections, des sections et des pages OneNote sur des sites disposant d’une bibliothèque de documents par défaut. (Certains modèles de sites ne créent pas de bibliothèque de documents par défaut.) Toutefois, les demandes GET renvoient le contenu OneNote de toutes les bibliothèques de documents sur le site.
  • L’URL racine du service OneNote n’est pas modifiable, ce qui signifie que vous ne pouvez pas utiliser un chemin d’accès au site de l’API REST SharePoint et ensuite y coller le point de terminaison notes.
  • L’utilisateur au nom duquel vous appelez doit être membre du site.
  • FromUrl fonctionne uniquement avec les sites qui ont été indexés. L’indexation d’un nouveau site peut prendre plusieurs heures.
© 2018 Microsoft