案件の役割を読む

案件の管理の人とツール管理者が、その案件の役割を読む。個人トークンは access の範囲が必要。

GET/api/projects/{code}/roles

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

codestringrequired

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

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

Responses

200

読めた。

codestringrequired

rolesProjectRole[]required

Show properties

Array of ProjectRole

emailstring<email>required

rolestringrequired

Allowed:managereditorviewer

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）か、個人トークンの範囲が不足している（insufficient_scope）。

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/projects/EX-AA/roles' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

import requests

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

Response

{
  "code": "EX-AA",
  "roles": [
    {
      "email": "someone@example.com",
      "role": "manager"
    }
  ]
}

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

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

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