Travailler avec les blocs-notes du personnel

S'applique aux : Blocs-notes d'entreprise sur Office 365** **

Les écoles, les facultés et les universités du monde entier utilisent les blocs-notes du personnel pour contribuer à promouvoir la productivité, l'engagement et la collaboration.

Vous pouvez utiliser le point de terminaison staffNotebooks pour effectuer des tâches courantes pour les bloc-notes du personnel, tels que la création des bloc-notes du personnel et l'ajout ou la suppression d'organisateurs ou de membres.

Note

L'API OneNote assiste le point de terminaison staffNotebooks pour les opérations spécifiques aux bloc-notes du personnel.

Construire l’URI de la requête

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

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

    Créez des bloc-notes du personnel

    ../staffNotebooks[?omkt,sendemail]

    Mettez à jour un bloc-note du personnel

    ../staffNotebooks/{notebook-id}

    Obtenez un ou plusieurs bloc-notes du personnel

    ../staffNotebooks

    ../staffNotebooks/{notebook-id}

    Supprimez un bloc-note du personnel

    ../staffNotebooks/{notebook-id}

    Ajoutez des membres ou des organisateurs

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

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

    Supprimez des membres ou des organisateurs

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

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

    Insérez des sections

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

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

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

Note

En savoir plus sur l’URL racine du service.

Créez des bloc-notes du personnel

Pour créer un bloc-note du personnel, envoyez une requête POST au point de terminaison staffNotebooks.

POST ../staffNotebooks[?omkt,sendemail]

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

{
    "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
}
Paramètre Description
nom Nom du bloc-notes.
memberSections Un tableau contenant un ou plusieurs noms de section. Ces sections sont créées dans le groupe de sections de chaque membre.
organisateurs Un tableau contenant un ou plusieurs objets principaux.
membres Un tableau contenant un ou plusieurs objets principaux. Un groupe de sections est créé pour chaque membre.
hasLeaderOnlySectionGroup true pour créer un groupe de sections Organisateurs seulement visible uniquement par les organisateurs.
omkt Paramè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
sendmail Paramètre de requête d'URL qui spécifie s'il faut envoyer une notification par e-mail aux organisateurs et membres affectés au bloc-notes lors de sa création. La valeur par défaut est false.

Les organisateurs et les membres sont représentés par des objets principaux, qui contiennent les propriétés suivantes :
Paramètre Description
id Le nom principal de l'utilisateur Office 365.

Voir la Documentation de l'API Azure AD Graph pour en savoir plus sur les utilisateurs et les groupes.
principalType Person 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 du personnel dans une langue spécifique. Par exemple :

POST ../staffNotebooks?omkt=de-de

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

Code Language
bg-bg Български (България)
cs-cz Čeština (Česká republika)
da-dk Dansk (Danmark)
de-de Deutsch (Deutschland)
el-gr Ελληνικά (Ελλάδα)
en-us Anglais (États-Unis)
es-es Espagnol (España)
et-ee Eesti (Eesti)
fi-fi Suomi (Suomi)
fr-fr Français (France)
hi-in हिंदी (भारत)
hr-hr Hrvatski (Hrvatska)
hu-hu Magyar (Magyarország)
id-id Bahasa Indonesie (Indonesie)
it-it Italiano (Italia)
ja-jp 日本語 (日本)
kz-kz Қазақ (Қазақстан)
ko-ko 한국어 (대한민국)
lt-lt Lietuvių (Lietuva)
lv-lv Latviešu (Latvija)
ms-my Bahasa Melayu (Asia Tenggara)
nb-no Norsk (Norge)
nl-nl Néerlandais (Nederland)
pl-pl Polski (Polska)
pt-br Portugais (Brésil)
pt-pt Portugais (Portugal)
ro-ro Română (România)
ru-ru Русский (Россия)
sk-sk Slovenčina (Slovenská republika)
sl-si Slovenski (Slovenija)
sr-Latn-RS Srpski (Rep. Srbija i Rep. Crna Gora)
sv-se Svenska (Sverige)
th-th ไทย (ไทย)
tr-tr Türkçe (Türkiye)
uk-ua Українська (Україна)
vi-vn Tiếng Việt (Việt Nam)
zh-cn 简体 中文 (中国)
zh-tw 繁體 中文 (台灣)

