コメントを横断して探す
自分が見られる全文書(一覧と同じ文書)のコメント本文・引用文・返信から、語を含むものを探す。仮の書き込みと削除済みは対象にしない。個人トークンはどの範囲でも使える。
/api/search/commentsAuthorizationBearer token · headerrequired本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。
qstringrequired探す語。前後の空白を除いて 1〜100 文字。全角と半角、ASCII の大文字と小文字の違いは区別しない。
limitinteger返す件数の上限。既定 50、最大 200。
statusstringopen(未解決)か closed(解決済み)。
openclosedsincestring<date-time>ISO 8601 の日時。コメントの作成・編集と返信のうち最も新しい時刻がこれより後のもの。
authorstring書いた人の表示名か ID と完全に一致するもの。
aistring1 なら CLI・API・エージェントから書かれたものだけ。
1humanstring1 なら CLI・API・エージェント以外から書かれたものだけ。ai と同時には使えない。
1projectstring案件コード。指定すると、その案件に結び付いた文書だけを返す。大文字・小文字は区別しない。
探せた。
hitsobject[]requiredShow propertiesHide properties
objectreviewIdstringrequiredtitlestringrequiredcommentIdstringrequiredmessageIdstring | nullrequired返信で一致したときの返信の ID。
fieldstringrequired一致した場所。
bodyquotereplysnippetstringrequired一致した前後の文字。
statusstring | nullrequiredopenclosednullcreatedTsstring | nullrequiredtotalintegerrequired上限で切る前の件数。
truncatedbooleanrequired指定が正しくない(invalid_query・invalid_limit・invalid_since・invalid_filter・invalid_project)。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
トークンが無いか、この文書を読む権限が無い。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。