跳轉到

基本欄位

單行文字、多行文字

範例:

{ // 單行文字
  "code": "C002",
  "value": "這是單行文字"
},
{ // 多行文字
  "code": "C003",
  "value": "這是多行文字"
}

數值

範例:

{ // 數值
  "code": "C002",
  "value": 123
}

日期、日期時間

結構: 字串

範例:

{ // 日期
  "code": "C002",
  "value": "2025/08/26"
},
{ // 日期時間
  "code": "C003",
  "value": "2025/08/26 14:20" 
}

明細

明細物件比較複雜,我們將其拆解成 row (列) 和 column (欄) 來看,假如表單中設計一個表格結構如下:

名稱(C003) 購買日期(C004) 數量(C005)
單行文字 日期 數值

欄位一是 單行文字欄位,欄位二是 日期欄位,欄位三是 數值欄位

如果要產生如下的資料內容

名稱 購買日期 數量
筆電 2025/05/02 1
桌上型電腦 2025/06/23 2

則其物件結構會如下

{ // 明細
  "code": "C002",
  "value": [
    [ //第一列 row 的資料
      { // 欄位一
        "code": "C003",
        "value": "筆電"
      },
      { // 欄位二
        "code": "C004",
        "value": "2025/05/02"
      },
      { // 欄位三
        "code": "C005",
        "value": 1
      }
    ],
    [ //第二列 row 的資料
      { // 欄位一
        "code": "C003",
        "value": "桌上型電腦"
      },
      { // 欄位二
        "code": "C004",
        "value": "2025/06/23"
      },
      { // 欄位三
        "code": "C005",
        "value": 2
      }
    ]
  ]
}

單選清單

假設單選清單有下列選項: 可樂、紅茶、綠茶、其他

並且有開啟 擴充文字 設定

選擇 可樂,並在擴充文字寫 去冰

{ // 單選清單
  "code": "C002",
  "value": {
    "name": "可樂", // 選項
    "fillText": "去冰" // 擴充文字
  }
}

選擇 其他,並在文字欄位寫 咖啡

{ // 單選清單
  "code": "C002",
  "value": {
    "name": "咖啡",  // 其他說明
    "isOther": true
  }
}

外部串接

如果單選清單的內容是來自 外部串接,則請先自行從外部資料來源取得選項的清單,其結構如下:

{
  "items": [ // 選項清單
    { 
      "key": "",
      "value": ""
    }
  ],
  "Selected": { // 選擇項目
      "key": "",
      "value": ""
    }
}
items 為選項清單,key 必須是選項中唯一不重複的值,value 是畫面上使用者看到的文字 Selected 為選擇的項目

範例:

{ // 單選清單-外部串接
  "code": "C002",
  "value": {
    "items": [ // 選項清單
      {
        "key": "i01",
        "value": "可樂"
      },
      {
        "key": "i02",
        "value": "紅茶"
      },
      {
        "key": "i03",
        "value": "綠茶"
      }
    ],
    "selected": {  // 選擇項目
        "key": "i01",
        "value": "可樂"
      }
  }
}

複選清單

複選清單與單選清單類似,只在於其為陣列類型

假設複選清單有下列選項: 可樂、紅茶、綠茶、其他

並且有開啟 擴充文字 設定

選擇 可樂,並在擴充文字寫 去冰,並選擇 其他,並在文字欄位寫 咖啡

{ // 複選清單
  "code": "C002",
  "value": [
    { 
      "name": "可樂", // 選項
      "fillText": "去冰" // 擴充文字
    },
    {
      "name": "咖啡", // 其他說明
      "isOther": true
    }
  ]
}

外部串接

如果複選清單的內容是來自 外部串接,則請先自行從外部資料來源取得選項的清單,其結構如下:

{
  "items": [  // 選項清單
    { 
      "key": "",
      "value": ""
    }
  ],
  "selected": [ // 選擇項目
    {
      "key": "",
      "value": ""
    }
  ]
}
items 為選項清單,key 必須是選項中唯一不重複的值,value 是畫面上使用者看到的文字 Selected 為選擇的項目

範例:

{ // 複選清單-外部串接
  "code": "C002",
  "value": {
    "items": [ // 選項清單
      {
        "key": "i01",
        "value": "可樂"
      },
      {
        "key": "i02",
        "value": "紅茶"
      },
      {
        "key": "i03",
        "value": "綠茶"
      }
    ],
    "selected": [ // 選擇項目
      {
        "key": "i01",
        "value": "可樂"
      },
      {
        "key": "i02",
        "value": "紅茶"
      }
    ]
  }
}

下拉選單

假設下拉選單有下列選項: 可樂、紅茶、綠茶

則選擇可樂時如下

{ // 下拉選單
  "code": "C002", 
  "value": "可樂" // 選擇項目
}

外部串接

如果下拉選單的內容是來自 外部串接,則請先自行從外部資料來源取得選項的清單,其結構如下:

{
  "items": [ // 選項清單
    { 
      "key": "",
      "value": ""
    }
  ],
  "Selected": { // 選擇項目
      "key": "",
      "value": ""
    }
}
items 為選項清單,key 必須是選項中唯一不重複的值,value 是畫面上使用者看到的文字 Selected 為選擇的項目

範例:

{ // 單選清單-外部串接
  "code": "C002",
  "value": {
    "items": [ // 選項清單
      {
        "key": "i01",
        "value": "可樂"
      },
      {
        "key": "i02",
        "value": "紅茶"
      },
      {
        "key": "i03",
        "value": "綠茶"
      }
    ],
    "selected": {  // 選擇項目
        "key": "i01",
        "value": "可樂"
      }
  }
}

文字編輯

範例:

{ // 文字編輯
  "code": "C002",
  "value": "文字編輯欄位內容"
}

上傳檔案

上傳檔案欄位使用前,應該先透過 上傳檔案 API 上傳,並取得 檔案ID 後才能使用

範例:

{ // 上傳檔案
  "code": "C002",
  "value": [
    {
      "id": "123456", // 檔案ID,透過上傳檔案 API 取得
      "fileName": "測試檔案.pdf"  // 檔案名稱
    }
  ]
}

文件檢視器

文件檢視器欄位使用前,應該先透過 上傳檔案 API 上傳,並取得 檔案ID 後才能使用。

僅支援 pdf 檔案類型

範例:

{ // 文件檢視器
  "code": "C002",
  "value": [
    {
      "id": "123456", // 檔案ID,透過上傳檔案 API 取得
      "fileName": "測試檔案.pdf"  // 檔案名稱
    }
  ]
}