生産日報 API

productionReportCheckResults を扱う 生産日報 API の仕様です。
共通の認証・ベースURLは 基本情報・認証仕様 を参照してください。

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

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

• 一時保存（下書き）、送信後の修正、データの削除
• 確認・承認フローの実行
• 特記事項の登録
• 画像入力形式（ type=image ）の登録、および表行における参考画像（ imgFileURL ）の送信

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

登録リクエストは、複数件の一括処理（バッチ処理）を考慮し、 常に data 配列で統一 します。
1件のみ登録する場合であっても、要素数が1の配列として送信してください。

2.1 リクエストデータ構造

📂 ルート・帳票階層

2.2 checkItems[] （点検結果）のタイプ別詳細仕様

checkItems[].type の値（ tag / list / table ）に応じて、子要素である items[] のスキーマ構造が変化します。

🏷️ ① type: "tag" （帳票付加情報・ラベル形式）

主に備考、日付といった、単発の入力項目を並べる形式です。

1. 共通オブジェクト構造

2. items[] 内部オブジェクト仕様（入力タイプ別）

items[].type の値に応じて、利用可能・または必須となるオプションパラメータが異なります。

3. 各入力タイプ別のJSONパラメータ構成サンプル(checkItems[]内)

{
  "type": "tag",
  "displayName": "帳票付加情報（タグサンプル）",
  "items": [
    {
      "type": "show",
      "label": "表示のみ",
      "content": "testtext"
    },
    {
      "type": "chipSelect",
      "label": "一覧から選択",
      "content": "a",
      "multiple": false,
      "items": ["a", "b", "c"]
    },
    {
      "type": "text",
      "label": "テキスト入力",
      "content": "テキスト入力確認",
      "placeholder": "hint"
    },
    {
      "type": "number",
      "label": "数値入力",
      "content": "12345",
      "digit": 5,
      "decimalDigit": 2,
      "unit": ""
    },
    {
      "type": "date",
      "label": "日付入力",
      "content": "2026/06/05"
    },
    {
      "type": "time",
      "label": "時間入力",
      "content": "12:15",
      "timeFormat": "HH:mm"
    }
  ]
}

📝 ② type: "list" （縦並び点検リスト形式）

一般的な点検項目に対して、OK/NG や数値を1対1で入力していく標準的な形式です。

1. 共通オブジェクト構造

2. items[] 内部オブジェクト仕様（入力タイプ別）

items[].type の値に応じて、利用可能・または必須となるオプションパラメータが異なります。

3. 各入力タイプ別のJSONパラメータ構成サンプル(checkItems[]内)

{
  "type": "list",
  "displayName": "帳票付加情報（リストサンプル）",
  "items": [
    {
      "type": "okng",
      "content": "OKチェック",
      "checkResult": "OK",
      "required": false,
      "default": "",
      "hasUnoperated": false
    },
    {
      "type": "checkbox",
      "content": "チェックボックス項目",
      "checkResult": true
    },
    {
      "type": "select",
      "content": "プルダウン選択項目",
      "checkResult": "a",
      "required": true,
      "items": ["a", "c", "b"]
    },
    {
      "type": "text",
      "content": "自由記述項目",
      "checkResult": "テキスト入力確認",
      "required": false,
      "placeholder": "hint"
    },
    {
      "type": "number",
      "content": "庫内温度",
      "checkResult": 12345.67,
      "required": false,
      "digit": 5,
      "decimalDigit": 2,
      "min": "",
      "max": "",
      "unit": "℃"
    },
    {
      "type": "date",
      "content": "実施日",
      "checkResult": "2026/06/05",
      "required": true
    },
    {
      "type": "time",
      "content": "確認時間",
      "checkResult": "14:54",
      "required": false,
      "timeFormat": "HH:mm"
    }
  ]
}

📊 ③ type: "table" （マトリクス・表形式）

複数の設備や製品（行）に対して、共通の点検列（例: 結果、確認者）を横並びで入力する形式です。

1. 共通オブジェクト構造

2. items[] 内部オブジェクト仕様（行データ）

各行の属性情報と、 headers の要素数に応じた列データ（ col0 〜）を保持します。

3. 💡 列オブジェクト ( col0 , col1 ... ) の内部スキーマ

中身の構造やオプションフィールドは type="list" の仕様と共通です。

4. 各入力タイプ別のJSONパラメータ構成サンプル(checkItems[]内)

