SharePoint リストのコメント機能をAPIから触ってみた！

3211 ワード
Office365 SharePointOnline Microsoft365 Office365 テキストリンク

Office 365 Advent Calendar 2020 9日の記事です。

https://adventar.org/calendars/5362

先日、やっとウチのテナントの SharePoint Online にもリストアイテムへのコメント機能が展開されました。
どんな風に使えそうか、触ってみた感じと、APIから触ったりできるのか調べてみました。

まずは基本的な使い方

リストアイテムを作ってコメントアイコンをクリック。

コメント入力画面が表示されるので、コメントの登録。

コメントできた！

コメントは履歴含めて表示できる

アクティビティを含めたビューもできる

APIで操作してみる

指定のリストアイテムのコメントを取得する($expand以降はいらないかも)

GET
https://{hostname}/sites/{sitename}/_api/web/lists/getbytitle('{listname}')/items({id})/GetComments()?$expand=replies&$filter=NumReplies eq 10

単一コメントを取得する

GET
https://{hostname}/sites/{sitename}/_api/web/lists/getbytitle('{listname}')/items({id})/Comments({commentid})

コメントを追加する

POST
https://{hostname}/sites/{sitename}/_api/web/lists/getbytitle('{listname}')/items({id})/Comments()
POSTデータ
{text : "{comment}"}

指定のリストアイテムのアクティビティを取得する($expand以降はいらないかも)
アクティビティの一覧を作るときは、上記のコメントの取得も同時に行い、くっつけて一覧作ってる様子

GET

https://{hostname}/_api/v2.0/sites/{hostname}:/sites/{sitename}:/lists/{listname}/items/{id}/activities?$expand=listItem($select=id,name,webUrl)

まとめ

無事APIから操作することができました。SPFx や Graph API と組み合わせていろいろできそうです。
コメント機能といえば、SharePoint Server 2013 のディスカッション掲示板で似たようなものがありましたが、あれはビューからコメントしたアイテムを閲覧することができましたが、これは同じようには確認することはできあませんでした。
そういったものとは違うようです。