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

案件の一覧を読む

本人が参照できる案件の写しと、自分の案件の役割を返す。個人トークンは any の範囲で使える。案件コードの順に並ぶ。

GET/api/projects
Authorization
AuthorizationBearer token · headerrequired

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

Responses
200

読めた。

projectsProject[]required
Show properties
Array of Project
codestringrequired
namestring | nullrequired
companystring | nullrequired
statusstringrequired
Allowed:activeinactive
inSnapshotbooleanrequired

直近の案件一覧の写しに含まれるか。

myRolestring | nullrequired

要求した本人の案件の役割。

Allowed:managereditorviewernull
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/projects' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "projects": [
    {
      "code": "EX-AA",
      "name": "例の案件",
      "company": "例の会社",
      "status": "active",
      "inSnapshot": true,
      "myRole": "manager"
    }
  ]
}