【SharePoint】RESTコマンドのまとめ(ファイル/フォルダー)

f:id:tecchan365:20190715201105p:plain

SharePointのRESTコマンドのまとめです。
今回は、ファイル・フォルダーのREST APIのまとめです。

SharePoint REST サービスとは

SharePoint の RESTの概要は以下を参照ください。

docs.microsoft.com

www.codesharepoint.com

File

エンドポイント URI

http://<サイトの url>/_api/web/getfilebyserverrelativeurl('/<フォルダー名 >/<ファイル名>')

メソッド HTTP method 説明
Approve POST 指定されたコメントを付けて、コンテンツの承認のために提出されたファイルを承認します。
CancelUpload POST アップロードされたデータを保存しないでチャンク アップロード セッションを停止します。
CheckIn POST チェックインの種類に基づいてドキュメント ライブラリ内のファイルをチェックインします。
CheckOut POST チェックアウトの種類に基づいてファイルをドキュメント ライブラリからチェックアウトします。
ContinueUpload POST 追加フラグメントを使用してチャンク アップロード セッションを続行します。
CopyTo POST ファイルをコピー先 URL にコピーします。
Deny POST コンテンツの承認のために提出されたファイルの承認を拒否します。
FinishUpload POST 最後のファイル フラグメントをアップロードし、ファイルをコミットします。
GetLimitedWebPartManager GET この Web パーツ ページおよびビューと関連付けられている Web パーツの利用、変更、または追加で使用されるコントロール セットを指定します。
MoveTo POST ファイルを指定の移動先 URL に移動します。
OpenBinaryStream POST ファイルをストリームとして開きます。
Publish POST コンテンツ承認用のファイルに指定のコメントを添えて送信します。
Recycle POST ファイルをごみ箱に移動し、新しいごみ箱アイテムの識別子を返します。
SaveBinaryStream POST ファイル コンテンツ (ストリーム) を送信します。
StartUpload POST 新しいチャンク アップロード セッションを開始し、最初のフラグメントをアップロードします。
UndoCheckOut POST ファイルの既存のチェックアウトを元に戻します。
Unpublish POST ファイルをコンテンツの承認から削除するか、メジャー バージョンの発行を取り消します。

FileCollection

エンドポイント URI

http://<サイトの url>/_api/web/getfolderbyserverrelativeurl('/<フォルダー名>')/files

メソッド HTTP method 説明
Add POST ファイルを追加します。
AddTemplateFile POST 非実体化ファイルを既存のリストまたはドキュメント ライブラリに追加します。
GetByUrl POST 指定された URL でファイルを取得します。

FileVersionCollection

エンドポイント URI

http://<サイトの url>/_api/web/getfilebyserverrelativeurl('/<フォルダー名>/<ファイル名>')/versions

メソッド HTTP method 説明
DeleteAll POST コレクション内のすべてのファイル バージョン オブジェクトを削除します。
DeleteById POST 指定されたバージョンのファイルを削除します。
DeleteByLabel POST 指定されたバージョン ラベルを持つファイル バージョン オブジェクトを削除します。
RestoreByLabel POST バージョンラベルによって指定されたファイルから新しいファイル バージョンを作成します。

Folder

エンドポイント URI

http://<サイトの url>/_api/web/getfolderbyserverrelativeurl('/<フォルダー名>')

メソッド HTTP method 説明
Recycle POST リスト フォルダーをごみ箱に移動し、新しいごみ箱アイテムの識別子を返します。

FolderCollection

エンドポイント URI

http://<サイトの url>/api/web/folders (ルート サイトのトップレベル フォルダー)
http://<サイトの url>/
api/web/getfolderbyserverrelativeurl('/<フォルダー名>')/folders

メソッド HTTP method 説明
Add POST 指定された URL にあるフォルダーをコレクションに追加します。

docs.microsoft.com