予定のコメントを取得する
予定のコメントを取得する(このAPIは2026年9月の定期メンテナンス後より適用されます)
予定IDを指定して、予定に書き込まれたコメントの一覧を取得します。
URL
https://sample.cybozu.com/g/api/v1/schedule/events/SCHEDULE_ID/comments
パスパラメーター
| パラメーター名 | 説明 |
|---|---|
| SCHEDULE_ID | コメントを取得する予定の予定ID |
HTTPメソッド
GET
利用できるバージョン
- クラウド版Garoon
必要なアクセス権
- 予定の閲覧権限
非公開の予定のコメントを取得できるのは、予定の参加者と共有先のユーザーだけです。
リクエスト
パラメーター
リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、
Garoon REST APIリクエストを送信するAPI
を使って実行する場合は、リクエストボディとして指定できます。
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| limit | 数値 | 省略可 | 取得するコメントの件数 1,000まで指定できます。省略すると100が設定されます。 |
| offset | 数値 | 省略可 | 取得するコメントの先頭からスキップする数 省略すると、0が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/schedule/events/123/comments?limit=30
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を参照してください。
レスポンス
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| comments | 配列 | コメントの一覧createdAtの降順で返ります。 |
| comments[].id | 文字列 | コメントID |
| comments[].body | 文字列 | コメントの本文 ユーザーが入力した文字列が、HTMLエスケープされずに返ります。 |
| comments[].createdAt | 文字列 | コメントを書き込んだ日時 UTCのISO 8601形式で返ります。 例: 2024-04-19T04:46:25Z |
| comments[].creator | オブジェクト | コメントを書き込んだユーザーの情報 |
| comments[].creator.id | 文字列 | コメントを書き込んだユーザーのGaroonユーザーID ユーザーが削除されている場合は、空文字が返ります。 |
| comments[].creator.code | 文字列 | コメントを書き込んだユーザーのログイン名 ユーザーが削除されている場合は、空文字が返ります。 |
| comments[].creator.name | 文字列 | コメントを書き込んだユーザーの表示名 ユーザーが削除されている場合は、 Username(Deleted)のように削除済みであることを示す文字列付きの表示名が返ります。 |
| comments[].mentions | 配列 | コメント内で宛先に指定されたユーザー、組織、またはロールの一覧 宛先の指定がない場合は、空配列が返ります。 |
| comments[].mentions[].type | 文字列 | 宛先の種類 次のいずれかの値が返ります。
|
| comments[].mentions[].id | 文字列 | 宛先のID 宛先が削除されている場合は、空文字が返ります。 typeがALLの場合は、allが返ります。 |
| comments[].mentions[].code | 文字列 | 宛先のコード 宛先が削除されている場合、および typeがALLの場合は、空文字が返ります。 |
| comments[].mentions[].name | 文字列 | 宛先の表示名typeがALLの場合は、Attendeesが返ります。 |
| hasNext | 真偽値 | 次のコメントがあるかどうか
|
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行
|
|
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
|
|
