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

Travailler avec des blocs-notes de classe

S'applique à : Notebooks d'entreprise sur Office 365

Les écoles, les facultés et les universités du monde entier utilisent les blocs-notes de classe pour contribuer à promouvoir la productivité, l'engagement et la collaboration. Les blocs-notes de classe sont utilisables pour tout type de classe, projet, échéance et devoir.

Le point de terminaison classNotebooks peut être utilisé pour effectuer des tâches courantes pour les blocs-notes de classe, comme la création de blocs-notes de classe et l'ajout ou la suppression d'élèves.

L'API OneNote fournit le point de terminaison classNotebooks pour les opérations spécifiques aux blocs-notes de classe.

Construire l'URI de requête

Pour construire l'URI de requête, commencez par l'URL racine du service pour votre plateforme :

Blocs-notes sur OneDrive Entreprise
https://www.onenote.com/api/v1.0/me/notes/
https://www.onenote.com/api/v1.0/users/{id}/notes/

Blocs-notes de site SharePoint
https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

Blocs-notes de groupe unifiés
https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/


Ajoutez ensuite le point de terminaison classNotebooks, suivi d'un chemin d'accès aux ressources si nécessaire :

Créer des blocs-notes de classe

../classNotebooks[?omkt,sendemail]

Mettre à jour un bloc-notes de classe

../classNotebooks/{notebook-id}

Obtenir un ou plusieurs blocs-notes de classe

../classNotebooks

../classNotebooks/{notebook-id}

Supprimer un bloc-notes de classe

../classNotebooks/{notebook-id}

Ajouter des élèves ou des enseignants

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

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

Supprimer des étudiants ou des enseignants

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

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

Insérer des sections

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


Votre requête URI complète ressemblera à ces exemples :

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

En savoir plus sur l’URL racine du service.

Créer des blocs-notes de classe

Pour créer un bloc-notes de classe, envoyez une requête POST au point de terminaison classNotebooks .

POST ../classNotebooks[?omkt,sendemail]

Dans le corps du message, envoyez un objet JSON avec les paramètres de création de bloc-notes de classe.

{
    "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
}
ParamètreDescription
nomLe nom du bloc-notes.
Sections étudiantsUn tableau contenant un ou plusieurs noms de section. Ces sections sont créées dans le groupe de sections de chaque étudiant.
enseignantsUn tableau contenant un ou plusieurs objets principaux.
étudiantsUn tableau contenant un ou plusieurs objets principaux. Un groupe de sections est créé pour chaque étudiant.
hasTeacherOnlySectionGrouptrue créer un groupe de section Réservé à l'Enseignant visible uniquement par les enseignants.
omktParamètre de requête d'URL qui spécifie la langue du bloc-notes. La valeur par défaut est en-us. Exemple : ?omkt=es-es
envoyer e-mailParamètre de requête d'URL qui spécifie s'il faut envoyer une notification email aux enseignants et aux étudiants affectés au bloc-notes lors de sa création. La valeur par défaut est false.


Les enseignants et les étudiants sont représentés par des objets principaux, qui contiennent les propriétés suivantes :

ParamètreDescription
idLe nom d'utilisateur Office 365 principal.

Voir la Documentation de l'API Azure AD Graph pour en savoir plus sur les utilisateurs et les groupes.
principalTypePerson ou Group

Langues prises en charge

Vous pouvez utiliser le omkt={language-code} paramètre de requête d'URL pour créer un bloc-notes de classe dans une langue spécifique. Par exemple :

POST ../classNotebooks?omkt=de-de

Les codes de langue suivants sont pris en charge. La valeur par défaut est en-us.

CodeLangue
bg-bgБългарски (България)
cs-czČeština (Česká republika)
da-dkDansk (Danmark)
de-deDeutsch (Deutschland)
el-grΕλληνικά (Ελλάδα)
en-usEnglish (United States)
es-esEspañol (España)
et-eeEesti (Eesti)
fi-fiSuomi (Suomi)
fr-frFrançais (France)
hi-inहिंदी (भारत)
hr-hrHrvatski (Hrvatska)
hu-huMagyar (Magyarország)
id-idBahasa Indonesia (Indonesia)
it-itItaliano (Italia)
ja-jp日本語 (日本)
kz-kzҚазақ (Қазақстан)
ko-kr한국어 (대한민국)
lt-ltLietuvių (Lietuva)
lv-lvLatviešu (Latvija)
ms-myBahasa Melayu (Asia Tenggara)
nb-noNorsk (Norge)
nl-nlNederlands (Nederland)
pl-plPolski (Polska)
pt-brPortuguês (Brasil)
pt-ptPortuguês (Portugal)
ro-roRomână (România)
ru-ruРусский (Россия)
sk-skSlovenčina (Slovenská republika)
sl-siSlovenski (Slovenija)
sr-Latn-RSSrpski (Rep. Srbija i Rep. Crna Gora)
sv-seSvenska (Sverige)
th-thไทย (ไทย)
tr-trTürkçe (Türkiye)
uk-uaУкраїнська (Україна)
vi-vnTiếng Việt (Việt Nam)
zh-cn简体 中文 (中国)
zh-tw繁體 中文 (台灣)

