kintone API文件

欄位格式

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

欄位資訊

連結已複製

在應用中使用kintone JavaScript API或kintone REST API操作記錄資訊時，需要根據欄位的格式獲取或設置欄位的值。
有兩種方法可以指定欄位：

  • 方法1：指定欄位名稱。
    下一個欄位指定欄位名稱。
    • 類別
    • 狀態
    • 執行者
  • 方法 2：指定欄位代碼。
    對於方法 1 中列出的欄位以外的欄位，請指定欄位代碼。
    您可以在應用程式的表單設置中找到欄位代碼。
    設置欄位代碼的步驟 (External link)

記錄ID和記錄號碼

連結已複製

記錄ID是自動分配給記錄的數值，不會與其他記錄重複。
如果要在 API 中指定特定記錄，請使用記錄 ID。

記錄號碼是自動分配給記錄的編號，不會與其他記錄重複。
根據是否設置了應用代碼，值的格式會有所不同。

  • 如果您尚未設置應用代碼：與記錄ID相同。
  • 如果您已設置應用代碼：這是應用代碼和記錄 ID 的組合。
    例如，如果將應用代碼設置為「APPCODE」，則記錄ID為1的記錄的記錄編號為「APPCODE-1」。

修飾表單的欄位

連結已複製

以下欄位是修飾表單的欄位。
您無法獲取、添加或更新該值。

  • 標籤
  • 空白欄
  • 分隔線
  • 群組

如果要獲取或變更表單的設置資訊，請使用以下 API。

相關記錄清單

連結已複製

您無法獲取、添加或更新相關記錄清單欄位的值。

要操作表單的設置資訊，請使用以下 API。

數值欄位

連結已複製

在kintone JavaScript API中，可以在數值欄位中獲取或重寫的值如下。

  • 數值
    • 符號可使用「+」或「-」作為。
    • 小數點分隔符中「.」可以使用
    • 可使用指數標記。指數的符號可使用「e」或「E」。
  • 空字元

數值或符號只能使用半型字串。

