本文へ移動
Bounty Developer

POST/api/planning/{eventId}/blocks

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

要約

下書きのコンテンツをステージと時刻に作る(kind は format から決まる。lineId を省くとステージの既定のライン)

呼び方と印

ログイン・レート制限

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

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

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

  • eventIdpath必須string(uuid)

送るもの(本文)application/json

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

  • title必須string
    長さ 1–120
  • format必須enum(17)
    • "guild_market"
    • "student_startup"
    • "partner_market"
    • "product_launch"
    • "creative_showcase"
    • "tech_talk"
    • "save_the_world"
    • "preference_blitz"
    • "mini_blitz"
    • "aufheben"
    • "nomad"
    • "stage"
    • …+5
  • roomId任意string(uuid) | null
  • startsAt任意string(date-time) | null
  • endsAt任意string(date-time) | null
  • lineId任意string(uuid) | null

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

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

  • revinteger≥0
  • blockobject
    • idstring(uuid)
    • revisionstring長さ 1–40
    • kind"stage" | "booth" | "experience"
    • formatstring
    • formatLabelstring
    • contentLabelstring | null
    • titlestring
    • status"draft" | "published"
    • placement"timed" | "allday" | "unscheduled"
    • daystring(date) | null
    • startsAtstring(date-time) | null
    • endsAtstring(date-time) | null
    • roomIdstring(uuid) | null
    • lineIdstring(uuid) | null
    • sortinteger
    • speakersarray<object>
      • speakerIdstring(uuid)
      • roleenum(5)"speaker" "moderator" "host" "judge" "lt"
      • featuredboolean
      • sortinteger
    • openCallIdsarray<string(uuid)>
    • thumbnailobject
      • revinteger≥0
      • designedboolean
      • renderedRevinteger | null≥0
    • chatConversationIdstring(uuid) | null
    • boothobject | null
      • boothIdstring(uuid) | null
      • parentContentIdstring(uuid) | null
      • assignmentsarray<object>
        • daystring(date) | null
        • slotKeystring
        • numberstring | null
        • state"draft" | "confirmed"
    • updatedAtstring(date-time)

失敗したとき(エラー)

失敗したときの状態コードと、その意味。本文の 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
  • room_not_found
  • line_not_found
  • line_event_mismatch
  • format_not_allowed
  • booth_not_schedulable

呼び出しの見本

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

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