文書の一覧を読む
トークンの持ち主が見られる文書の一覧を返す。題名・タグ・未解決のコメントの数で、操作の対象を選ぶのに使う。
/api/reviewsAuthorizationBearer token · headerrequired取り込み用トークン。文書を上げる、版を追加する、文書の一覧と中身を読むのに使う。
AuthorizationBearer token · headerrequired本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。
projectstring案件コード。指定すると、その案件に結び付いた文書だけを返す。大文字・小文字は区別しない。
読めた。
reviewsReviewSummary[]Show propertiesHide properties
ReviewSummaryreviewIdstringtitlestringaccessModestringlink はリンクを知る人が見られる。restricted は招待した人だけ。
linkrestrictedrolestringトークンの持ち主のこの文書での役割。
createdAtstring<date-time>countsobjectShow propertiesHide properties
openinteger未解決のコメントの数。
totalintegerlastActivityTsinteger | null最後にコメントなどが動いた時刻(UNIX 時間のミリ秒)。動きが無ければ null。
tagsstring[]archivedTsinteger | nullアーカイブした時刻(UNIX 時間のミリ秒)。アーカイブしていなければ null。
projectstringこの文書に案件の結び付けがあるときだけ付く案件コード。
案件コードの形が違うか、存在しない案件を指定した(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。