本文へ移動
Bounty Developer

GET/api/boshu/calls/{id}/selection/review

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

要約

担当する選考と権限のある応募資料を読む

呼び方と印

ログイン・レート制限

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

URL に付ける値(パラメータ)

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

  • idpath必須string(uuid)

返るもの(応答)200 · application/json

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

  • callIdstring(uuid)
  • titlestring
  • mode"review" | "first_come"
  • flowobject | null
    • idstring(uuid)
    • callIdstring(uuid)
    • versioninteger≥1
    • revisioninteger≥0
    • state"draft" | "active" | "retired"
    • stagesarray<object>件数 ≤5
      • 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
  • permissionsobject
    • canDesignboolean
    • canPublishboolean
    • canSeeSensitiveboolean
    • stageIdsarray<string(uuid)>
  • applicationsarray<object>
    • applicationIdstring(uuid)
    • attemptIdstring(uuid)
    • attemptNointeger≥1
    • revisioninteger≥0
    • currentStageIdstring(uuid)
    • finalStageOrderinteger1–5
    • state"active" | "completed" | "withdrawn" | "superseded"
    • overallStatusstring
    • displayNamestring
    • applicantNamestring | null
    • materialsobject
      • headlinestring | null
      • messagestring
      • linksarray<object>
        • urlstring
        • labelstring | null
      • answersarray<object>
        • questionIdstring
        • labelstring
        • textstring
        • imageUrlstring | null
        • documentUrl任意string | null
        • sensitiveboolean
        • hiddenboolean
        • required任意boolean
      • portfolioarray<object>
        • idstring
        • titlestring
        • urlstring
        • descriptionstring
        • entryType任意"work" | "lightning_talk"
        • format任意enum(14)"video" "animation" "photography" "image" "graphic" "audio" "music" "writing" "product" "software" "game" "hardware" …+2
        • tools任意array<string>
        • technicalDetails任意record<array<string>>
        • technicalNote任意string
        • attachment任意object
          • kind"pdf"
          • urlstring
        • media任意object
          • kind"image" | "video"
          • urlstring
          • posterUrl任意string
          • durationSec任意number
          • width任意integer
          • height任意integer
      • portfolioMissinginteger≥0
    • stagesarray<object>件数 ≤5
      • 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 · 既定 []
        • 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
    • reviewsarray<object>
      • stageIdstring(uuid)
      • savedDecisionenum(5)"pending" "hold" "passed" "rejected" "waitlisted"
      • publishedDecisionenum(5) | null"pending" "hold" "passed" "rejected" "waitlisted"
      • revisioninteger≥0
      • publishedRevisioninteger≥0
      • notestring
      • instructionsstring
      • savedAtstring(date-time) | null
      • publishedAtstring(date-time) | null
    • submissionsarray<object>
      • idstring(uuid)
      • stageIdstring(uuid)
      • revisioninteger≥0
      • submittedAtstring(date-time)
      • 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 · 既定 []
        • 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}$/
      • answersrecord<string | array<string> | boolean>
    • permissionsobject
      • canDesignboolean
      • canPublishboolean
      • canSeeSensitiveboolean
      • stageIdsarray<string(uuid)>
      • canSubmitboolean
    • chatConsentboolean
  • assignments任意array<object>
    • userIdstring(uuid)
    • displayNamestring
    • stageIdstring(uuid)
    • activeboolean
    • canPublishboolean
    • canSeeSensitiveboolean

失敗したとき(エラー)

失敗したときの状態コードと、その意味。本文の 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 を参照)
  • 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

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/boshu/calls/{id}/selection/review" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/boshu/calls/{id}/selection/review | Bounty Developer