本文へ移動
Bounty Developer

POST/api/boshu/calls/{id}/selection/applications/{applicationId}/publish-preview

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

要約

判定公開と固定する通知メールを人が確認する

呼び方と印

ログイン・レート制限

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

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

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

  • idpath必須string(uuid)
  • applicationIdpath必須string(uuid)

送るもの（本文）application/json

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

  • expectedRevision必須integer
    ≥0
  • stageId必須string(uuid)
  • correction任意boolean
    既定 false
  • mailPayloadHash任意string
    /^[a-f0-9]{64}$/

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

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

  • applicationIdstring(uuid)
  • attemptIdstring(uuid)
  • revisioninteger≥0
  • stageIdstring(uuid)
  • savedDecisionenum(5)"pending" "hold" "passed" "rejected" "waitlisted"
  • publishedDecisionenum(5) | null"pending" "hold" "passed" "rejected" "waitlisted"
  • isFinalboolean
  • nextStageobject | null
    • idstring(uuid)
    • namestring長さ 1–80
    • deadlineAtstring(date-time) | null
    • instructionsUrlstring(uri) | null長さ ≤2048
    • instructionsstring長さ ≤4000 · 既定 ""
    • questionsarray<object>件数 ≤60
      • idstring/^q_[a-z0-9]{4,24}$/
      • typeenum(9)"short" "long" "single" "multi" "check" "url" "date" "image" "document"
      • labelstring長さ 1–120
      • helpstring | null長さ ≤1000
      • requiredboolean既定 false
      • enabled任意boolean
      • optionsarray<object>件数 ≤20 · 既定 []
        • idstring/^o_[a-z0-9]{1,24}$/
        • labelstring長さ 1–60
      • sensitiveboolean既定 false
      • maxLength任意integer1–2000
      • section任意string長さ 1–80
      • organizationField任意enum(11)"name" "nameKana" "organizationType" "baseUniversities" "foundedYearMonth" "memberCount" "studentMemberCount" "genres" "links" "catchphrase" "activitySummary"
      • profileField任意enum(9)"displayName" "title" "orgName" "schoolName" "gradYear" "organizations" "faculty" "standing" "grade"
      • memberSelection任意object
        • kind"active_student"
        • min1
        • max3
      • condition任意object
        • questionIdstring/^q_[a-z0-9]{4,24}$/
        • optionIdstring/^o_[a-z0-9]{1,24}$/
    • flowIdstring(uuid)
    • orderinteger1–5
  • resultingOverallStatusstring
  • instructionsstring
  • chatEligibleboolean
  • mailobject
    • subjectstring
    • textstring
    • status"pending" | "blocked"
    • reasonstring | null
    • payloadHashstring/^[a-f0-9]{64}$/

失敗したとき（エラー）

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

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • human_action_required
  • invalid_origin
  • forbidden
  • consent_required
  • invalid_input
  • revision_conflict
  • call_not_found
  • application_not_found
  • selection_application_not_found
  • stage_not_found
  • self_review
  • withdrawn
  • decision_not_ready
  • review_material_changed
  • correction_required
  • correction_not_available
  • stage_not_current
  • downstream_result_preserved
  • stage_submission_required

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/boshu/calls/{id}/selection/applications/{applicationId}/publish-preview" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "expectedRevision": 0,
    "stageId": "00000000-0000-4000-8000-000000000000"
  }'
POST /api/boshu/calls/{id}/selection/applications/{applicationId}/publish-preview | Bounty Developer