選擇欄位
向表單添加欄位。
此 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.欄位代碼 |
物件 | 必須 | 每個欄位的設置欄位代碼 指定要添加的欄位的網域代碼。有關域代碼中可使用的字元的詳細資訊,請參閱 kintone説明 。 |
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 |
數位或字串 | 條件必填項 | 要在「引用的應用」中指定的應用的應用IDreferenceTable 如果指定 或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欄位 如果要添加查找欄位,則為必填項。 |
properties.欄位代碼 .lookup.relatedApp |
物件 | 條件必填項 | "要關聯的應用"的設置lookup 如果指定,則為必填項。 |
properties.欄位代碼 .lookup.relatedApp.app |
數位或字串 | 條件必填項 | 要關聯的應用的應用IDlookup 、應用程式或代碼是必需的。如果兩者都指定 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 REST API請求 使用API 發送請求
|
|
限制
無法新增以下欄位:
- 狀態
- 執行者
- 類別