Skip to content

sitepage-getwebpartsbyposition.md

Latest commit

 

History

History
117 lines (82 loc) · 4.31 KB

sitepage-getwebpartsbyposition.md

File metadata and controls

117 lines (82 loc) · 4.31 KB
title sitepage: getWebPartsByPosition
description Get a collection of webParts by position information
author sangle7
ms.localizationpriority medium
ms.subservice sharepoint
doc_type apiPageType
ms.date 08/01/2024

sitepage: getWebPartsByPosition

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a collection of webPart by providing webPartPosition information.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

GET /sites/{siteId}/pages/{sitePageId}/microsoft.graph.sitePage/getWebPartsByPosition

Function parameters

In the request URL, provide one or more following parameters with a valid value.

Parameter Type Description
columnId Double Indicate the identifier of the column where the WebPart located in. Only works if horizontalSectionId is provided.
horizontalSectionId Double Indicate the horizontal section where the WebPart located in.
isInVerticalSection Boolean Indicate whether the WebPart located in the vertical section.
webPartIndex Double Index of the current WebPart. Represents the order of WebPart in this column or section. Only works if either columnId or isInVerticalSection is provided.

Optional query parameters

This method supports the $expand, $filter, and $select OData query parameters to help customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of webPart objects in the response body.

Examples

Request

The following example shows a request.

HTTP

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

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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