中心温度 API

中心温度 ( app=coreThermo )の点検結果を扱う API の仕様です。
共通の認証・ベースURLは 基本情報・認証仕様 を参照してください。


1. 🗺️ エンドポイント一覧

メソッドエンドポイント(クエリパラメータ)処理概要
POST?app=coreThermo点検結果の本送信登録
GET?app=coreThermo&docId={id}点検結果の単一取得
GET?app=coreThermo&date=YYYY-MM月次一覧取得(営業日基準)
GET?app=coreThermo&date=YYYY-MM-DD日次一覧取得(営業日基準)

⚠️ 非対応スコープ(制限事項)
以下の操作およびデータ連携には対応していません。

  • 送信後の修正、データの削除
  • 確認・承認フローの実行
  • 特記事項(コメント)の登録
  • 本部点検票の紐づけ設定
  • 点検画像のアップロード
  • NG 時のメール通知
  • 帳票マスタ(点検票・グループ・点検項目)の取得・更新
  • スケジュール完了の登録

2. 📥 POST: 点検結果の登録

登録リクエストは、複数件の一括処理(バッチ処理)を考慮し、 常に data 配列で統一 します。
1件のみ登録する場合であっても、要素数が1の配列として送信してください。
点検項目は checkItems 配列で送信します。保存・GET では画面と同じ contents キーになります。

2.1 リクエストデータ構造

物理キー論理名データ型必須状況概要・制約
data登録対象一覧array必須登録対象とする中心温度点検オブジェクトの配列。
data[].sheetName帳票名string必須点検票の名称(例: "加熱後中心温度")。空文字不可。
data[].sender送信者名string必須点検を実施・送信した担当者の氏名(例: "山田太郎")。空文字不可。
data[].tagsグループ情報array任意 画面のグループ情報。未指定時は空配列として保存。詳細は 2.2 参照。
data[].checkItems点検項目array必須点検項目オブジェクトの配列(1件以上)。詳細は 2.3 参照。

2.2 tags[](グループ情報)の構造

画面のグループ情報と同じく、保存時は uid / label / type / content のみです。 chipSelect の複数選択は content を配列で送ると "A,B" の文字列に結合します。

物理キー論理名データ型必須状況概要・制約
labelラベルstring必須グループの表示名(例: "商品名")。空文字不可。
type入力タイプstring必須"show" / "chipSelect" / "text" / "number" / "date" / "time" 。
content入力値string | string[] | number任意 保存される表示値。未指定時は空文字。 配列はカンマ結合、数値は文字列化して保存します。

2.3 checkItems[](点検項目)の構造

物理キー論理名データ型必須状況概要・制約
content点検内容string必須点検内容の表示名(例: "中心温度")。空文字不可。
type入力タイプstring必須"okng" / "checkbox" / "select" / "text" / "number" / "date" / "time" 。
checkResult点検結果type により異なる条件付き必須回答値。型は下表を参照。
required必須フラグboolean任意true の場合、checkResult の入力が必須。
referable前回結果参照boolean任意未指定時は false として保存。
items選択肢string[]条件付き必須type: "select" のとき必須。1件以上の文字列配列。
min許容下限number | ""任意type: "number" 時の管理下限。制限なしは空文字または未指定。
max許容上限number | ""任意type: "number" 時の管理上限。制限なしは空文字または未指定。
unit単位string任意数値入力時の単位(例: "℃")。
timeFormat時間形式string任意type: "time" 時。 "HH:mm:ss" / "HH:mm" / "mm:ss" 。未指定時は "HH:mm:ss" 。
placeholder入力ヒントstring任意テキスト入力時のプレースホルダー。

入力タイプと checkResult の対応

