新增欄位
向表單新增欄位。
此 API 可變更測試環境中的應用。
如果要將變更套用到正式環境,請在執行該API之後,執行將應用設置反映到正式環境的API。
將應用設置傳播到正式環境API
URL
- 常規應用程式
- https://sample.cybozu.com/k/v1/preview/app/form/fields.json
- 訪客空間的應用程式
- https://sample.cybozu.com/k/guest/
SPACE_ID
/v1/preview/app/form/fields.json
HTTP 方法
POST
所需存取權限
- 應用程式管理權限
請求
參數
參數名稱 | 類型 | 必須 | 說明 |
---|---|---|---|
app | 數值或字串 | 必須 | 應用ID |
properties | 物件 | 必須 | 欄位的設定 |
properties.欄位代碼 |
物件 | 必須 | 每個欄位的設定欄位代碼 指定要添加的欄位的網域代碼。有關可在域代碼中使用的字元,請參閱可在域代碼中使用的字元。 可以在域代碼中使用的字元 |
properties.欄位代碼 .type |
字串 | 必須 | 欄位類型
|
properties.欄位代碼 .code |
字串 | 必須 | 欄位代碼 指定與 欄位代碼 相同的值。 |
properties.欄位代碼 .label |
字串 | 條件必填項 | 欄位名稱 表格不需要指定此參數。 |
properties.欄位代碼 .noLabel |
布爾值或字串 | 可省略 | 是否隱藏欄位名稱
|
properties.欄位代碼 .required |
布爾值或字串 | 可省略 | 是否強制性的嗎
|
properties.欄位代碼 .unique |
布爾值或字串 | 可省略 | 是否禁止重複
|
properties.欄位代碼 .maxValue |
數值或字串 | 可省略 | 最大值 |
properties.欄位代碼 .minValue |
數值或字串 | 可省略 | 最小值 |
properties.欄位代碼 .maxLength |
數值或字串 | 可省略 | 最大字元數 |
properties.欄位代碼 .minLength |
數值或字串 | 可省略 | 最小字元數 |
properties.欄位代碼 .defaultValue |
字串或陣列 | 可省略 | 預設值 對於可以具有多個初始值的欄位,請以數組形式指定它們。 如果指定了 defaultNowValue ,則設置defaultNowValue 的值。對於選擇使用者/選擇群組/選擇組織欄位,以物件格式指定,物件中包含鍵為 code 和type 的屬性 . |
properties.欄位代碼 .defaultValue[].type |
字串 | 部分條件下必須 | 選擇使用者/選擇群組/選擇組織欄位的初始值類型 如果指定了 defaultValue ,則為必填項。
|
properties.欄位代碼 .defaultValue[].code |
字串 | 部分條件下必須 | 選擇使用者/選擇群組/選擇組織欄位的初始值代碼 如果指定了 defaultValue ,則為必填項。
|
properties.欄位代碼 .defaultNowValue |
布爾值或字串 | 可省略 | 是否將記錄建立時的日期和時間設置為初始值
|
properties.欄位代碼 .options |
物件 | 條件必填項 | 選項的設定 對於允許您指定選項的欄位(如選項按鈕)是必需的。 |
properties.欄位代碼 .options.選項名稱 |
物件 | 條件必填項 | 每個選項的設置選項名稱 是要添加的選擇項的。如果 options 指定,則為必填項。 |
properties.欄位代碼 .options.選項名稱 .label |
字串 | 條件必填項 | 選項名稱 指定與 選項名稱 相同的值。如果 options 指定,則為必填項。 |
properties.欄位代碼 .options.選項名稱 .index |
數值或字串 | 部分條件下必須 | 選擇順序 指定一個數值。選項按指定的數值的升序排列。 如果 options 指定,則為必填項。 |
properties.欄位代碼 .align |
字串 | 可省略 | 選項的排列方式
|
properties.欄位代碼 .expression |
字串 | 條件必填項 | 自動計算 對於計算欄位是必需的。 |
properties.欄位代碼 .hideExpression |
布爾值或字串 | 可省略 | 是否隱藏計算欄位中的計算公式
|
properties.欄位代碼 .digit |
布爾值或字串 | 可省略 | 是否顯示數位千分位分隔符
|
properties.欄位代碼 .thumbnailSize |
數值或字串 | 可省略 | 縮圖大小(以像素為單位 ) 指定以下值之一:
|
properties.欄位代碼 .protocol |
字串 | 條件必填項 | 連結類型 在連結欄位中,它是必需的。
|
properties.欄位代碼 .format |
字串 | 可省略 | 計算欄位的顯示格式
|
properties.欄位代碼 .displayScale |
數值或字串 | 可省略 | 小數點後的顯示位數 |
properties.欄位代碼 .unit |
字串 | 可省略 | 單位符號 |
properties.欄位代碼 .unitPosition |
字串 | 可省略 | 單位符號的顯示位置
|
properties.欄位代碼 .entities |
陣列 | 可省略 | 選擇使用者/選擇組織/選擇群組欄位的選項 |
properties.欄位代碼 .entities[].type |
字串 | 部分條件下必須 | 選項類型 如果 entities 指定,則為必填項。
|
properties.欄位代碼 .entities[].code |
字串 | 部分條件下必須 | 選項的代碼 如果 entities 指定,則為必填項。
|
properties.欄位代碼 .referenceTable |
物件 | 條件必填項 | 配置相關記錄欄位 如果要添加相關記錄清單字段,則為必填項。 |
properties.欄位代碼 .referenceTable.relatedApp |
物件 | 條件必填項 | 「要參照的應用程式」設置 如果 referenceTable 指定,則為必填項。 |
properties.欄位代碼 .referenceTable.relatedApp.app |
數值或字串 | 部分條件下必須 | 要在「要參照的應用程式」中指定的應用的應用ID 如果指定了 referenceTable ,則需要app 或code 。如果兩者都指定,將設置 code 的值。 |
properties.欄位代碼 .referenceTable.relatedApp.code |
字串 | 部分條件下必須 | 要在「要參照的應用程式」中指定的應用代碼 如果指定了 referenceTable ,則需要app 或code 。如果兩者都指定,將設置 code 的值。 |
properties.欄位代碼 .referenceTable.condition |
物件 | 條件必填項 | 「要顯示的記錄條件」的設定 如果 referenceTable 指定,則為必填項。 |
properties.欄位代碼 .referenceTable.condition.field |
字串 | 條件必填項 | 與「要顯示的記錄條件」中指定的相關記錄清單欄位相同的應用程式字段代碼 如果 referenceTable 指定,則為必填項。 |
properties.欄位代碼 .referenceTable.condition.relatedField |
字串 | 條件必填項 | 「要顯示的記錄條件」中指定的「相關記錄清單」欄位所引用的應用程式的字段代碼 如果 referenceTable 指定,則為必填項。 |
properties.欄位代碼 .referenceTable.fliterCond |
字串 | 可省略 | 「更多篩選條件」的設定 以查詢格式指定。有關查詢格式的詳細資訊,請參閱以下頁面。 如何編寫查詢 |
properties.欄位代碼 .referenceTable.displayFields |
陣列 | 條件必填項 | 在「要顯示的欄位」中指定的欄位的欄位代碼清單 如果 referenceTable 指定,則為必填項。 |
properties.欄位代碼 .referenceTable.sort |
字串 | 可省略 | 記錄排序的設置 以查詢格式指定。有關查詢格式的詳細資訊,請參閱以下頁面。 如何編寫查詢 |
properties.欄位代碼 .referenceTable.size |
數值或字串 | 可省略 | 一次最多顯示記錄數 指定以下值之一:
|
properties.欄位代碼 .lookup |
物件 | 可省略 | Lookup欄位的設定 如果要新增Lookup欄位,則為必填項。 |
properties.欄位代碼 .lookup.relatedApp |
物件 | 條件必填項 | 「要連結的應用程式」的設定 如果 lookup 指定,則為必填項。 |
properties.欄位代碼 .lookup.relatedApp.app |
數值或字串 | 部分條件下必須 | 要連結的應用程式的應用ID 如果指定了 lookup ,應用程式或代碼是必需的。如果兩者都指定,將設置 code 的值。 |
properties.欄位代碼 .lookup.relatedApp.code |
字串 | 條件必填項 | 要要連結的應用程式代碼 如果指定了 lookup ,應用程式或代碼是必需的。如果兩者都指定,將設置 code 的值。 |
properties.欄位代碼 .lookup.relatedKeyField |
字串 | 條件必填項 | 在「要複製的欄位」中指定的欄位代碼 如果 lookup 指定,則為必填項。 |
properties.欄位代碼 .lookup.fieldMappings |
陣列 | 可省略 | 「複製其他欄位」的設定清單 |
properties.欄位代碼 .lookup.fieldMappings[].field |
字串 | 條件必填項 | 要指定為「複製其他欄位」的複製目標的域代碼 如果 lookup.fieldMappings 指定,則為必填項。 |
properties.欄位代碼 .lookup.fieldMappings[].relatedField |
字串 | 條件必填項 | 指定要指定為「複製其他欄位」的複製源的網域代碼。 如果指定了 lookup.fieldMappings ,則為必填項。 |
properties.欄位代碼 .lookup.lookupPickerFields |
陣列 | 可省略 | 「要顯示在選取清單中的欄位」的設定清單 指定欄位代碼的陣列。 |
properties.欄位代碼 .lookup.filterCond |
字串 | 可省略 | 篩選的初始設定 以查詢格式指定。有關查詢格式的詳細資訊,請參閱以下頁面。 如何編寫查詢 |
properties.欄位代碼 .lookup.sort |
字串 | 可省略 | 排序的初始設定 以查詢格式指定。有關查詢格式的詳細資訊,請參閱以下頁面。 如何編寫查詢 |
properties.欄位代碼 .openGroup |
布爾值或字串 | 可省略 | 是否顯示群組內的欄位
|
properties.欄位代碼 .fields |
物件 | 可省略 | 表格中的欄位 物件的結構與 properties 相同。如果要添加表,則為必填項。 |
revision | 數值或字串 | 可省略 | 預期修訂號 如果它與實際修訂號不匹配,則會發生錯誤,並且不會添加該欄位。 如果指定值「-1」或未指定值,則不會驗證修訂號。 |
請求範例
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
內文
|
|
回應
屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
revision | 字串 | 變更應用設置后的修訂號 |
應答範例
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|
限制
無法新增以下欄位:
- 狀態
- 執行者
- 類別