本文へ移動
Bounty Developer

POST/api/participation-visual/events/{eventId}/background

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

要約

本人の content_thumbnail staged upload をイベント素材へ一回だけ消費。cookie multipart file/expectedActorId も可

呼び方と印

ログイン・レート制限

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

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

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

  • eventIdpath必須string(uuid)

送るもの（本文）application/json

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

  • expectedActorId必須string(uuid)
  • uploadId必須string(uuid)

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

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

  • idstring(uuid)
  • imageIdstring(uuid)
  • urlstring
  • widthinteger
  • heightinteger

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 429レート制限（Retry-After 付き）
  • unauthorized
  • invalid_token
  • invalid_origin
  • invalid_input
  • payload_too_large
  • forbidden
  • consent_required
  • actor_changed
  • event_not_found
  • visual_revision_conflict
  • background_not_owned_by_event
  • background_unavailable
  • rate_limited

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/participation-visual/events/{eventId}/background" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "expectedActorId": "00000000-0000-4000-8000-000000000000",
    "uploadId": "00000000-0000-4000-8000-000000000000"
  }'
POST /api/participation-visual/events/{eventId}/background | Bounty Developer