typecheckResult の型指定する値点検結果の判定
"okng"string"OK" / "NG" / """NG" のとき NG。空は正常。
"checkbox"booleantrue / false。未指定時は false常に正常。
"select"string選択肢のいずれか、または空文字常に正常。
"text" / "date" / "time"string入力文字列、または空文字常に正常。
"number"number | string数値。文字列も受け付け、数値として保存min / max の範囲外なら NG。空は正常。

2.4 リクエストJSONサンプル

{
  "data": [
    {
      "sheetName": "加熱後中心温度",
      "sender": "山田太郎",
      "tags": [
        {
          "label": "商品名",
          "type": "text",
          "content": "唐揚げ"
        }
      ],
      "checkItems": [
        {
          "content": "中心温度",
          "type": "number",
          "checkResult": 75.5,
          "required": true,
          "unit": "℃",
          "min": 75,
          "max": ""
        },
        {
          "content": "外観",
          "type": "okng",
          "checkResult": "OK",
          "required": true
        }
      ]
    }
  ]
}

2.5 入力バリデーションルール

  1. 基本構造の不備 : リクエスト JSON 全体に data 配列が存在しない、または空配列である。
  2. 必須項目の欠落 : sheetName / sender が未指定または空文字、 checkItems が配列でない、または空配列である。
  3. 必須点検項目の未入力 : required: true の項目で checkResult が空の場合は登録不可。
  4. 入力タイプの不正 : 点検項目・グループの type が許可値以外。
  5. 数値範囲設定の不整合 : type: "number" で min と max の両方を指定する場合、 min <= max である必要があります。

💡 点検結果が NG になる場合について
type: "okng" かつ checkResult が "NG" 、または数値が min / max の範囲外の場合、登録される点検結果は NG(異常あり) 扱いになります。 データの登録自体は成功します。 1件でも NG 判定の項目があれば、そのレコード全体が NG 扱いになります。


2.6 POST レスポンス仕様

HTTPステータスコードは全体成功を示す 200 、一部成功を示す 207 Multi-Status 、全件失敗を示す 400 を返却します。

{
  "status": "success",
  "shopUID": "xxxxxxxxxxxxxxxxxxxx",
  "summary": {
    "requested": 1,
    "created": 1,
    "failed": 0
  },
  "results": [
    {
      "index": 0,
      "status": "success",
      "docId": "core_thermo_doc_id_11111"
    }
  ]
}

3. 📤 GET: 点検結果の取得

取得系APIにおいて、レスポンスに含まれるすべての日付・時刻フィールドは、 YYYY/MM/DD HH:mm の文字列形式に統一されて返却されます。

3.1 単一取得(docId 指定)

  • Request: GET {baseUrl}?app=coreThermo&docId=core_thermo_doc_id_11111
{
  "data": [
    {
      "id": "core_thermo_doc_id_11111",
      "userUID": "API_COMMON_USER",
      "shopUID": "xxxxxxxxxxxxxxxxxxxx",
      "groupUID": "core_thermo_doc_id_11111",
      "sheetName": "加熱後中心温度",
      "sender": "山田太郎",
      "tags": [
        {
          "uid": "",
          "label": "商品名",
          "type": "text",
          "content": "唐揚げ"
        }
      ],
      "contents": [
        {
          "uid": "",
          "content": "中心温度",
          "type": "number",
          "referable": false,
          "required": true,
          "checkResult": 75.5,
          "isShowMinus": false,
          "unit": "℃",
          "digit": 5,
          "decimalDigit": 2,
          "min": 75,
          "max": ""
        },
        {
          "uid": "",
          "content": "外観",
          "type": "okng",
          "referable": false,
          "required": true,
          "checkResult": "OK"
        }
      ],
      "isNormalForReport": true,
      "registeredAt": "2026/08/20 00:00",
      "sentAt": "2026/08/20 09:16",
      "confirmedAt": "",
      "confirmerName": "",
      "approvedAt": "",
      "approverName": "",
      "createdAt": "2026/08/20 09:16",
      "updatedAt": "2026/08/20 09:16"
    }
  ]
}

3.2 一覧取得(date 指定)

  • GET {baseUrl}?app=coreThermo&date=2026-08(月次一覧取得)
  • GET {baseUrl}?app=coreThermo&date=2026-08-20(日次一覧取得)

💡 サーバー側での自動フィルタリング・ソート規則

  • 認証されたAPIキーに紐づく shopUID のデータのみに自動制限されます。
  • データは 営業日順(registeredAt の昇順) 、同じ営業日内においては 帳票名順(sheetName の昇順) でソートして返却されます。

3.3 🗂️ 点検結果オブジェクト詳細定義(GETレスポンス)

フィールドキー論理名データ型概要・返却値のルール
idドキュメントIDstringデータベース上で一意に割り振られたドキュメントID。
groupUIDグループIDstring初回送信時の点検結果UID。API登録ではドキュメントIDと同じ値。
sheetName帳票名string登録された点検票の名称。
sender送信者名stringリクエスト時に指定された担当者名。
userUIDユーザーIDstringAPI経由の場合は一律で "API_COMMON_USER"。
shopUID店舗IDstringAPIキーから紐づけられた店舗コード。
tagsグループ情報arrayPOST の tags を正規化した配列。
contents点検項目array POST の checkItems を画面と同じキーで保存した配列。
isNormalForReport日報用正常判定boolean 登録内容をもとに自動判定された正常( true )/ NG・異常あり( false )の状態フラグ。
registeredAt登録日時(営業日)string店舗の閉店時刻を加味した営業日(JST 00:00 固定)。
sentAt送信日時stringサーバーがリクエストを受理・永続化した日時。
createdAt作成日時stringドキュメントの初回作成日時。
updatedAt更新日時stringドキュメントの最終更新日時。
confirmedAt確認日時stringアプリ画面側で確認フローが実行された日時。未確認時は ""。
confirmerName確認者氏名string確認を行ったユーザーの氏名。未確認時は ""。
approvedAt承認日時stringアプリ画面側で承認フローが実行された日時。未承認時は ""。
approverName承認者氏名string承認を行ったユーザーの氏名。未承認時は ""。