コンテンツにスキップ
commentor API
Esc
↑↓移動↵開く⌘Jプレビュー

共有先を読む

招待した人の一覧と、招待できるメールアドレスのドメインを返す。共有先を変える前の確認に使う。本文とコメントは返さない。

GET/api/reviews/{reviewId}/access
Authorization
AuthorizationBearer token · headerrequired

管理用トークン。題名・タグ・アーカイブ・共有先を変える、文書を削除するのに使う。

Path parameters
reviewIdstringrequired

文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。

Responses
200

読めた。

reviewobject
Show properties
reviewIdstring
titlestring
tagsstring[]
archivedTsinteger | null

アーカイブした時刻(UNIX 時間のミリ秒)。アーカイブしていなければ null。

accessModestring
Allowed:linkrestricted
allowedUsersobject[]

招待した人。

Show properties
Array of object
emailstring
rolestring
Allowed:editorviewer
orgDomainstring

招待できるメールアドレスのドメイン。

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request
curl -X GET 'https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/access' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "review": {
    "reviewId": "string",
    "title": "string",
    "tags": [
      "string"
    ],
    "archivedTs": 0,
    "accessMode": "link",
    "allowedUsers": [
      {
        "email": "string",
        "role": "editor"
      }
    ],
    "orgDomain": "string"
  }
}