giip

CatQuest データ API リファレンス

🐾 CatQuest ページへ移動 →

CatQuest 画面は giip イシュー一覧 API(giipIssues) を読み取り、各イシューを猫カードとして描画します。本ドキュメントは、そのデータ元を API で直接取得 する方法と、画面の状態→猫マッピングを説明します。

  • ホスト: https://giipfaw.azurewebsites.net
  • 認証: ヘッダー x-api-key にログインユーザーの AK(またはプロジェクトスコープ SK)。取得範囲はキーの csn(プロジェクト) に制限されます。
  • 結果コード(RstVal) の規約は API 結果コード を参照してください。

イシュー一覧取得 — giipIssues GET

CatQuest がページ読み込み時に呼び出す読み取り API です。

curl "https://giipfaw.azurewebsites.net/api/giipIssues?csn=47" \
  -H "x-api-key: <YOUR_AK>"

リクエストパラメータ

名前位置必須説明
csnquery取得するプロジェクト番号。CatQuest は現在選択中のプロジェクトの csn を自動で入れます。

レスポンス例

{
  "issues": [
    {
      "isn": 735,
      "title": "admin/catquest ユーザーガイド作成",
      "status": "READY",
      "regdate": "2026-07-24T08:54:00Z",
      "summary": "ガイドボタンの有効化",
      "last_comment_date": "2026-07-24T09:00:00Z",
      "blocked_by_isn": null,
      "blocked_by_title": null
    }
  ]
}

レスポンスフィールド(CatQuest が使用するもの)

フィールド画面での用途
isnnumberイシュー番号(#isn バッジ)。どの猫を割り当てるかも isn で決まります。
titlestringカード上部の吹き出しタイトル
statusstring猫の動き(アニメーション)を決定 — 下記マッピング参照
regdatestring登録日時(🐣)
summarystringカード下部の要約(存在する場合のみ)
last_comment_datestring | null最終コメント日時(💬)、無ければ「コメント無し」
blocked_by_isnnumber | null待機(blocked-by)バッジ — このイシューをブロックしている占有イシューの番号
blocked_by_titlestring | null待機バッジのツールチップ(占有イシューのタイトル)

状態 → 猫の動き マッピング

CatQuest フロントが status 値を次のルールでアニメーションにマッピングします(サーバー値ではなく画面表現ルール)。

status猫の状態画像ファイルパターン
PENDINGplaying/images/catquest/<cat>_playing.png
READYready/images/catquest/<cat>_ready.png
IN_PROGRESShunting/images/catquest/<cat>_hunting.png
REVIEWdelivering/images/catquest/<cat>_delivering.png
DONEplaying/images/catquest/<cat>_playing.png
  • <cat>isn % 8 で 8 種(mochi・sherlock・nimbus・pixel・cocoa・midnight・luna・leo)のいずれかが固定割り当てされます。

関連 API

  • イシュー登録・修正・状態変更: プログラムでイシューを生成/遷移するには イシュー・タスク API を参照してください。
  • コメント取得/追加: イシュー詳細画面は giipIssueComments API を使用します。

トラブルシューティング

症状原因解決
401 Unauthorizedx-api-key の欠落または期限切れ有効な AK で再度呼び出すか再ログインします。
空の issues: []その csn にイシューが無いcsn 値を確認するかイシューを登録します。
csn 無しで呼び出し必須パラメータの欠落必ず ?csn=<番号> を含めます。

バージョン: 1.0 最終更新: 2026-07-24 ソースファイル: giipv3/public/help/api-catquest.ja.md