Créer un composant webPart

  • Article

Espace de noms: microsoft.graph

Créez un composant webPart à une position spécifiée dans le sitePage.

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Sites.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Sites.ReadWrite.All Non disponible.

Requête HTTP

POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts
POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts

Paramètres facultatifs de la requête

Nom Description
Index Position à laquelle le composant WebPart doit être inséré dans la collection de composants WebPart

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de textWebPart ou standardWebPart.

Pour garantir la réussite de l’analyse du corps de la demande, ou @odata.type=#microsoft.graph.textwebpart@odata.type=#microsoft.graph.standardwebpart doit être inclus dans le corps de la demande.

Composants WebPart pris en charge

Il existe deux types de composants WebPart qui peuvent être ajoutés à un sitePage : standardWebPart et textWebPart.

Pour standardWebPart, seuls les éléments suivants sont pris en charge lors de la mise à jour à l’aide de l’API Microsoft Graph. Toute tentative d’ajout de composants WebPart non pris en charge entraîne un échec ou une exception.

# Composant WebPart Type
1 Plans Bing e377ea37-9047-43b9-8cdb-a761be2f8e09
2 Bouton 0f087d7f-520e-42b7-89c0-496aaf979d58
3 Appel à l’action df8e44e7-edd5-46d5-90da-aca1539313b8
4 Diviseur 2161a1c6-db61-4731-b97c-3cdb303f7cbb
5 Incorporation de document b7dd04e1-19ce-4b24-9132-b60a1c2b910d
6 Image d1d91016-032f-456d-98a4-721247c305e8
7 Galerie d’images af8be689-990e-492a-81f7-ba3e4cd3ed9c
8 Aperçu du lien 6410b3b6-d440-4663-8744-378976dc041e
9 Organigramme e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b
10 Personnes 7f718435-ee4d-431c-bdbf-9c4ff326f46e
11 Liens rapides c70391ea-0b10-4ee9-b2b4-006d3fcad0cd
12 Entretoise 8654b779-4886-46d4-8ffb-b5ed960ee986
13 Youtube Embed 544dd15b-cf3c-441b-96da-004d5a8cea1d
14 Zone de titre cbe7b0a9-3504-44dd-a3a3-0e5cacd07788

Réponse

Si elle réussit, cette méthode renvoie un 201 et l’objet webPart créé dans le corps de la réponse.

Exemple

Demande

L’exemple suivant montre comment créer un composant WebPart.

POST /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202//microsoft.graph.sitePage/canvasLayout/verticalSection/webparts
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.textWebPart",
  "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat."
}

Réponse

Si elle réussit, cette méthode renvoie un composant webPart dans le corps de la réponse pour le composant webPart créé.

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.textWebPart",
  "id": "51053496-e6f3-4161-94ac-07bdf4d92226",
  "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat."
}