本文へ移動
Bounty Developer

GET/api/boshu/shelf

「BOSHU の管理」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

持ち主の共通モジュールの棚（募集を作る前の組み立ての画面。持ち主の募集を作れる人だけ。読むだけ）

呼び方と印

ログイン

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

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

  • ownerKindquery必須enum(5)
    • "platform"
    • "event"
    • "guild"
    • "venture"
    • "person"
  • ownerIdquery任意string(uuid) | null

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

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

  • shelfarray<object>
    • idstring
    • keystring
    • eventIdstring | null
    • destinationsarray<string>
    • revisioninteger
    • bodyobject
      • titlestring
      • helpstring | null
      • questionsarray<object>
        • idstring
        • typestring
        • labelstring
    • archivedAt任意string | null

失敗したとき（エラー）

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

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • invalid_input
  • forbidden

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/boshu/shelf?ownerKind=platform" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/boshu/shelf | Bounty Developer