此外，如果使用API 或事件對象在記錄中設置值kintone.app.record.set()` 以重寫欄位的值，則可以對數值欄位使用以下值：

  • undefined null
    如果指定這些值，則數值欄位的值將為空。
  • #INVALID!
    如果指定此值，則不會重寫數值欄位的值。

不滿足上述條件的值將被視為無效。

有關kintone.app.record.set()的說明，請參閱以下頁面。
給記錄設置值

欄位格式

連結已複製

選取值時

連結已複製

欄位代碼 替換為應用的欄位代碼。

記錄資訊欄位
欄位類型 type 價值示例 備考
記錄號碼 RECORD_NUMBER 如果您尚未設置應用代碼
"欄位代碼": {
  "type": "RECORD_NUMBER",
  "value": "1"
}
在應用代碼中指定「APPCODE」時
"欄位代碼": {
  "type": "RECORD_NUMBER",
  "value": "APPCODE-1"
}
記錄ID __ID__ 
"$id": {
  "type": "__ID__",
  "value": "1"
}
校訂 __REVISION__ 
"$revision": {
  "type": "__REVISION__",
  "value": "5"
}
建立人 CREATOR 如果您是常規使用者
"欄位代碼": {
  "type": "CREATOR",
  "value": {
    "code": "sato",
    "name": "Noboru Sato"
  }
}
訪客身分驗證
"欄位代碼": {
  "type": "CREATOR",
  "value": {
    "code": "guest/sato@example.com",
    "name": "Noboru Sato"
  }
}
建立時間 CREATED_TIME 
"欄位代碼": {
  "type": "CREATED_TIME",
  "value": "2012-01-11T11:30:00Z"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
更新人 MODIFIER 如果您是常規使用者
"欄位代碼": {
  "type": "MODIFIER",
  "value": {
    "code": "sato",
    "name": "Noboru Sato"
  }
}
訪客身分驗證
"欄位代碼": {
  "type": "MODIFIER",
  "value": {
    "code": "guest/sato@example.com",
    "name": "Noboru Sato"
  }
}
更新時間 UPDATED_TIME 
"欄位代碼": {
  "type": "UPDATED_TIME",
  "value": "2012-01-11T11:30:00Z"
}
自訂欄位
欄位類型 type 價值示例 備考
單行文字方塊 SINGLE_LINE_TEXT 
"欄位代碼": {
  "type": "SINGLE_LINE_TEXT",
  "value": "測試。 "
}
多行文字方塊 MULTI_LINE_TEXT 
"欄位代碼": {
  "type": "MULTI_LINE_TEXT",
  "value": "測試\n。 "
}
文字編輯方塊 RICH_TEXT 
"欄位代碼": {
  "type": "RICH_TEXT",
  "value": "<a href=\"http://www.example.com\">sample</a>"
}
數值 NUMBER 
"欄位代碼": {
  "type": "NUMBER",
  "value": "123"
}
 kintone JavaScript API中可用於數值欄位的值，請參考數值欄位。
數值欄位
計算 CALC 
"欄位代碼": {
  "type": "CALC",
  "value": "123"
}
 的格式取決於 value 顯示格式設置。
  • 數值：「1234」
  • 數值（以逗號分隔）：「1234」
  • 日期與時間：「2012-01-11T11:30:00Z」
  • 日期「2012-01-11」
  • 時間：「11:30」
  • 時間（小時/分鐘）：「49:30」（屏幕上顯示「49小時30分鐘」）
  • 時間（天小時分）「49:30」（屏幕上顯示「2天1小時30分鐘」）
核取方塊 CHECK_BOX 
"欄位代碼": {
  "type": "CHECK_BOX",
  "value": [
 "選項 1",
 "選項 2"
 ]
}
選項按鈕 RADIO_BUTTON 
"欄位代碼": {
  "type": "RADIO_BUTTON",
  "value": "選項
}
複選 MULTI_SELECT 
"欄位代碼": {
  "type": "MULTI_SELECT",
  "value": [
 "選項 1",
 "選項 2"
 ]
}
下拉式選單 DROP_DOWN 
"欄位代碼": {
  "type": "DROP_DOWN",
  "value": "選項
}
選擇使用者 USER_SELECT 如果您是常規使用者
"欄位代碼": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "sato",
     "name": "Noboru Sato"
    },
   {
      "code": "kato",
     "name": "Misaki Kato"
    }
  ]
}
訪客身分驗證
"欄位代碼": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "guest/sato@example.com",
      "name": "Noboru Sato"
    },
    {
      "code": "guest/kato@example.com",
      "name": "Misaki Kato"
    }
  ]
}
選擇組織 ORGANIZATION_SELECT 
"欄位代碼": {
  "type": "ORGANIZATION_SELECT",
  "value": [
    {
      "code": "kaihatsu",
      "name": "開發部"
 }，
 {
 "code": "jinji",
      "name": "人事部"
    }
  ]
}
選擇群組 GROUP_SELECT 
"欄位代碼": {
  "type": "GROUP_SELECT",
  "value": [
    {
      "code": "project_manager",
      "name": "項目經理 "
 }，
 {
 "code": "team_leader",
      "name": "組長"
}
 ]
}
日期 DATE 
"欄位代碼": {
  "type": "DATE",
  "value": "2012-01-11"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
時間 TIME 
"欄位代碼": {
  "type": "TIME",
  "value": "11:30"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
日期與時間 DATETIME 
"欄位代碼": {
  "type": "DATETIME",
  "value": "2012-01-11T11:30:00Z"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
連結 LINK 
"欄位代碼": {
  "type": "LINK",
  "value": "http://www.example.com/"
}
附件 FILE 
"欄位代碼": {
  "type": "FILE",
  "value": [
    {
      "contentType": "text/plain",
      "fileKey":"201202061155587E339F9067544F1A92C743460E3D12B3297",
      "name": "17to20_VerupLog （1）.txt",
      "size": "23175"
    },
    {
      "contentType": "text/plain",
      "fileKey": "201202061155583C763E30196F419E83E91D2E4A03746C273",
      "name": "17to20_VerupLog.txt",
      "size": "23175"
    }
  ]
}
 獲取時回應中包含的檔案鍵僅可用於檔案下載。
Lookup SINGLE_LINE_TEXT
NUMBER *1 		如果鍵欄位為 SINGLE_LINE_TEXT
"欄位代碼": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Code001"
}
如果鍵欄位為 NUMBER
"欄位代碼": {
  "type": "NUMBER",
  "value": "10"
}
表格 SUBTABLE 
"欄位代碼": {
  "type": "SUBTABLE",
  "value": [
    {
      "id": "48290",
      "value": {
        "單行文字方塊_0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "樣品 1"
        },
        "數值_0": {
          "type": "NUMBER",
          "value": "1"
        },
        "核取方塊_0": {
          "type": "CHECK_BOX",
          "value": ["選項1"]
        }
      }
    },
    {
      "id": "48291",
      "value": {
        "字串_0" : {
          "type": "SINGLE_LINE_TEXT",
          "value": "樣品 2"
        },
        "數值_0": {
          "type": "NUMBER",
          "value": "2"
        },
        "核取方塊_0": {
          "type": "CHECK_BOX",
          "value": ["選項2"]
        }
      }
    }
  ]
}
相關記錄清單 REFERENCE_TABLE
 無法獲取該值。
類別 CATEGORY 
"類別" : {
  "type": "CATEGORY",
  "value": [
    "category1",
    "category2"
  ]
}
狀態 STATUS 
"狀態": {
  "type": "STATUS",
  "value": "未處理"
}
執行者 STATUS_ASSIGNEE 
"執行者" : {
  "type": "STATUS_ASSIGNEE",
  "value": [
    {
      "code": "sato",
      "name": "Noboru Sato"
    }
  ]
}
標籤 LABEL 無法獲取該值。
空白欄 SPACER 無法獲取該值。
分隔線 HR 無法獲取該值。
群組 GROUP 無法獲取該值。

*1 這取決於鍵欄位的欄位類型。 ^

添加或更新值時

連結已複製

欄位代碼 替換為應用的欄位代碼。

記錄資訊欄位
欄位類型 type 價值示例 備考
記錄號碼 RECORD_NUMBER 無 您無法添加或更新該值。
記錄ID __ID__ 無 您無法添加或更新該值。
校訂 __REVISION__ 無 您無法添加或更新該值。
建立人 CREATOR 如果您是常規使用者
"欄位代碼": {
  "value": {
    "code": "sato"
  }
}
訪客身分驗證
"欄位代碼": {
  "value": {
    "code": "guest/sato@example.com"
  }
}
 無法更新該值。
建立時間 CREATED_TIME 
"欄位代碼": {
  "value": "2012-01-11T11:30:00Z"
}
 不能指定將來的日期。
無法更新該值。
有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
更新人 MODIFIER 如果您是常規使用者
"欄位代碼": {
  "value": {
    "code": "sato"
  }
}
訪客身分驗證
"欄位代碼": {
  "value": {
    "code": "guest/sato@example.com"
  }
}
 無法更新該值。
更新時間 UPDATED_TIME 
"欄位代碼": {
  "value": "2012-01-11T11:30:00Z"
}
 無法更新該值。
有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
自訂欄位
欄位類型 type 價值示例 備考
單行文字方塊 SINGLE_LINE_TEXT 
"欄位代碼": {
  "value": "測試。 "
}
多行文字方塊 MULTI_LINE_TEXT 
"欄位代碼": {
  "value": "測試\n。 "
}
文字編輯方塊 RICH_TEXT 
"欄位代碼": {
  "value": "<a href=\"http://www.example.com\">sample</a>"
}
數值 NUMBER 
"欄位代碼": {
  "value": "123"
}
 kintone JavaScript API中可用於數值欄位的值，請參考數值欄位。
數值欄位
計算 CALC 
"欄位代碼": {
  "value": "123"
}
 您無法添加或更新該值。
核取方塊 *1 CHECK_BOX 
"欄位代碼": {
  "value": [
 "選項 1",
 "選項 2"
 ]
}
選項按鈕 *1 RADIO_BUTTON 
"欄位代碼": {
  "value": "選項
}
 如果指定了空字串，則設置初始值。
複選 *1 MULTI_SELECT 
"欄位代碼": {
  "value": [
 "選項 1",
 "選項 2"
 ]
}
下拉式選單 *1 DROP_DOWN 
"欄位代碼": {
  "value": "選項
}
選擇使用者 USER_SELECT 如果您是常規使用者
"欄位代碼": {
  "value": [
   { "code": "sato" },
   { "code": "kato" }
  ]
}
訪客身分驗證
"欄位代碼": {
  "value": [
    { "code": "guest/sato@example.com" },
    { "code": "guest/kato@example.com" }
  ]
}
選擇組織 ORGANIZATION_SELECT 
"欄位代碼": {
  "value": [
    { "code": "kaihatsu" },
    { "code": "jinji" }
  ]
}
選擇群組 GROUP_SELECT 
"欄位代碼": {
  "value": [
    { "code": "project_manager" },
    { "code": "team_leader" }
  ]
}
日期 DATE 
"欄位代碼": {
  "value": "2012-01-11"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
時間 TIME 
"欄位代碼": {
  "value": "11:30"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
日期與時間 DATETIME 
"欄位代碼": {
  "value": "2012-01-11T11:30:00Z"
}
 有關格式和時區的更多資訊，請參閱以下頁面。
日期和時間格式
連結 LINK 
"欄位代碼": {
  "value": "http://www.example.com/"
}
附件 FILE 
"欄位代碼": {
  "value": [
    {
      "fileKey":"84a0e9be-c687-4ae6-82be-3b7edab82c21",
    },
    {
      "fileKey": "722258d8-55e7-41ed-8208-adf3bd034e50",
    }
  ]
}
Lookup SINGLE_LINE_TEXT
NUMBER *2 
"欄位代碼": {
  "value": "Code001"
}
 添加或更新時，請確保關聯的應用程式中的複製來源欄位值為唯一。
表格 SUBTABLE 
"欄位代碼": {
  "value": [
    {
      "id": "48290",
      "value": {
        "單行文字方塊_0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "樣品 1"
        },
        "數值_0": {
          "type": "NUMBER",
          "value": "1"
        },
        "核取方塊_0": {
          "type": "CHECK_BOX",
          "value": ["選項1"]
        }
      }
    },
    {
      "id": "48291",
      "value": {
        "字串_0" : {
          "type": "SINGLE_LINE_TEXT",
          "value": "樣品 2"
        },
        "數值_0": {
          "type": "NUMBER",
          "value": "2"
        },
        "核取方塊_0": {
          "type": "CHECK_BOX",
          "value": ["選項2"]
        }
      }
    }
  ]
}
 不要向單個表添加大量行。
根據應用的配置方式，有可能會給伺服器帶來很大負荷，並且會影響記錄的處理，例如查看記錄或使用 REST API 與記錄交互。
有關使用 REST 和 JavaScript API 處理表時的注意事項，請參閱：
使用表格時的注意事項
相關記錄清單 REFERENCE_TABLE 您無法添加或更新該值。
類別 CATEGORY 您無法添加或更新該值。
狀態 STATUS 您無法添加或更新該值。
執行者 STATUS_ASSIGNEE 您無法添加或更新該值。
標籤 LABEL 您無法添加或更新該值。
空白欄 SPACER 您無法添加或更新該值。
分隔線 HR 您無法添加或更新該值。
群組 GROUP 您無法添加或更新該值。

*1 value在kintone應用程式的表單設置中指定「專案和訂單」中設置的值。
您還可以在 API 中指定已刪除的選項項。 ^

*2 這取決於鍵欄位的欄位類型。 ^

使用表格時的注意事項
通過 JavaScript API 添加和更新
  • 添加或更新表時，請指定所有現有行的值。
  • 行的順序是請求數據的順序。
  • 在表中添加或更新時，需要指定欄位類型。
    有關說明，請參閱以下頁面。
    重寫欄位的值
使用 REST API 添加和更新
  • 添加或更新表時，請指定所有現有行的值。
  • 如果指定行的id，則更新指定行的值。
  • 行的順序是請求數據的順序。
  • 如果只想對行進行排序，準備的請求數據只需要更改行的 id 。
添加或刪除行時

您可以通過在表的「value」參數中的值陣列中新增或刪除行物件來在表中添加或刪除行。

以下代碼是在push() 中添加一行的範例。

1

record['表格']['value'].push(row);

以下代碼是pop() 中刪除行的範例。

1

record['表格']['value'].pop();

如果欄位的值為空

連結已複製

如果獲取空欄位的值，則該欄位的值如下所示：

欄位類型 價值示例
  • 單行文字方塊
  • 多行文字方塊
  • 數值
  • 日期與時間
  • 連結
  • Lookup
 
"value": ""
在新增記錄畫面或編輯記錄畫面上使用 JavaScript API 時
"value": undefined
  • 文字編輯方塊
 
"value": ""
  • 日期
  • 時間
 
"value": null
在新增記錄畫面或編輯記錄畫面上使用 JavaScript API 時
"value": undefined
  • 下拉式選單
 
"value": ""
使用 REST API
"value": null
在新增記錄畫面或編輯記錄畫面上使用 JavaScript API 時
"value": undefined
  • 選項按鈕
 使用 REST API
"value": null
使用 JavaScript API
"value": ""
  • 核取方塊
  • 複選
  • 選擇使用者
  • 選擇組織
  • 選擇群組
  • 附件
  • 表格
  • 類別
  • 執行者
 
"value": []

如果要將欄位的值設置為空

連結已複製

如果要將欄位設定為空值，請按如下方式設定該欄位的值：

欄位類型 價值示例
  • 單行文字方塊
  • 多行文字方塊
  • 文字編輯方塊
  • 下拉式選單
  • 日期與時間
  • 連結
  • Lookup
 
"value": ""
或
"value": null
  • 數值
 指定以下值之一：
"value": ""
"value": undefined
"value": null
  • 日期
  • 時間
 
"value": null
  • 核取方塊
  • 複選
  • 選擇使用者
  • 選擇組織
  • 選擇群組
  • 附件
  • 表格
 
"value": []
  • 選項按鈕
  • 類別
  • 執行者
 無