Partager via

sitePage : getWebPartsByPosition

  • Article

Espace de noms: microsoft.graph

Obtenez une collection de webPart en fournissant des informations webPartPosition .

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.Read.All Sites.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Sites.Read.All Sites.ReadWrite.All

Requête HTTP

GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitepage/getWebPartsByPosition

Paramètres de fonction

Dans l’URL de la demande, fournissez un ou plusieurs paramètres suivants avec une valeur valide.

Paramètre Type Description
columnId Double Indique l’identificateur de la colonne où se trouve le composant WebPart. Fonctionne uniquement si horizontalSectionId est fourni.
horizontalSectionId Double Indique la section horizontale où se trouve le composant WebPart.
isInVerticalSection Boolean Indiquez si le composant WebPart est contenu dans la section verticale actuelle.
webPartIndex Double Index du composant WebPart actuel. Représente l’ordre du composant WebPart dans la colonne ou la section active. Fonctionne uniquement si columnId ou isInVerticalSection est fourni.

Paramètres facultatifs de la requête

Cette méthode prend en charge les $expandparamètres de requête OData , $filteret $select pour vous aider à personnaliser la réponse.

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

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets webPart dans le corps de la réponse.

Exemples

Demande

Voici un exemple de requête.

GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/getWebPartsByPosition?isInVerticalSection=true

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.textWebPart",
      "id": "d79d70af-27ea-4208-8dce-23c3bf678664",
      "innerHtml": "<h2>How do you get started?</h2>"
    }
  ]
}