案件の役割を付け外しする

案件の管理の人が、役割をまとめて付け外しする。メールアドレスは組織内、または組織の台帳に登録された社外・クライアントに限られる。個人トークンは access の範囲が必要。

PATCH/api/projects/{code}/roles

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

codestringrequired

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

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

Request body

requiredapplication/json

setProjectRole[]

案件の役割を付けるか変更する行。

Show properties

Array of ProjectRole

emailstring<email>required

rolestringrequired

Allowed:managereditorviewer

removestring<email>[]

案件から外すメールアドレス。

Responses

200

変更した。

object

400

要求の形や役割が違う（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）、台帳に登録されていないメールアドレスを含む（invite_not_member）、または個人トークンの範囲が不足している（insufficient_scope）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

404

案件が無い（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 PATCH 'https://comment-review.fsmarketing.workers.dev/api/projects/EX-AA/roles' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "set": [
    {
      "email": "someone@example.com",
      "role": "editor"
    }
  ],
  "remove": []
}'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/projects/EX-AA/roles", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"set\": [\n    {\n      \"email\": \"someone@example.com\",\n      \"role\": \"editor\"\n    }\n  ],\n  \"remove\": []\n}"
});

import requests

response = requests.patch(
    "https://comment-review.fsmarketing.workers.dev/api/projects/EX-AA/roles",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"set\": [\n    {\n      \"email\": \"someone@example.com\",\n      \"role\": \"editor\"\n    }\n  ],\n  \"remove\": []\n}",
)

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"
}