Partager via

Mettre à jour sitePage

  • Article

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet sitePage .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

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

PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage

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 uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Ces champs et sont utilisés dans les demandes de mise à jour.

Propriété Type Description
description Chaîne Description de la page du site. Optional.
thumbnailWebUrl Chaîne URL de l’image miniature de la page de site. Optional.
title Chaîne Titre de la page du site. Optional.
showComments Valeur booléenne Boolean pour déterminer s’il faut afficher ou non des commentaires en bas de la page. Optional.
showRecommendedPages Valeur booléenne Boolean pour déterminer s’il faut afficher ou non les pages recommandées en bas de la page. Optional.
promotionKind PagePromotionType Type de promotion de la page SharePoint. Optional. Prise en charge uniquement de la promotion d’une page (par exemple, de page à newsPost). La rétrogradation n’est pas prise en charge.
titleArea titleArea Zone de titre sur la page du site. Optional.
canvasLayout canvasLayout Disposition du contenu d’une page, y compris les sections horizontales et verticales. Un contenu de la mise en page entière doit être fourni, la fonction de mise à jour ne prend pas en charge les mises à jour partielles. Optional.

Remarques : :

  1. Pour garantir la réussite de l’analyse du corps de la demande, le @odata.type=#microsoft.graph.sitePage doit être inclus dans le corps de la demande.
  2. Si vous utilisez la réponse de l’opération Get sitepage pour mettre à jour un sitePage, nous vous recommandons d’ajouter l’en-tête Accept: application/json;odata.metadata=noneHTTP . Cela supprime toutes les métadonnées OData de la réponse. Vous pouvez également supprimer manuellement toutes les métadonnées OData.
  3. Seul le composant WebPart répertorié dans la section Composants WebPart pris en charge est pris en charge lors de la mise à jour d’un sitePage à l’aide de Microsoft API Graph. Toute tentative d’ajout de composants WebPart non pris en charge entraîne un échec ou une exception.

Composants WebPart pris en charge

Il existe deux types de composants WebPart qui peuvent être ajoutés à un sitePage : standardWebParts et textWebPart. Le tableau suivant répertorie les composants WebPart pris en charge pour les composants WebPart standard.

# 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 200 OK code de réponse et un objet sitePage mis à jour dans le corps de la réponse.

Exemples

Demande

Voici un exemple de requête.

PATCH https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "title": "sample",
  "showComments": true,
  "showRecommendedPages": false
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7",
  "name": "sample.aspx",
  "webUrl": "https://contoso.sharepoint.com/SitePages/sample.aspx",
  "title": "sample",
  "pageLayout": "article",
  "showComments": true,
  "showRecommendedPages": false,
  "createdBy": {
    "user": {
      "displayName": "Rahul Mittal",
      "email": "rahmit@contoso.com"
    }
  },
  "lastModifiedBy": {
    "user": {
      "displayName": "Rahul Mittal",
      "email": "rahmit@contoso.com"
    }
  },
  "publishingState": {
    "level": "draft",
    "versionId": "0.1"
  },
  "titleArea": {
    "enableGradientEffect": true,
    "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg",
    "layout": "colorBlock",
    "showAuthor": true,
    "showPublishedDate": false,
    "showTextBlockAboveTitle": false,
    "textAboveTitle": "TEXT ABOVE TITLE",
    "textAlignment": "left",
    "title": "sample",
    "imageSourceType": 2
  }
}