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

2023.12.30

SharePointのフォルダ内のファイルに対してgetchanges を使用するサンプル

カテゴリ： REST API

SharePointのフォルダ内のファイルに対して getchanges を使用するためには、_api/web/getfolderbyserverrelativeurl('<FolderRelativeUrl>')/getfiles/getchanges エンドポイントを使用します。ここで <FolderRelativeUrl> には対象となるフォルダの相対URLが入ります。

# SharePoint サイト URL

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

# フォルダの相対URL

folderRelativeUrl="/sites/your-site/Shared Documents/YourFolder"

# REST API エンドポイント

changesEndpoint="$siteUrl/_api/web/getfolderbyserverrelativeurl('$folderRelativeUrl')/files/getchanges"

# REST API リクエストを送信

curl -X POST $changesEndpoint -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Accept: application/json;odata=verbose" -H "Content-Type: application/json;odata=verbose"

このリクエストを実行すると、指定したフォルダ内のファイルに関する変更情報がJSON形式で返されます。変更情報には、変更の種類や変更が発生したファイルの情報が含まれます。

この例では、getchanges エンドポイントを使用してフォルダ内のファイルに対する変更情報を取得しています。変更情報の取得には、クエリパラメータを使用して特定の変更の種類や条件を指定することも可能です。具体的なクエリパラメータの詳細については、SharePointの公式ドキュメントやAPIリファレンスを参照してください。

getchanges のレスポンスには、デフォルトでは変更イベントに関連するユーザー情報は含まれません。しかし、getchanges の結果には、変更が発生したアイテムやファイルに関する基本的な情報（ID、タイトル、URLなど）が含まれます。

ユーザー情報を取得するためには、_api/web/getuserbyid エンドポイントなどを使用して、ユーザーIDに基づいてユーザー情報を別途取得する必要があります。変更イベントの Editor や CreatedBy フィールドにはユーザーIDが含まれているため、これを利用してユーザー情報を取得できます。

以下は、変更イベントからユーザー情報を取得する例です。

特定の変更イベントのユーザーIDを取得:

変更イベントの Editor や CreatedBy フィールドに含まれるユーザーIDを取得します。

ユーザーIDを使用してユーザー情報を取得:

/_api/web/getuserbyid(<UserId>) エンドポイントを使用して、ユーザーIDに基づいてユーザー情報を取得します。

具体的な実装は、取得した変更イベントのユーザーIDを使用して、別途ユーザー情報を取得する必要があります。

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