{
  "type": "table",
  "displayName": "帳票付加情報（テーブルサンプル）",
  "headers": [
    "OK/NG",
    "check",
    "プルダウン",
    "テキスト",
    "数値",
    "日付",
    "時間"
  ],
  "items": [
    {
      "content": "1回目",
      "editable": false,
      "selectableCheck": true,
      "isCheck": true,
      "col0": { "type": "okng", "checkResult": "OK", "required": false, "default": "", "hasUnoperated": false },
      "col1": { "type": "checkbox", "checkResult": true },
      "col2": { "type": "select", "checkResult": "選択肢A", "required": true, "items": ["選択肢A", "選択肢B", "選択肢C"] },
      "col3": { "type": "text", "checkResult": "テキスト入力確認", "required": false, "placeholder": "" },
      "col4": { "type": "number", "checkResult": 10, "required": true, "digit": 5, "decimalDigit": 3, "min": 10, "max": 30.123, "unit": "kg", "hideAllowance": true },
      "col5": { "type": "date", "checkResult": "2026/06/04", "required": true },
      "col6": { "type": "time", "checkResult": "15:31:36", "required": false, "timeFormat": "HH:mm:ss" }
    },
    {
      "content": "2回目",
      "editable": true,
      "selectableCheck": true,
      "isCheck": true,
      "col0": { "type": "okng", "checkResult": "NG", "required": false, "default": "", "hasUnoperated": false },
      "col1": { "type": "checkbox", "checkResult": false },
      "col2": { "type": "select", "checkResult": "選択肢C", "required": true, "items": ["選択肢A", "選択肢B", "選択肢C"] },
      "col3": { "type": "text", "checkResult": "テキスト入力確認②", "required": false, "placeholder": "" },
      "col4": { "type": "number", "checkResult": 70.522, "required": true, "digit": 5, "decimalDigit": 3, "min": 10, "max": 30.123, "unit": "kg", "hideAllowance": true },
      "col5": { "type": "date", "checkResult": "2026/06/01", "required": true },
      "col6": { "type": "time", "checkResult": "0:00:00", "required": false, "timeFormat": "HH:mm:ss" }
    },
    {
      "content": "3回目",
      "editable": false,
      "selectableCheck": true,
      "isCheck": false,
      "col0": { "type": "okng", "checkResult": "", "required": false, "default": "", "hasUnoperated": false },
      "col1": { "type": "checkbox", "checkResult": false },
      "col2": { "type": "select", "checkResult": null, "required": true, "items": ["選択肢A", "選択肢B", "選択肢C"] },
      "col3": { "type": "text", "checkResult": "", "required": false, "placeholder": "" },
      "col4": { "type": "number", "checkResult": "", "required": true, "digit": 5, "decimalDigit": 3, "min": 10, "max": 30.123, "unit": "kg", "hideAllowance": true },
      "col5": { "type": "date", "checkResult": "", "required": true },
      "col6": { "type": "time", "checkResult": "", "required": false, "timeFormat": "HH:mm:ss" }
    }
  ]
}

2.3 リクエストJSONサンプル（1件および複数件の構造）

🔹 1件のみ登録する場合（配列の要素数が1）

{
  "data": [
    {
      "sheetName": "開店前点検",
      "sender": "テスト太郎",
      "checkItems": [
        {
          "type": "list",
          "displayName": "衛生点検",
          "items": [
            {
              "type": "okng",
              "content": "手洗い",
              "checkResult": "OK",
              "required": true
            }
          ]
        }
      ]
    }
  ]
}

🔹 複数件を一括登録する場合（配列の要素数が2以上）

{
  "data": [
    {
      "sheetName": "帳票A",
      "sender": "テスト太郎",
      "checkItems": [
        {
          "type": "list",
          "displayName": "衛生点検",
          "items": [
            { "type": "okng", "content": "手洗い", "checkResult": "OK", "required": true }
          ]
        }
      ]
    },
    {
      "sheetName": "帳票B",
      "sender": "テスト次郎",
      "checkItems": [
        {
          "type": "table",
          "displayName": "設備点検",
          "headers": ["結果", "確認者"],
          "items": [
            {
              "content": "コンベア",
              "isCheck": true,
              "col0": { "type": "okng", "checkResult": "OK", "required": true },
              "col1": { "type": "text", "checkResult": "確認" }
            }
          ]
        }
      ]
    }
  ]
}