Exemple

La requête suivante crée un bloc-notes de classe nommé Maths 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
}

Cela crée un bloc-notes de classe contenant quatre groupes de sections d'étudiants, chacun contenant une section Documents, Notes de classe, Devoirs et Quiz. Le groupe de sections créé pour chaque élève est accessible uniquement par l'étudiant et l'enseignant. Elle crée également un groupe de section Réservé à l'enseignant qui n'est visible que par l'enseignant. Le sendemail=trueparamètre de requête spécifie l'envoi d'une notification par email à l'enseignant et aux élèves lors de la création du bloc-notes.

Informations sur la requête et la réponse

Les informations suivantes s'appliquent uniquement aux POST /classNotebooksrequêtes.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête Content-Typeapplication/json
En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 201.
Corps de la réponseUne représentation OData du nouveau bloc-notes au format JSON.

En plus des propriétés de bloc-notes standard, les blocs-notes de classe ont également les propriétés suivantes :
  • Sections étudiants. Les sections étudiants dans les blocs-notes.
  • enseignants. Les enseignants qui peuvent accéder au bloc-notes.
  • étudiants. Les étudiants qui peuvent accéder au bloc-notes.
  • hasTeacherOnlySectionGroup. true si le bloc-notes contient un groupe de section Réservé à l'enseignant, sinon false.
ErreursSi la requête échoue, l'API renvoie les les erreurs dans l'objet @ api.diagnostics dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Mettre à jour les blocs-notes de classe

Pour mettre à jour un bloc-notes de classe, envoyez une requête PATCH au point de terminaison classNotebooks / {notebook-id}.

Actuellement, seule la propriété hasTeacherOnlySectionGroup peut être mise à jour dans une requête PATCH.

PATCH ../classNotebooks/{notebook-id}

Dans le corps du message, envoyez un objet JSON avec le paramètre de mise à jour.

{
    "hasTeacherOnlySectionGroup": true
}
ParamètreDescription
hasTeacherOnlySectionGrouptrue pour ajouter un groupe de section Réservé à l'Enseignant visible uniquement par les enseignants. false n’est pas pris en charge.

Voir ces méthodes pour d'autres manières de modifier les blocs-notes de classe : Ajouter des étudiants ou des enseignants, Supprimer des étudiants ou des enseignants, Insérer des sections.

Exemple

La requête suivante ajoute un groupe de section Réservé à l'Enseignant au bloc-notes spécifié.

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

{
    "hasTeacherOnlySectionGroup": true
}

Le nouveau groupe de section Réservé à l'Enseignant est visible uniquement par les enseignants.

Informations sur la requête et la réponse

Les informations suivantes s'appliquent uniquement aux PATCH ../classNotebooks/{notebook-id}requêtes.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête Content-Typeapplication/json
En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 204.
ErreursSi la requête échoue, l'API renvoie les erreurs dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Obtenir des blocs-notes de classe

Pour obtenir un ou plusieurs blocs-notes de classe, envoyez une requête GET au point de terminaison classNotebooks.

Obtenir un ou plusieurs blocs-notes de classe

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

Obtenir un bloc-notes de classe spécifique

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


Les blocs-notes de classe peuvent développer les propriétés teachers et students. L’ordre de tri par défaut est name asc.

Les blocs-notes de classe sont également retournés pour les requêtes GET /notebooks, mais les résultats n'incluent pas de propriété spécifique aux blocs-notes de classe.

Exemple

La requête suivante obtient les blocs-notes de classe créés depuis le 1er janvier 2016.

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

Pour en savoir plus sur l'obtention des blocs-notes, y compris les options et les exemples de chaînes de requête prises en charge, voir Contenu et structure Get OneNote.

Informations sur la requête et la réponse

Les informations suivantes s'appliquent uniquement aux GET /classNotebooksrequêtes.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 200.
Corps de la réponseUne représentation OData des blocs-notes de classe au format JSON.

En plus des propriétés de bloc-notes standard, les blocs-notes de classe ont également les propriétés suivantes :
  • Sections étudiants. Les sections étudiants dans les blocs-notes.
  • enseignants. Les enseignants qui peuvent accéder au bloc-notes.
  • étudiant. Les étudiants qui peuvent accéder au bloc-notes.
  • hasTeacherOnlySectionGroup. true si le bloc-notes contient un groupe de section Réservé à l'enseignant, sinon false.
ErreursSi la requête échoue, l'API renvoie les les erreurs dans l'objet @ api.diagnostics dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Supprimer blocs-notes de classe

