文書を案件に結び付ける

文書のオーナー、または結び付け元と先の案件を管理する人が、文書を案件へ結び付けるか付け替える。個人トークンは access の範囲が必要。

PUT/api/projects/{code}/docs/{reviewId}

Authorization

AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Path parameters

codestringrequired

案件コード。大文字・小文字は区別せず、大文字に正規化して扱う。

matches ^[A-Z0-9][A-Z0-9-]{0,31}$

reviewIdstringrequired

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

Responses

200

結び付けた。

object

400

案件コードまたは文書 ID の形が違う（invalid_request）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

401

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

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

403

結び付ける権限が無い（forbidden）、案件で編集以上の役割が無い（project_role_required）、または個人トークンの範囲が不足している（insufficient_scope）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

404

文書または案件が無い（not found または project_not_found）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

409

同時変更と競合した（project_conflict）か、案件が写しに無い（project_not_in_snapshot）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

Request

curl -X PUT 'https://comment-review.fsmarketing.workers.dev/api/projects/EX-AA/docs/review_example01' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/projects/EX-AA/docs/review_example01", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.put(
    "https://comment-review.fsmarketing.workers.dev/api/projects/EX-AA/docs/review_example01",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}