本文へ移動
Bounty Developer

POST/api/boshu/calls/{id}/questionnaire/modules

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

要約

棚の共通モジュールを参照で差し込む（棚の今の revision を写して版を足す）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • moduleId必須string(uuid)
  • at任意integer | null
    0–20
  • expectedVersion任意integer | null
    ≥0

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

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

  • versioninteger
  • changedboolean
  • reapprovedboolean
  • pendingReviewboolean
  • questionnaireobject
    • callIdstring(uuid)
    • versioninteger | null
    • pageobject
      • idstring
      • destinationstring
      • placementstring
      • titlestring
      • modulesarray<object | object>
        • |1object
          • kind"shared"
          • idstring
          • moduleIdstring
          • pinned任意object
            • revisioninteger
            • bodyobject
              • titlestring
              • helpstring | null
              • questionsarray<object>
        • |2object
          • kind"inline" | "legacy"
          • idstring
          • bodyobject
            • titlestring
            • helpstring | null
            • questionsarray<object>
    • placedarray<object>
      • refIdstring
      • moduleIdstring
      • revisioninteger | null
      • shelfRevisioninteger | null
      • outdatedboolean
      • archivedboolean
    • shelfarray<object>
      • idstring
      • keystring
      • eventIdstring | null
      • destinationsarray<string>
      • revisioninteger
      • bodyobject
        • titlestring
        • helpstring | null
        • questionsarray<object>
          • idstring
          • typestring
          • labelstring
      • archivedAt任意string | null
      • placedboolean
      • canEditboolean

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 422HTTP 422（x-bounty-error-codes を参照）
  • questions_changed
  • call_not_found
  • invalid_input
  • manager_reverify_required
  • questionnaire_invalid
  • creative_questions_required
  • member_selection_requires_organization
  • module_not_found
  • module_already_placed
  • too_many_modules

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/boshu/calls/{id}/questionnaire/modules" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "moduleId": "00000000-0000-4000-8000-000000000000"
  }'
POST /api/boshu/calls/{id}/questionnaire/modules | Bounty Developer