sitePage： getWebPartsByPosition

项目
08/01/2024

命名空间：microsoft.graph

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	Sites.Read.All	Sites.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	Sites.Read.All	Sites.ReadWrite.All

HTTP 请求

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

函数参数

在请求 URL 中，提供一个或多个具有有效值的以下参数。

参数	类型	说明
columnId	双精度	指示 Web 部件所在的列的标识符。仅当 `horizontalSectionId` 提供时才有效。
horizontalSectionId	双精度	指示 Web 部件所在的水平部分。
isInVerticalSection	布尔值	指示 Web 部件是否包含在当前垂直部分中。
webPartIndex	双精度	当前 Web 部件的索引。表示 WebPart 在当前列或节中的顺序。仅当 `columnId` 提供或 `isInVerticalSection` 时有效。

可选的查询参数

此方法支持 $expand、 $filter和 $selectOData 查询参数，以帮助自定义响应。

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 必需。

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和 webPart 对象的集合。

示例

请求

请求示例如下所示。

HTTP
JavaScript

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


const options = {
	authProvider,
};

const client = Client.init(options);

let getWebPartsByPosition = await client.api('/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/getWebPartsByPosition?isInVerticalSection=true')
	.get();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

通过