SitePage の取得
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
サイト内のサイト ページ リスト内の sitePage のメタデータを返します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この 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
オプションのクエリ パラメーター
このメソッドは、 $select
および $expand
OData クエリ パラメーターをサポートし、応答のカスタマイズに役立ちます。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
アイテムに $expand=canvasLayout
=canvasLayout リレーションシップがある場合は、アイテムのメタデータを取得するときに、クエリ文字列パラメーターを使用して項目の内容を含めることができます。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
Content-Type | application/json. Required. |
承諾 | application/json;odata.metadata=none。 オプション。 すべての OData メタデータを応答から削除します。 応答が別の要求で使用される場合は、このヘッダーを含めることをお勧めします。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200
応答本文で と sitePage オブジェクトを返します。
例
例 1: サイトのサイト ページ リスト内のページを取得する
要求
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage
応答
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "microsoft.graph.sitePage",
"description": "Here's the page description",
"id": "65e59907-59d5-44ff-a038-7c0bf3098c01",
"name": "Home.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx",
"title": "Organization Home",
"thumbnailWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/00210d24-bba0-42e6-9a31-1d452a95dd75/thumbnails/large.jpg?file=163352059.jpg",
"promotionKind": "page",
"pageLayout": "home",
"showComments": true,
"showRecommendedPages": false,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"publishingState": {
"level": "published",
"versionId": "1.0"
},
"reactions": {
"commentCount": 1
}
}
例 2: select and expand を使用してページを取得する
要求
ステートメントと $expand
ステートメントを使用$select
すると、1 つの要求で sitePage メタデータとページ コンテンツを取得できます。
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$select=id,name
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",
"name": "Electronic Convertible.aspx"
}
例 3: ページ コンテンツを含むページを取得する
要求
$expand クエリ パラメーターを使用して、URL 内の参照を展開できます。 ページコンテンツを含むページにアクセスするには、クエリ文字列を ?$expand=canvasLayout
追加します。
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$expand=canvasLayout
応答
{
"description": "Reiciendis placeat dolores.",
"eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",
"lastModifiedDateTime": "2023-04-16T10:01:41Z",
"name": "autotest Electronic Convertible.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/autotest Electronic Convertible.aspx",
"title": "autotest Electronic Convertible",
"pageLayout": "article",
"thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/sitepagethumbnail.png",
"promotionKind": "page",
"showComments": false,
"showRecommendedPages": true,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"parentReference": {
"listId": "468fc883-e278-4773-ba09-91351a1e42ed",
"siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"
},
"contentType": {
"id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",
"name": "Site Page"
},
"publishingState": {
"level": "draft",
"versionId": "0.4"
},
"reactions": {},
"canvasLayout": {
"horizontalSections": [
{
"layout": "threeColumns",
"id": "1",
"emphasis": "neutral",
"columns": [
{
"id": "1",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "f6d0ef70-c977-45e4-ae4b-4676a30d5aab",
"innerHtml": "<h1>sample content</h1>"
}
]
},
{
"id": "2",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "99f59f91-c853-433e-9e75-ad7a32e46106",
"innerHtml": "<h1>sample content</h1>"
}
]
},
{
"id": "3",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "48998492-9633-48b8-a7e9-d293533b4fa6",
"innerHtml": "<h1>sample content</h1>"
}
]
}
]
}
]
}
}