2.4 入力バリデーションルール（400エラー条件）

本送信登録時、以下のいずれかに該当した場合は不整合データとみなされ、登録が拒否されます。

1. 基本構造の不備 : items が非空の配列でない、または要素内に sheetName , sender , checkItems のいずれかが欠落している。
2. テーブル構造の不一致 : type=table にもかかわらず headers が空、または定義された列数分（ col0 〜 col(n-1) ）のキー行データ内にそろっていない。
3. 必須項目の未入力 : required=true （またはテーブルの点検対象行における必須列）で、 checkResult が未指定、 "" (空文字)、 null のいずれかである。
4. 厳密な型不一致 : type=number に値を指定する場合、 checkResult が文字列（ "4.2" ）で送られている（必ず 数値型の 4.2 であること）。
5. 未知の入力定義 : システムで定義されていない type が指定された場合。

📋 バリデーションエラーメッセージ例 ( results[].error )

失敗時は、原因特定を容易にするため JSONパス付き のメッセージが返却されます。

• checkItems[0]: type must be tag, list, or table (got "foo")
• checkItems[0]: items must be an array
• checkItems[0]: items must be a non-empty array
• checkItems[0] list items[1]: required checkResult is empty ("手洗い")
• checkItems[0]: headers is required ... when type is table
• checkItems[0] table rows[0]: must include col0 through col1 ...
• checkItems[0] table rows[0] col0: required checkResult is empty

2.5 POST レスポンス仕様

HTTPステータスコードは全体成功を示す 200 、または一部成功・一部失敗が混在することを示す 207 Multi-Status を返却します。

レスポンスボディ JSON例 (200 の場合)

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

レスポンスボディ JSON例 (207 Multi-Status の場合)

{
  "status": "partial_success",
  "shopUID": "xxxxxxxxxxxxxxxxxxxx",
  "summary": {
    "requested": 3,
    "created": 2,
    "failed": 1
  },
  "results": [
    {
      "index": 0,
      "status": "success",
      "docId": "yyyyyyyyyyyyyyyyyyyy"
    },
    {
      "index": 1,
      "status": "failed",
      "error": "checkItems[0] list items[2]: required checkResult is empty (\"手洗い\")"
    },
    {
      "index": 2,
      "status": "skipped",
      "skippedReason": "duplicate request"
    }
  ]
}

レスポンス項目定義（ルート）

summary オブジェクト

results[] 要素

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

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

3.1 単一取得（docId 指定）

• Request : GET {baseUrl}?app=productionReport&docId=abc123
• Response (200 OK) :

{
  "data": [
    {
      "id": "yyyyyyyyyyyyyyyyyyyy",
      "sheetName": "帳票A",
      "sender": "テスト太郎",
      "checkItems": [
        /* 構造は 2.2 の定義に準拠 */
        {
          "type": "tag",
          "displayName": "サンプル",
          "items": [
            {
              "type": "show",
              "label": "表示のみ",
              "content": "testtext"
            }
          ]
        }
      ],
      "userUID": "API_COMMON_USER",
      "shopUID": "xxxxxxxxxxxxxxxxxxxx",
      "status": 1,
      "version": 1,
      "checkHistory": [],
      "isNormalForReport": true,
      "registeredAt": "2026/06/04 00:00",
      "confirmedAt": "",
      "confirmerName": "",
      "approvedAt": "",
      "approverName": "",
      "createdAt": "2026/06/04 05:18",
      "sentAt": "2026/06/04 05:18",
      "updatedAt": "2026/06/04 05:18"
    }
  ]
}

3.2 一覧取得（date 指定）

• Request :
• GET {baseUrl}?app=productionReport&date=2026-05 (月次)
• GET {baseUrl}?app=productionReport&date=2026-05-27 (日次)
• Response (200 OK) :

/* 3.1と同じ内容のため割愛 */

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

• 認証されたAPIキーに紐づく shopUID のデータのみに自動制限
• 本送信済み状態である status: 1 のデータのみ を返却（下書きデータ等は除外）
• 営業日順（ registeredAt の昇順 asc ）でソート。同一営業日内は帳票名（ sheetName ）順のソートを推奨。

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

単一取得のレスポンス、および一覧取得の data[] 配列に含まれる各帳票オブジェクトの完全なフィールド仕様です。

🔗 checkHistory[] 要素の内部構造