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

2023.12.31

REST:If-Matchで指定するETag値の説明

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

If-Match ヘッダーは、HTTPリクエストにおいて条件付きで更新や削除などの操作を行う際に使用されるヘッダーです。具体的には、指定したETag（Entity Tag）値とサーバー上の現在のETag値が一致した場合にのみ、操作が実行されるようにします。ETagは通常、リソースの状態を表すハッシュや識別子として利用され、クライアントがリソースの変更を検知するために使用されます。

データを取得してETagを取得する:

最初にデータを取得し、そのレスポンスヘッダーからETag値を取得します。

GET /_api/web/lists/getbytitle('YourList')/items(ItemID)
レスポンスヘッダー:

HTTP/1.1 200 OK

ETag: "1"

ここで、"1" がETag値です。

更新リクエストを送信する際にIf-Matchヘッダーを含める:

更新を行う際に、取得したETag値を If-Match ヘッダーに含めます。これにより、サーバーが期待するETag値と一致しない場合は更新が拒否されます。

PATCH /_api/web/lists/getbytitle('YourList')/items(ItemID)

Content-Type: application/json;odata=verbose

Accept: application/json;odata=verbose

If-Match: "1"

リクエストボディには更新したいデータが含まれます。If-Match ヘッダーに指定したETag値とサーバー上の現在のETag値が一致する場合のみ、更新が許可されます。