「東雲忠太郎」の平凡な日常のできごと

2023.12.31

REST:MERGE メソッドを使用してフォルダーの名前を変更する方法

カテゴリ：カテゴリ未分類

SharePointのREST APIを使用してフォルダーの名前を変更するには、/_api/web/GetFolderByServerRelativeUrl エンドポイントに対してMERGEメソッドを使用して更新します。以下は一般的な手順です。

GETリクエストでフォルダーのメタデータを取得:

GET /_api/web/GetFolderByServerRelativeUrl('/sites/YourSite/Shared Documents/OldFolder')

レスポンスヘッダーに ETag ヘッダーが含まれるため、これを後で使用します。

MERGEリクエストの構築:

MERGE /_api/web/GetFolderByServerRelativeUrl('/sites/YourSite/Shared Documents/NewFolder')

Content-Type: application/json;odata=verbose

Accept: application/json;odata=verbose

If-Match: <ETag from previous response>

リクエストヘッダーには Content-Type と Accept を指定し、また If-Match ヘッダーには前回取得したETag値を含めます。

リクエストボディの作成:

リクエストボディには変更したいフォルダーのプロパティをJSON形式で指定します。
例:

{

"__metadata": { "type": "SP.Folder" },

"Name": "NewFolder"

}

ここでは、Name プロパティに変更後のフォルダー名を指定します。

リクエストを送信:

上記で構築したREST APIリクエストを使用して、フォルダーの名前を変更します。

例えば、curlを使用する場合：

# SharePoint サイト URL

siteUrl="https://your-sharepoint-site-url"

# フォルダーのメタデータ取得時のETag値

etagValue="<ETag from previous response>"

# REST API リクエストを送信

curl -X MERGE "$siteUrl/_api/web/GetFolderByServerRelativeUrl('/sites/YourSite/Shared Documents/NewFolder')" -H "Content-Type: application/json;odata=verbose" -H "Accept: application/json;odata=verbose" -H "If-Match: $etagValue" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -d '{

"__metadata": { "type": "SP.Folder" },

"Name": "NewFolder"

この例では、YourSite というサイト内の共有ドキュメントライブラリにある OldFolder を NewFolder に名前を変更しています。YOUR_ACCESS_TOKEN は適切な認証トークンに置き換える必要があります。なお、実際の環境に合わせてURLやサイト名、フォルダーパス、ETag値を変更してください。

お気に入りの記事を「いいね！」で応援しよう