見出しの区切りの一覧を読む
コメントの位置の指定(Locator の sectionId)に使う、見出しの区切りの ID と見出しの文字列を返す。
GET
/api/reviews/{reviewId}/dom-contextAuthorization
AuthorizationBearer token · headerrequiredエージェント用トークン。文書とコメントを読み、run の中でコメントを書くのに使う。ブラウザのログインと一緒に送らない。
or
AuthorizationBearer token · headerrequired本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。
Path parameters
reviewIdstringrequired文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。
Responses
200
読めた。
reviewIdstringcommentsRevisionintegerstructureRevisionintegersectionsSection[]Show propertiesHide properties
Array of
Sectionidstring見出しの区切りの ID。Locator の sectionId に使う。
labelstring見出しの文字列。
401
トークンが無いか、この文書を読む権限が無い。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
404
文書・run・コメントのいずれかが無い。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。