本文へ移動
Bounty Developer

POST/api/planning/{eventId}/lines

「コンテンツ企画」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

ラインを作る（名前はイベントの中で一意。色は点の色の名前 = lib/tint.ts の TINTS）

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • eventIdpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • name必須string
    長さ 1–40
  • color任意enum(7)
    • "sand"
    • "sky"
    • "mint"
    • "lilac"
    • "rose"
    • "lemon"
    • "slate"
    既定 "slate"
  • sort任意integer
    0–9999
  • roomIds任意array<string(uuid)>
    件数 ≤50 · 既定 []
  • members任意array<object>
    件数 ≤50 · 既定 []
  • userId必須string(uuid)
  • role任意"lead" | "member"
    既定 "member"
  • autoJoin任意boolean
    既定 true

返るもの（応答）201 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • revinteger≥0
  • lineobject
    • idstring(uuid)
    • eventIdstring(uuid)
    • namestring
    • colorenum(7)"sand" "sky" "mint" "lilac" "rose" "lemon" "slate"
    • sortinteger
    • roomIdsarray<string(uuid)>
    • membersarray<object>
      • userIdstring(uuid)
      • displayNamestring
      • avatarUrlstring | null
      • role"lead" | "member"
      • autoJoinboolean
    • contentCountinteger≥0

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 501HTTP 501（x-bounty-error-codes を参照）
  • unauthorized
  • forbidden
  • invalid_input
  • invalid_origin
  • consent_required
  • event_not_found
  • line_name_taken
  • too_many_lines
  • room_not_found
  • account_not_found

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X POST "https://bounty.spikes.4s.link/api/planning/{eventId}/lines" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'
POST /api/planning/{eventId}/lines | Bounty Developer