Exemple

La requête suivante crée un bloc-notes du * personnel Réunions du personnel.*

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
}

Cela crée un bloc-notes avec quatre groupes de sections membres, chacun contenant une section Documents, Notes du personnel et Résumés de réunion. Le groupe de sections créé pour chaque membre n'est accessible que par le membre et l'organisateur. Il crée également un groupe de section Organisateur seulement qui est visible uniquement pour le leader. La requête sendemail=true paramètre spécifie d'envoyer une notification par e-mail au leader et aux membres lors de la création du bloc-notes.

Informations sur les requêtes et les réponses

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

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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-Type application/json
En-tête Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Code d’état HTTP 201
Corps de la réponse Une représentation OData du nouveau bloc-notes au format JSON.

En plus des propriétés de bloc-notes standard, les blocs-notes du personnel ont également les propriétés suivantes :
  • memberSections. Les sections membres dans les bloc-notes.
  • organisateurs. Les organisateurs qui peuvent accéder au bloc-notes.
  • membre. Les membres qui peuvent accéder au bloc-notes.
  • hasLeaderOnlySectionGroup. true si le bloc-notes contient un groupe de section Réservé l'organisateur, sinon false.
Erreurs En cas d’échec de la requête, l’API renvoie des erreurs dans l’objet **@api.diagnostics** dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier 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 Microsoft Support pour résoudre les problèmes.

Mettre à jour les bloc-notes du personnel

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

Note

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

PATCH ../staffNotebooks/{notebook-id}

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

{
    "hasLeaderOnlySectionGroup": true
}
Paramètre Description
hasLeaderOnlySectionGroup true pour créer un groupe de sections Réservé à l'Organisateur visible uniquement par les organisateurs. false n’est pas pris en charge.

Consultez ces méthodes pour d'autres façons de modifier les blocs-notes du personnel : Ajoutez des membres ou des organisateurs, Supprimez des membres ou des leaders, Insérez des sections.

Exemple

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

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

{
    "hasLeaderOnlySectionGroup": true
}

Le nouveau groupe de section Réservé à l'Organisateur est visible uniquement pour les leaders.

Informations sur les requêtes et les réponses

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

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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-Type application/json
En-tête Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Un code d'état HTTP 204.
Erreurs Si la requête échoue, l'API renvoie les erreurs dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier 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 Microsoft Support pour résoudre les problèmes.

Obtention des bloc-notes du personnel

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

Obtenez un ou plusieurs bloc-notes du personnel

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

Obtenir un bloc-notes du personnel spécifique

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

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

Les blocs-notes du personnel sont également retournés pour les GET /notebooksrequêtes, mais les résultats n'incluent aucune propriété spécifique aux blocs-notes du personnel.

Exemple

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

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

La requête suivante obtient les bloc-notes du personnel créés depuis le 1er janvier 2016.

Informations sur les requêtes et les réponses

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

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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 Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Code d’état HTTP 200.
Corps de la réponse Une représentation OData des blocs-notes du personnel au format JSON.

En plus des propriétés de bloc-notes standard, les blocs-notes du personnel ont également les propriétés suivantes :
  • memberSections. Les sections membres dans les bloc-notes.
  • organisateurs. Les organisateurs qui peuvent accéder au bloc-notes.
  • membre. Les membres qui peuvent accéder au bloc-notes.
  • hasLeaderOnlySectionGroup. true si le bloc-notes contient un groupe de section Réservé l'organisateur, sinon false.
Erreurs En cas d’échec de la requête, l’API renvoie des erreurs dans l’objet **@api.diagnostics** dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier 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 Microsoft Support pour résoudre les problèmes.

Supprimez les bloc-notes du personnel

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

DELETE ../staffNotebooks/{notebook-id}

Exemple

La requête suivante supprime le bloc-notes du personnel spécifié.

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

