sitePage: getWebPartsByPosition
名前空間: microsoft.graph
webPartPosition 情報を指定して、webPart のコレクションを取得します。
アクセス許可
この 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 で、有効な値を持つ 1 つ以上の次のパラメーターを指定します。
パラメーター | 型 | 説明 |
---|---|---|
columnId | 倍精度浮動小数点数 | WebPart が配置されている列の識別子を示します。
horizontalSectionId が指定されている場合にのみ機能します。 |
horizontalSectionId | 倍精度浮動小数点数 | WebPart が配置されている水平セクションを示します。 |
isInVerticalSection | ブール型 | WebPart が現在の垂直セクションに含まれているかどうかを示します。 |
webPartIndex | 倍精度浮動小数点数 | 現在の WebPart のインデックス。 現在の列またはセクションの WebPart の順序を表します。
columnId またはisInVerticalSection が指定されている場合にのみ機能します。 |
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ $expand
、 $filter
、および $select
OData クエリ パラメーター をサポートします。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
Content-Type | application/json. 必須です。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文の webPart オブジェクトのコレクションを返します。
例
要求
要求の例を次に示します。
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
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
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>"
}
]
}