Pour supprimer un bloc-notes de classe, envoyez une requête DELETE au point de terminaison classNotebooks / {notebook-id}.

DELETE ../classNotebooks/{notebook-id}

Exemple

La requête suivante supprime le bloc-notes de classe spécifié.

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

Informations sur la requête et la réponse

Les informations suivantes s'appliquent uniquement aux DELETE ../classNotebooks/{notebook-id}requêtes.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 204.
ErreursSi la requête échoue, l'API renvoie les erreurs dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Ajouter des étudiants et des enseignants

L'ajout d'enseignants et d'étudiants leur donne accès au bloc-notes de classe. L'ajout d'un étudiant crée également un groupe de section d'étudiants. Ce groupe de section n'est accessible que par l'étudiant et l'enseignant et contient les sections d'étudiant définies pour le bloc-notes.

Pour ajouter un étudiant ou un enseignant à un bloc-notes de classe, envoyez une requête POST au point de terminaison approprié.

Ajouter un étudiant

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

Ajouter un enseignant

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


Envoyer un objet principal JSON dans le corps du message. Vous pouvez ajouter un étudiant ou un enseignant par requête.

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

Les enseignants et les étudiants sont représentés par des objets principaux, qui contiennent les propriétés suivantes :

ParamètreDescription
idLe nom d'utilisateur Office 365 principal. Voir la Documentation de l'API Azure AD Graph pour en savoir plus sur les utilisateurs et les groupes.
principalTypePerson ou Group

Exemple

La requête suivante ajoute un enseignant au bloc-notes de classe spécifié.

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

Informations sur la requête et la réponse

Les informations suivantes s'appliquent aux requêtes POST /students et POST /teachers.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête Content-Typeapplication/json
En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 201.
Corps de la réponseL'étudiant ou l'enseignant qui a été ajouté.
ErreursSi la requête échoue, l'API renvoie les les erreurs dans l'objet @ api.diagnostics dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Supprimer des étudiants et des enseignants

La suppression d'étudiants et d'enseignants d'un bloc-notes de classe révoque leur accès au bloc-notes, mais ne supprime aucun contenu.

Pour supprimer un étudiant ou un enseignant d'un bloc-notes de classe, envoyez une requête DELETE au point de terminaison approprié.

Supprimer un étudiant

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

Supprimer un enseignant

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


Vous pouvez supprimer un étudiant ou un enseignant par requête.

Exemple

La requête suivante supprime l'étudiant spécifié du bloc-notes de classe spécifié.

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

Informations sur la requête et la réponse

Les informations suivantes s'appliquent aux requêtes DELETE /students et DELETE /teachers.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 204.
ErreursSi la requête échoue, l'API renvoie les les erreurs dans l'objet @ api.diagnostics dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Insérer des sections

Utilisez copySectionsToContentLibrary pour copier des sections spécifiques de blocs-notes Office 365 et les insérer dans la bibliothèque de contenu d'un bloc-notes de classe. Une bibliothèque de contenu est un groupe de sections contenu dans le bloc-notes de classe qui dispose d'autorisations de lecture / écriture pour les enseignants et d'autorisations de lecture pour les étudiants.

Pour insérer des sections dans un bloc-notes de classe, envoyez une requête POST au point de terminaison copySectionsToContentLibrary du bloc-notes de classe cible. Par exemple :

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

Dans le corps du message, envoyez un objet JSON avec le paramètre sectionIds.

{
    "sectionIds": [
        "section1-id", 
        "section2-id",
        ...
    ]
}
ParamètreDescription
sectionIdsUn tableau qui contient les ID des sections que vous souhaitez insérer dans le bloc-notes de classe.

L'utilisateur doit avoir un accès propriétaire ou partagé aux sections cibles et au bloc-notes. Toutes les cibles doivent faire partie du même client.

Exemple

La requête suivante insère deux sections dans la bibliothèque de contenu du bloc-notes de classe spécifié.

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"
    ]
}

Informations sur la requête et la réponse

Les informations suivantes s'appliquent uniquement aux POST /copySectionsToContentLibraryrequêtes.

Données des requêtesDescription
ProtocoleToutes les requêtes utilisent le protocole HTTPS SSL/TLS.
En-tête d’autorisation

Bearer {token}, où {jeton} est un jeton d'accès OAuth 2.0 valide pour votre application enregistrée.

S'il est manquant ou non valide, la demande échoue avec un code d'état 401. Voir Authentification avec Azure AD (applications d'entreprise).

En-tête Content-Typeapplication/json
En-tête d'acceptationapplication/json
Étendue d’autorisationNotes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All
Données de réponseDescription
Code de succèsUn code d'état HTTP 201.
ErreursSi la requête de création échoue, l'API renvoie les erreurs dans le corps de la réponse.
En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous faites appel au support Microsoft pour résoudre les problèmes.

Construction de l'URL racine du service OneNote

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.

Ressources supplémentaires

© 2018 Microsoft