GET`/api/participation-visual/events/{eventId}`

「コンテンツ企画」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

管理するイベントの参加表明画像の下書きと版

呼び方と印

ログイン・レート制限

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

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

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

eventIdpath必須string(uuid)

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

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

eventIdstring(uuid)
actorIdstring(uuid)
revisioninteger≥0
enabledboolean
draftobject
- version1
- width1414
- height2000
- purposesobject
  - participationobject
    backgroundobject | object | object
    |1object
    kind"builtin"
    keyenum(5)"tokyo-portrait" "tokyo-assemble-pass-v7" "tokyo-assemble-pass-v7-tight" "tokyo-assemble-pass-v7-beams" "wanted-paper"
    |2object
    kind"image"
    imageIdstring(uuid)
    |3object
    kind"solid"
    colorstring/^#[0-9a-fA-F]{6}$/
    layersarray<object | object | object | object>件数 1–32
    |1object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"avatar"
    shape"rect" | "circle"
    radiusnumber0–0.5
    tilt任意"forward"
    |2object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"rect"
    colorstring/^#[0-9a-fA-F]{6}$/
    opacitynumber0–1
    radiusnumber0–0.5
    gradient任意string/^#[0-9a-fA-F]{6}$/
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    |3object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"logo"
    key"spikes-symbol" | "spikes-wordmark" | "spikes-vertical"
    opacitynumber0–1
    |4object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"text"
    bindingenum(6) | null"name" "title" "university" "needs" "eventTitle" "hashtag"
    textstring長さ ≤200
    colorstring/^#[0-9a-fA-F]{6}$/
    font"sans" | "display" | "wanted"
    fontSizeinteger16–300
    weight400 | 700
    align"left" | "center" | "right"
    maxLinesinteger1–8
    shadow任意object
    colorstring/^#[0-9a-fA-F]{6}$/
    xinteger-16–16
    yinteger-16–16
    blurinteger0–32
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    slant任意"forward"
  - wantedobject
    backgroundobject | object | object
    |1object
    kind"builtin"
    keyenum(5)"tokyo-portrait" "tokyo-assemble-pass-v7" "tokyo-assemble-pass-v7-tight" "tokyo-assemble-pass-v7-beams" "wanted-paper"
    |2object
    kind"image"
    imageIdstring(uuid)
    |3object
    kind"solid"
    colorstring/^#[0-9a-fA-F]{6}$/
    layersarray<object | object | object | object>件数 1–32
    |1object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"avatar"
    shape"rect" | "circle"
    radiusnumber0–0.5
    tilt任意"forward"
    |2object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"rect"
    colorstring/^#[0-9a-fA-F]{6}$/
    opacitynumber0–1
    radiusnumber0–0.5
    gradient任意string/^#[0-9a-fA-F]{6}$/
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    |3object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"logo"
    key"spikes-symbol" | "spikes-wordmark" | "spikes-vertical"
    opacitynumber0–1
    |4object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"text"
    bindingenum(6) | null"name" "title" "university" "needs" "eventTitle" "hashtag"
    textstring長さ ≤200
    colorstring/^#[0-9a-fA-F]{6}$/
    font"sans" | "display" | "wanted"
    fontSizeinteger16–300
    weight400 | 700
    align"left" | "center" | "right"
    maxLinesinteger1–8
    shadow任意object
    colorstring/^#[0-9a-fA-F]{6}$/
    xinteger-16–16
    yinteger-16–16
    blurinteger0–32
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    slant任意"forward"
publishedRevisioninteger | null≥0
publishedobject | null
- version1
- width1414
- height2000
- purposesobject
  - participationobject
    backgroundobject | object | object
    |1object
    kind"builtin"
    keyenum(5)"tokyo-portrait" "tokyo-assemble-pass-v7" "tokyo-assemble-pass-v7-tight" "tokyo-assemble-pass-v7-beams" "wanted-paper"
    |2object
    kind"image"
    imageIdstring(uuid)
    |3object
    kind"solid"
    colorstring/^#[0-9a-fA-F]{6}$/
    layersarray<object | object | object | object>件数 1–32
    |1object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"avatar"
    shape"rect" | "circle"
    radiusnumber0–0.5
    tilt任意"forward"
    |2object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"rect"
    colorstring/^#[0-9a-fA-F]{6}$/
    opacitynumber0–1
    radiusnumber0–0.5
    gradient任意string/^#[0-9a-fA-F]{6}$/
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    |3object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"logo"
    key"spikes-symbol" | "spikes-wordmark" | "spikes-vertical"
    opacitynumber0–1
    |4object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"text"
    bindingenum(6) | null"name" "title" "university" "needs" "eventTitle" "hashtag"
    textstring長さ ≤200
    colorstring/^#[0-9a-fA-F]{6}$/
    font"sans" | "display" | "wanted"
    fontSizeinteger16–300
    weight400 | 700
    align"left" | "center" | "right"
    maxLinesinteger1–8
    shadow任意object
    colorstring/^#[0-9a-fA-F]{6}$/
    xinteger-16–16
    yinteger-16–16
    blurinteger0–32
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    slant任意"forward"
  - wantedobject
    backgroundobject | object | object
    |1object
    kind"builtin"
    keyenum(5)"tokyo-portrait" "tokyo-assemble-pass-v7" "tokyo-assemble-pass-v7-tight" "tokyo-assemble-pass-v7-beams" "wanted-paper"
    |2object
    kind"image"
    imageIdstring(uuid)
    |3object
    kind"solid"
    colorstring/^#[0-9a-fA-F]{6}$/
    layersarray<object | object | object | object>件数 1–32
    |1object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"avatar"
    shape"rect" | "circle"
    radiusnumber0–0.5
    tilt任意"forward"
    |2object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"rect"
    colorstring/^#[0-9a-fA-F]{6}$/
    opacitynumber0–1
    radiusnumber0–0.5
    gradient任意string/^#[0-9a-fA-F]{6}$/
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    |3object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"logo"
    key"spikes-symbol" | "spikes-wordmark" | "spikes-vertical"
    opacitynumber0–1
    |4object
    idstring/^[a-zA-Z0-9_-]{1,40}$/
    xnumber0–1
    ynumber0–1
    widthnumber0.0007072135785007072–1
    heightnumber0.0005–1
    kind"text"
    bindingenum(6) | null"name" "title" "university" "needs" "eventTitle" "hashtag"
    textstring長さ ≤200
    colorstring/^#[0-9a-fA-F]{6}$/
    font"sans" | "display" | "wanted"
    fontSizeinteger16–300
    weight400 | 700
    align"left" | "center" | "right"
    maxLinesinteger1–8
    shadow任意object
    colorstring/^#[0-9a-fA-F]{6}$/
    xinteger-16–16
    yinteger-16–16
    blurinteger0–32
    tilt任意"forward"
    requires任意enum(6)"name" "title" "university" "needs" "eventTitle" "hashtag"
    slant任意"forward"

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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 "https://bounty.spikes.4s.link/api/participation-visual/events/{eventId}" \
  -H "Authorization: Bearer $BEARER_AUTH"