名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
サイト リソースは、メタデータと SharePoint サイトのリレーションシップを提供します。
メソッド
| メソッド | REST パス |
|---|---|
| Create | POST /sites |
| Get | GET /sites/{site-id} |
| ルート サイトを取得する | GET /sites/root |
| パスを使用してサイトを取得する | GET /sites/{hostname}:/{site-path} |
| グループのサイトを取得する | GET /groups/{group-id}/sites/root |
| 分析を取得する | GET /sites/{site-id}/analytics |
| 間隔によりアクティビティを取得する | GET /sites/{site-id}/getActivitiesByInterval |
| ページを一覧表示する | GET /sites/{site-id}/pages |
| リスト ページ テンプレート | GET /sites/{site-id}/pageTemplates/microsoft.graph.pageTemplate |
| ルート サイトを一覧表示する | GET /sites?filter=root ne null&select=siteCollection,webUrl |
| 地域をまたいでサイトを一覧表示する | GET /site/getAllSites |
| サイトのサブサイトを一覧表示する | GET /sites/{site-id}/sites |
| サイトを検索する | GET /sites?search={query} |
| アーカイブ サイト | POST /sites/{site-id}/archive |
| サイトのアーカイブを解除する | POST /sites/{site-id}/unarchive |
| サイトをフォローする | POST /users/{user-id}/followedSites/add |
| サイトのフォローを取り消す | POST /users/{user-id}/followedSites/remove |
| フォローされたサイトを一覧表示する | GET /me/followedSites |
| アクセス許可を取得する | GET /sites/{site-id}/permissions/{permission-id} |
| アクセス許可を一覧表示する | GET /sites/{site-id}/permissions |
| アクセス許可を作成する | POST /sites/{site-id}/permissions |
| アクセス許可を削除する | DELETE /sites/{site-id}/permissions/{permission-id} |
| アクセス許可を更新する | PATCH /sites/{site-id}/permissions/{permission-id} |
| コンテンツ タイプを一覧表示する | GET /sites/{site-id}/contentTypes |
| contentType を作成する | POST /sites/{site-id}/contentTypes |
| 列を一覧表示する | GET /sites/{site-id}/columns |
| 列を作成する | POST /sites/{site-id}/columns |
| ドキュメント処理ジョブの作成 | POST /sites/{site-id}/documentProcessingJobs |
| リスト操作 | GET /sites/{site-id}/operations |
| 操作状態の取得 | GET /sites/getOperationStatus(operationId='{siteOperationId}') |
| サイト設定を編集する | GET /sites/{site-id}/settings |
| Get delta | GET /sites/delta |
| Open extensions | |
| Create open extension | POST /sites/{site-id}/extensions |
| Get open extension | GET /sites/{site-id}/extensions |
| オープン拡張機能を更新する | PATCH /sites/{site-id}/extensions |
| オープン拡張機能を削除する | DELETE /sites/{site-id}/extensions |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| createdDateTime | DateTimeOffset | サイトが作成された日時。 読み取り専用です。 baseItem から継承されます。 |
| 説明 | String | サイトの説明テキスト。 baseItem から継承されます。 |
| displayName | 文字列 | サイトの完全なタイトル。 読み取り専用です。 |
| eTag | String | サイトの ETag。 読み取り専用です。 baseItem から継承されます。 |
| id | 文字列 | サイトの 一意の識別子 。 読み取り専用です。 baseItem から継承されます。 |
| lastModifiedDateTime | DateTimeOffset | サイトが最後に変更された日時。 読み取り専用です。 baseItem から継承されます。 |
| ロケール | 文字列 | サイトの言語設定。 |
| lockState | siteLockState | サイトの状態。 有効な値は、 unlocked、 lockedReadOnly、 lockedNoAccess、 lockedNoAdditions です。 unknownFutureValue |
| name | String | サイトの名前。 baseItem から継承されます。 |
| ownerIdentityToResolve | identityInput | サイト作成時にのみ指定するサイト所有者。 |
| root | root | 存在する場合は、サイト コレクションのルート サイトを提供します。 読み取り専用です。 |
| settings | siteSettings | このサイトの設定。 読み取り専用です。 |
| shareByEmailEnabled | ブール型 | サイトとそのコンテンツをメールで共有できるかどうかを決定します。 |
| sharepointIds | sharepointIds | SharePoint REST 互換性に役立つ識別子を返します。 読み取り専用です。 |
| siteCollection | siteCollection | サイトのサイト コレクションに関する詳細情報を提供します。 ルート サイトにのみ使用できます。 読み取り専用です。 |
| template | siteTemplateType | サイトに適用するテンプレートを指定します。 使用可能な値: sitepagepublishing、sts、unknownFutureValue。 |
| webUrl | String | サイト作成時にのみ指定できるサイトの URL。 読み取り専用です。 baseItem から継承されます。 |
ID プロパティ
サイトは、次の値の複合である一意な ID によって識別されます。
- サイト コレクションのホスト名 (contoso.sharepoint.com)
- サイト コレクションの一意 ID (GUID)
- サイトの一意 ID (GUID)
root 識別子は次に示すように、常にターゲットのルート サイトを参照します。
-
/sites/root:テナントのルート サイト。 -
/groups/{group-id}/sites/root:グループのチーム サイト。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| 分析 | itemAnalytics | このサイトで行われた閲覧アクティビティに関する分析。 |
| columns | columnDefinition コレクション | このサイトのすべてのリストで再利用可能なコラム定義のコレクションです。 |
| contentModels | contentModel コレクション | このサイトに適用されているコンテンツ モデルのコレクション。 |
| contentTypes | contentType コレクション | このサイトに定義されたコンテンツ タイプのコレクションです。 |
| ドライブ | drive | このサイトの既定ドライブ (ドキュメント ライブラリ)。 |
| documentProcessingJobs | documentProcessingJob コレクション | このサイトで実行されているドキュメント処理ジョブ。 |
| drives | drive コレクション | このサイトの下のドライブ (ドキュメント ライブラリ) のコレクション。 |
| extensions | extension コレクション | このサイト用に定義されているオープン拡張機能のコレクション。 Null 許容型。 |
| externalColumns | columnDefinition コレクション | 現在のサイトの親階層のサイトから参照される、サイトで使用可能な列定義のコレクション。 |
| アイテム | baseItem コレクション | このサイトに含まれるすべてのアイテムを処理するために使用されました。 このコレクションは列挙できません。 |
| lists | リスト のコレクション | このサイトにあるリストのコレクションです。 |
| 操作 | richLongRunningOperation コレクション | サイトの実行時間の長い操作のコレクション。 |
| ページ | baseSitePage コレクション | このサイトの baseSitePages 一覧にあるページのコレクション。 |
| pageTemplates | pageTemplate コレクション | このサイトのページ テンプレートのコレクション。 |
| アクセス許可 | permission コレクション | サイトに関連付けられたアクセス許可。 Null 許容型。 |
| recycleBin | recycleBin | このサイトの recycleBinItem リソースのコレクションのコンテナー。 |
| sites | site コレクション | このサイトの下のサブサイトのコレクション。 |
| termStore | microsoft.graph.termStore.store | このサイトの下の termStore。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
サイト リソースは baseItem から派生しており、そのリソースからプロパティを継承しています。
{
"displayName": "string",
"id": "string",
"locale": "String",
"lockState": "String",
"ownerIdentityToResolve": {"@odata.type": "microsoft.graph.identityInput"},
"root": { "@odata.type": "microsoft.graph.root" },
"settings": { "@odata.type": "microsoft.graph.sitesettings" },
"shareByEmailEnabled": "Boolean",
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"siteCollection": {"@odata.type": "microsoft.graph.siteCollection"},
"template": "String",
/* relationships */
"analytics": { "@odata.type": "microsoft.graph.itemAnalytics" },
"columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
"contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
"extensions": [ { "@odata.type": "microsoft.graph.extension" }],
"externalColumns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
"drive": { "@odata.type": "microsoft.graph.drive" },
"drives": [ { "@odata.type": "microsoft.graph.drive" }],
"items": [ { "@odata.type": "microsoft.graph.baseItem" }],
"lists": [ { "@odata.type": "microsoft.graph.list" }],
"permissions": [ { "@odata.type": "microsoft.graph.permission" }],
"sites": [ { "@odata.type": "microsoft.graph.site"} ],
"termStore": { "@odata.type": "microsoft.graph.termStore.store" },
/* inherited from baseItem */
"createdDateTime": "datetime",
"description": "string",
"eTag": "string",
"lastModifiedDateTime": "datetime",
"name": "string",
"webUrl": "url"
}