本文へ移動
Bounty Developer

PATCH/api/boshu/calls/{id}/draft

「BOSHU」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。

要約

本人が応募の下書きを版を指定して保存する（応募はしない）

呼び方と印

ログイン・レート制限

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

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • headline任意string | null
    長さ ≤200
  • message任意string
    長さ ≤4000 · 既定 ""
  • links任意array<object>
    件数 ≤3 · 既定 []
  • url必須string
    長さ ≤2048
  • label必須string | null
    長さ ≤120
  • portfolioItemIds任意array<string>
    件数 ≤3 · 既定 []
  • expectedActorId必須string(uuid)
  • expectedRevision必須integer
    ≥0
  • questionSetId必須string(uuid)
  • answers任意record<string | array<string> | boolean>
    既定 {}

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

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

  • draftobject
    • callIdstring
    • eventIdstring
    • revisioninteger
    • questionSetIdstring
    • currentQuestionSetIdstring
    • headlinestring | null
    • messagestring
    • linksarray<object>
      • urlstring
      • labelstring | null
    • portfolioItemIdsarray<string>
    • answersrecord<string | array<string> | boolean>

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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 を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • human_action_required
  • invalid_origin
  • unsupported_media_type
  • rate_limited
  • consent_required
  • actor_changed
  • call_not_found
  • call_closed
  • event_not_found
  • draft_not_found
  • draft_changed
  • already_applied
  • questions_changed
  • unknown_question
  • unknown_upload
  • draft_too_large
  • portfolio_unavailable

呼び出しの見本

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

curl -X PATCH "https://bounty.spikes.4s.link/api/boshu/calls/{id}/draft" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "expectedActorId": "00000000-0000-4000-8000-000000000000",
    "expectedRevision": 0,
    "questionSetId": "00000000-0000-4000-8000-000000000000"
  }'
PATCH /api/boshu/calls/{id}/draft | Bounty Developer