Informations sur les requêtes et les réponses

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

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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 Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Un code d'état HTTP 204.
Erreurs Si la requête échoue, l'API renvoie les erreurs dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier 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 Microsoft Support pour résoudre les problèmes.

Ajouter des membres et des organisateurs

L'ajout d'organisateurs et de membres leur donne accès au bloc-notes du personnel. L'ajout d'un membre crée également un groupe de sections de membre. Ce groupe de sections est uniquement accessible par le membre et le l'organisateur, et contient les sections membres définies pour le bloc-notes.

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

Ajout d'un membre

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

Ajout d'un organisateur

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

Envoyer un objet principal JSON dans le corps du message. Vous pouvez ajouter un membre ou un organisateur par requête.

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

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

Paramètre Description
id Le nom principal de l'utilisateur Office 365. Voir la Documentation de l'API Azure AD Graph pour en savoir plus sur les utilisateurs et les groupes.
principalType Person ou Group

Exemple

La requête suivante ajoute un organisateur à un bloc-notes du personnel.

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

Informations sur les requêtes et les réponses

Les informations suivantes s'appliquent aux requêtes POST /members et POST /leaders.

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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-Type application/json
En-tête Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Code d’état HTTP 201
Corps de la réponse Le membre ou le chef qui a été ajouté.
Erreurs En cas d’échec de la requête, l’API renvoie des erreurs dans l’objet **@api.diagnostics** dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier 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 Microsoft Support pour résoudre les problèmes.

Supprimez des membres et des organisateurs

Supprimer des membres et des organisateurs d'un bloc-notes du personnel révoque leur accès au bloc-notes, mais ne supprime aucun contenu.

Pour supprimer un membre ou un organisateur d'un bloc-notes du personnel, envoyez une requête SUPPRIMER au point de terminaison approprié.

Supprimer un membre

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

Supprimer un organisateur

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

Vous pouvez supprimer un membre ou un organisateur par requête.

Exemple

La requête suivante supprime le membre spécifié du bloc-notes du personnel spécifié.

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

Informations sur les requêtes et les réponses

Les informations suivantes s'appliquent aux requêtes DELETE /members et DELETE /leaders.

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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 Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Un code d'état HTTP 204.
Erreurs En cas d’échec de la requête, l’API renvoie des erreurs dans l’objet **@api.diagnostics** dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier 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érez 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 du personnel. Une bibliothèque de contenu est un groupe de sections dans le bloc-notes du personnel disposant d'autorisations en lecture/écriture pour les organisateurs et d'autorisations en lecture pour les membres.

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

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

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

{
    "sectionIds": [
        "section1-id", 
        "section2-id",
        ...
    ]
}
Paramètre Description
sectionIds Un tableau qui contient les ID des sections que vous souhaitez insérer dans le bloc-notes du personnel.

L'utilisateur doit avoir un accès aux sections cible et aux bloc-notes (réservé ou partagé). 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 du personnel spécifié.

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

Informations sur les requêtes et les réponses

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

Données des requêtes Description
Protocole Toutes les demandes utilisent le protocole HTTPS SSL/TLS.
En-tête Authorization

Bearer {token}, où {token} 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-Type application/json
En-tête Accept application/json
Étendue d’autorisation Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All


Données de réponse Description
Code de succès Un code d'état HTTP 201.
Erreurs Si la requête de création échoue, l'API renvoie les erreurs dans le corps de la réponse.
En-tête X-CorrelationId GUID qui permet d’identifier la requête de manière unique. Vous pouvez utiliser cette valeur, ainsi que la valeur de l’en-tête Date, quand vous travaillez avec le Support Microsoft pour résoudre des problèmes.

Construire l’URL racine du service OneNote

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

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

Le segment version dans l’URL représente la version de OneNote API 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 être sujettes à des modifications. 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 d'un site du client auquel l'utilisateur actuel est connecté. Seul le client actuel est pris en charge, accessible à l'aide du myOrganization mot-clé. En savoir plus sur l’obtention des ID de sites.

  • Blocs-notes de groupe unifiés

    • Les groupes unifiés (également appelés 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. Les groupes unifiés constituent le seul type de groupe 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 requête

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.

Voir aussi