
SharePointのRESTコマンドのまとめです。
今回は、リスト・アイテム・ビューのREST APIのまとめです。
SharePoint REST サービスとは
SharePoint の RESTの概要は以下を参照ください。
List
エンドポイント URI
http://<site url>/web/lists(guid'<list id>')
| メソッド | HTTP method | 説明 |
|---|---|---|
| BreakRoleInheritance | POST | セキュリティ設定が可能なオブジェクトの一意なロール割り当てを作成します。 |
| GetChanges | POST | 指定されたクエリに基づいて、リスト内で発生した変更のコレクションを変更ログから返します。 |
| GetItemById | GET | 指定されたリスト アイテム識別子を持つリスト アイテムを返します。 |
| GetItems | POST | 指定されたクエリに基づいてリストからアイテムのコレクションを返します。 |
| GetRelatedFields | GET | このリストをデータ ソースとして使用し、FieldLookup.IsRelationship が true に設定されているルックアップ フィールドのコレクションを返します。 |
| GetView | GET | 指定されたビュー識別子を持つリスト ビューを返します。 |
| Recycle | POST | リストをごみ箱に移動し、新しいごみ箱アイテムの識別子を返します。 |
| ReserveListItemId | POST | idempotent リスト アイテム作成のリスト アイテム ID を予約します。 |
| ResetRoleInheritance | POST | セキュリティ設定が可能なオブジェクトのロール継承をリセットし、ロールの割り当てをセキュリティ設定可能な親のオブジェクトから継承します。 |
ListCollection
エンドポイント URI
http://<site url>/web/lists
| メソッド | HTTP method | 説明 |
|---|---|---|
| EnsureSiteAssetsLibrary | POST | ユーザーが自分の Wiki ページにアップロードする、イメージまたはその他のファイルの既定のアセットの場所であるリストを取得します。 |
| EnsureSitePagesLibrary | POST | Wiki ページの既定の場所であるリストを取得します。 |
| GetById | GET | 指定されたリスト識別子を持つリストを返します。 |
| GetByTitle | GET | 指定されたタイトルを持つリストをコレクションから返します。 |
ListItem
エンドポイント URI
http://<site url>/web/lists(guid'<list id>')/items(<item id>)
http://<site url>/web/lists/getbytitle('<list title>')/items(<item id>)
| メソッド | HTTP method | 説明 |
|---|---|---|
| BreakRoleInheritance | POST | セキュリティ設定が可能なオブジェクトの一意なロール割り当てを作成します。 |
| GetUserEffectivePermissions | GET | 指定されたユーザーがリスト アイテムに対して持っている有効なアクセス許可を取得します。 |
| Recycle | POST | リスト アイテムをごみ箱に移動し、新しいごみ箱アイテムの識別子を返します。 |
| ResetRoleInheritance | POST | セキュリティ設定が可能なオブジェクトのロール継承をリセットし、ロールの割り当てをセキュリティ設定可能な親のオブジェクトから継承します。 |
| ValidateUpdateListItem | POST | リスト アイテムのフィールドの指定されたコレクションの値を検証して設定します。 |
ListItemCollection
エンドポイント URI
http://<site url>/web/lists(guid'<list id>')/items
http://<site url>/web/lists/getbytitle('<list title>')/items
| メソッド | HTTP method | 説明 |
|---|---|---|
| GetById | GET | 指定されたリスト アイテム識別子を持つリスト アイテムを返します。 |
ViewCollection
エンドポイント URI
http://<site url>/web/lists(guid'<list id>')/views
| メソッド | HTTP method | 説明 |
|---|---|---|
| GetById | GET | 指定された ID を持つリスト ビューを取得します。 |
| GetByTitle | GET | 指定されたタイトルを持つリスト ビューを取得します。 |
ViewFieldCollection
エンドポイント URI
http://<site url>/_api/web/lists(guid'<list id>')/views('<view id>')/viewfields
| メソッド | HTTP method | 説明 |
|---|---|---|
| AddViewField | POST | 指定されたフィールド内部名または表示名を持つフィールドをコレクションに追加します。 |
| MoveViewFieldTo | POST | 指定されたフィールド内部名を持つフィールドをコレクション内の指定の位置に移動します。 |
| RemoveAllViewFields | POST | コレクションからすべてのフィールドを削除します。 |
| RemoveViewField | POST | 指定されたフィールド内部名を持つフィールドをコレクションから削除します。 |