文書を JSON で作る
構造化した初期データから文書を作る。project を指定すると、文書の ID はサーバーが作る。個人トークンでは、共有先に新しい行を含めるとき access の範囲も必要。
/api/reviewsAuthorizationBearer token · headerrequired本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。
application/jsonreviewobjectrequired新しい文書の初期データ。reviewId・source・access・structure を含める。
Show propertiesHide properties
reviewIdstringtitlestringsourceobjectaccessobjectShow propertiesHide properties
modestringlinkrestrictedallowedUsersobject[]Show propertiesHide properties
objectemailstring<email>requiredrolestringrequirededitorviewerstructureobjectprojectstring案件コード。社外・クライアントは必須。指定すると文書の ID はサーバーが作るため、review.reviewId を送ると 400 invalid_request。
作った。
reviewReview文書とコメントの全体。ここに挙げた項目のほかにも、画面が使う項目が入る。
Show propertiesHide properties
reviewIdstringtitlestringcommentsRevisionintegerコメントが書き換わるたびに 1 増える番号。書き込みで baseCommentsRevision として送る。
structureRevisionintegercommentsComment[]Show propertiesHide properties
CommentidstringauthorUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
Show propertiesHide properties
idstringproviderstringdisplayNamestringcategorystringコメントの種類。note はメモ、revise は書き換えの提案、add は追記、delete は削除の提案、needs_review は確認、consult は相談。none は分類の無い旧いデータで、画面ではメモとして出す。
notereviseadddeleteneeds_reviewconsultnonestatusstringopen は未解決、closed は解決済み。
openclosedbodystringanchorobject画面でコメントを表示する位置。書き込むときは anchor でなく Locator を送る。
threadThreadMessage[]Show propertiesHide properties
ThreadMessageidstringauthorUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
bodystringcreatedTsstring<date-time>statusEventsStatusEvent[]Show propertiesHide properties
StatusEventseqintegerstatusstringopenclosedbyUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
tsstring<date-time>versionIdstringコメントを付けた文書の版。
createdTsstring<date-time>editedTsstring<date-time>deletedTsstring<date-time>削除されたコメントにだけ付く。画面には出ない。
aiReviewRunsRun[]Show propertiesHide properties
Runidstringkindstringai_reviewvoicestatusstringrunningcompletedfailedcancelledtitlestringversionIdstringcommentIdsstring[]summarystringcreatedTsstring<date-time>completedTsstring<date-time>createdAtstring<date-time>sourceobject本文の出どころと版。
Show propertiesHide properties
versionsobject[]版の一覧。古い順で、最後が最新の版。
Show propertiesHide properties
objectversionIdstringlabelstringcreatedAtinteger版を作った時刻（UNIX 時間のミリ秒）。
sourceHashstring_projectProjectLinkこの文書に案件の結び付けがあるときだけ付く。
Show propertiesHide properties
codestringrequirednamestring | nullrequiredcompanystring | nullrequiredstatusstringrequiredactiveinactiveinSnapshotbooleanrequiredrolestring | nullrequired要求した本人の案件の役割。
managereditorviewernull初期データの形が違う。project を指定した要求に review.reviewId がある場合も 400 invalid_request。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
トークンが無いか、この文書を読む権限が無い。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
案件が必要（project_required）、案件で編集以上の役割が無い（project_role_required）、個人トークンの範囲が不足している（insufficient_scope）、または操作権限が無い（forbidden）。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
案件が見つからない（project_not_found）。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
案件が写しに無い（project_not_in_snapshot）か、配信前の結び付けが競合した（project_conflict）。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。