更改表单的设置

aki发表于:2016年12月27日 17:21:58更新于:2017年08月04日 16:49:03

更改应用的表单的设置。
更改表单的设置时,根据操作的不同,要使用的API也不一样。

添加字段

在表单中添加字段。

URI

https://(子域名).cybozu.cn/k/v1/preview/app/form/fields.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/form/fields.json

HTTP 方法

POST

访问权限

  • 需要有应用的管理权限。

  • 不可使用API令牌来执行该API。

请求

参数

参数名称要指定的值必须说明
app整 数必须指定应用的ID。
properties对象必须字段设置的对象。
properties. (字段代码).align字符串
指定选项的排序。
  • 横向(初始设置):HORIZONTAL

  • 纵向:VERTICAL

properties. (字段代码).code字符串
指定字段代码。
关于可使用的字符的限制,请参照kintone帮助
properties. (字段代码).defaultNowValue字符串
设置是否将添加记录时的日期与时间设为初始值。
  • 将添加记录时的日期与时间作为初始值:true

  • 不将添加记录时的日期与时间作为初始值(初始设置):false

properties. (字段代码).defaultValue字符串或数组
指定初始值。可设置多个初始值的字段,以数组的形式指定。
指定“defaultNowValue”参数时,“defaultNowValue”参数优先。
properties. (字段代码).digit布尔值
设置是否显示数值的千位分隔符。
  • 显示时:true

  • 不显示时(初始值):false

properties. (字段代码).displayScale整 数
指定小数点以下的显示位数。
properties. (字段代码).entities数组
对用户选择字段指定要作为选项的用户。
properties. (字段代码).entities[].code字符串必须可选择任意一个选项。
  • 用户的登录名

  • 组的代码

  • 组织的代码

  • 函数名

函数名只可指定用于指定登录用户的函数“LOGINUSER()”。来宾空间内的应用,只能指定用户或组。
properties. (字段代码).entities[].type字符串必须指定值的种类。
  • 用户时:USER

  • 组时:GROUP

  • 组织时:ORGANIZATION

  • 函数:FUNCTION

properties. (字段代码).expression字符串
指定自动计算公式。计算字段必须指定此参数。
properties. (字段代码).fields对象
指定表格内的字段。参数和“properties”参数一样。设置表格时,此参数必须指定。
properties. (字段代码).format字符串
指定计算字段的显示格式。
  • 数值(例:1000):NUMBER(初始设置)

  • 数值(例:1,000):NUMBER_DIGIT

  • 日期与时间(例:2012-08-06 2:03):DATETIME

  • 日期(例:2012-08-06):DATE

  • 时间(例:2:03):TIME

  • 小时分(例:26小时3分):HOUR_MINUTE

  • 天小时分(例:1天2小时3 分):DAY_HOUR_MINUTE

properties. (字段代码).hideExpression布尔值
设置是否隐藏计算字段的计算公式。
  • 隐藏:true

  • 显示(初始值):false

properties. (字段代码).label字符串必须指定字段名称。表格中,不需要指定此参数。
properties. (字段代码).lookup对象
用于存放lookup字段的设置的对象。lookup字段中,此参数必须指定。指定为null时,不更新设置。
properties. (字段代码).lookup.fieldMappings数组
用于存放“其他要复制的字段”的设置的数组。
properties. (字段代码).lookup.fieldMappings[].field字符串必须“其他要复制的字段”的复制到的字段中指定的字段的代码。
properties. (字段代码).lookup.fieldMappings[].relatedField字符串必须“其他要复制的字段”的复制来源的字段中指定的字段的代码。
properties. (字段代码).lookup.filterCond字符串必须筛选的初始设置用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).lookup.lookupPickerFields数组
通过字段代码的数组指定“要在搜选列表中显示的字段”。
properties. (字段代码).lookup.relatedApp对象必须用于存放“要关联的应用”的设置的对象。
properties. (字段代码).lookup.relatedApp.app整 数
指定要关联的应用的ID。指定了“properties.(字段代码).lookup.relatedApp.code”参数时,优先该参数。
properties. (字段代码).lookup.relatedApp.code字符串
指定要关联的应用的代码。
properties. (字段代码).lookup.relatedKeyField字符串必须指定“复制来源字段”中指定的字段的代码。
properties. (字段代码).lookup.sort字符串必须排序的初始设置。用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).maxLength整 数
指定最多字符数。
properties. (字段代码).maxValue整 数
指定最大值。
properties. (字段代码).minLength整 数
指定最少字符数。
properties. (字段代码).minValue整 数
指定最小值。
properties. (字段代码).noLabel布尔值
指定是否隐藏字段名称
  • 隐藏:true

  • 显示(初始值):false

properties. (字段代码).openGroup布尔值
设置是否显示组合内字段。
  • 显示时:true

  • 隐藏(初始设置):false

properties. (字段代码).options对象
用于存放选项设置的对象。类似于单选框这种可指定选项的字段,必须指定此参数。
properties. (字段代码).options.(选项名).index整 数必须用数字指定选项的顺序。选项根据所指定的数字来升序排列。
properties. (字段代码).options.(选项名).label字符串必须指定选项名称。
properties. (字段代码).protocol字符串
指定链接的种类。链接的字段中,此参数必须指定。
  • Web网站地址:WEB

  • 电话号码:CALL

  • 邮件地址:MAIL

properties. (字段代码).referenceTable对象
用于存放关联记录列表字段的设置的对象。关联记录列表字段中,此参数必须指定。指定为null时,不更新设置。
properties. (字段代码).referenceTable.condition对象必须用于存放“设置要显示的记录“中的设置的对象。
properties. (字段代码).referenceTable.condition.field字符串必须“设置要显示的记录“中指定的、与关联记录列表字段同一应用的字段的代码。
properties. (字段代码).referenceTable.condition.relatedField字符串必须在"设置要显示的记录“中指定的、关联记录列表字段所参照的应用内的字段的代码。
properties. (字段代码).referenceTable.displayFields数组必须通过字段代码的数组来指定”要显示的字段“中指定的字段。
properties. (字段代码).referenceTable.fliterCond字符串
“更多筛选条件“的设置用查询形式显示。查询形式请参考以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).referenceTable.relatedApp对象必须用于存放”要引用的应用“的设置的对象。
properties. (字段代码).referenceTable.relatedApp.app整 数
“要引用的应用”中指定的应用ID。指定“properties.(字段代码).referenceTable.relatedApp.code”参数时,优先该参数。
properties. (字段代码).referenceTable.relatedApp.code字符串
“要引用的应用“中指定的应用代码。
properties. (字段代码).referenceTable.size整 数
一次最多可显示的记录数可指定5, 10, 20, 30的任意一个,省略参数时,默认5。
properties. (字段代码).referenceTable.sort字符串
设置记录的排序用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).required布尔值
设置是否必填。
  • 必填:true

  • 任意(初始值):false

properties. (字段代码).thumbnailSize整 数
以像素为单位,从50, 150, 250, 500中选择一个作为缩略图的大小。
properties. (字段代码).type字符串必须指定字段的类型。
  • 复选框:CHECK_BOX

  • 表格:SUBTABLE

  • 下拉菜单:DROP_DOWN

  • 选择用户:USER_SELECT

  • 单选框:RADIO_BUTTON

  • 文本编辑框:RICH_TEXT

  • 链接:LINK

  • lookup:SINGLE_LINE_TEXT、または NUMBER *

  • 关联记录列表:REFERENCE_TABLE

  • 计算:CALC

  • 时间:TIME

  • 数值:NUMBER

  • 附件:FILE

  • 日期与时间:DATETIME

  • 日期:DATE

  • 多选:MULTI_SELECT

  • 单行文本框:SINGLE_LINE_TEXT

  • 多行文本框:MULTI_LINE_TEXT

*: 指定要参照的字段的类型。
properties. (字段代码).unique布尔值
设置是否值为唯一。
  • 值为唯一:true

  • 允许重复(初始值):false

properties. (字段代码).unit字符串
指定单位符号。
properties. (字段代码).unitPosition字符串
指定单位符号的显示位置。
  • 放在字段前(初始设置):BEFORE

  • 放在字段后:AFTER

revision整 数
指定应用的设置更改之前的修订号。如指定的修订号不是最新的,请求将报错。
如果省略或指定“-1”,将不对修订号进行验证。

 以下字段不可添加也不可更改。

  • 状态

  • 执行者

  • 类别

请求的范例

头部

POST /k/v1/preview/app/form/fields.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

应答

参数

参数名称值的类型说明
revision字符串应用的设置更改之后的修订号。

应答的范例

更改字段的设置

更改表单中字段的设置。

URI

https://(子域名).cybozu.cn/k/v1/preview/app/form/fields.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/form/fields.json

HTTP 方法

PUT

访问权限

  • 需要有应用的管理权限。

  • 不可使用API令牌来执行该API。

请求

参数

以下是要指定的参数一览。省略参数时,其设置不会被更改。
更改字段代码时,在“(字段代码)”中指定更改前的字段名称。同样,更改选项名称时,“(选项名称)”中指定更改前的选项名称。

参数名称要指定的值必须说明
app整 数必须指定应用的ID。
properties对象必须字段设置的对象。
properties. (字段代码).align字符串
指定选项的排序。
  • 横向(初始设置):HORIZONTAL

  • 纵向:VERTICAL

properties. (字段代码).code字符串
指定字段代码。
关于可使用的字符的限制,请参照kintone帮助
properties. (字段代码).defaultNowValue字符串
设置是否将添加记录时的日期与时间设为初始值。
  • 将添加记录时的日期与时间作为初始值:true

  • 不将添加记录时的日期与时间作为初始值(初始设置):false

properties. (字段代码).defaultValue字符串或数组

指定初始值。可设置多个初始值的字段,以数组的形式指定。
指定“defaultNowValue”参数时,“defaultNowValue”参数优先。


▶选择用户字段
指定含有code和type的对象的数组
■ properties.字段代码.defaultValue[].code
对选择用户字段,指定要作为选项的用户。
指定任意一个选项。
・用户的登录名
・组的代码
・组织的代码
・函数名


函数名仅可指定用于指定当前登录用户的函数“ LOGINUSER() ”,在来宾空间内的应用中,仅可指定用户或组。

■ properties.字段代码.defaultValue[].type

指定值的类型。
・用户:USER
・组:GROUP
・组织:ORGANIZATION
・函数:FUNCTION

properties. (字段代码).digit整 数
设置是否显示数值的千位分隔符。
  • 显示时:true

  • 不显示时(初始值):false

properties. (字段代码).displayScale整 数
指定小数点以下的显示位数。
properties. (字段代码).entities数组
对用户选择字段指定要作为选项的用户。
properties. (字段代码).entities[].code字符串必须对用户选择字段指定作为选项的用户。
指定以下任意选项。
  • 用户的登录名

  • 组的代码

  • 组织的代码

properties. (字段代码).entities[].type字符串必须指定值的种类。
  • 用户时:USER

  • 组时:GROUP

  • 组织时:ORGANIZATION

properties. (字段代码).expression字符串
指定自动计算。
properties. (字段代码).fields对象
指定表格内的字段。参数和“properties”参数一样。
properties. (字段代码).format字符串
指定计算字段的显示格式。
  • 数值(例:1000):NUMBER(初始设置)

  • 数值(例:1,000):NUMBER_DIGIT

  • 日期与时间(例:2012-08-06 2:03):DATETIME

  • 日期(例:2012-08-06):DATE

  • 时间(例:2:03):TIME

  • 小时分(例:26小时3分):HOUR_MINUTE

  • 天小时分(例:1天2小时3 分):DAY_HOUR_MINUTE

properties. (字段代码).hideExpression布尔值
设置是否隐藏计算字段的计算公式。
  • 隐藏:true

  • 显示(初始值):false

properties. (字段代码).label字符串
指定字段名称。
properties. (字段代码).lookup对象
用于存放lookup字段的设置的对象。
properties. (字段代码).lookup.fieldMappings数组
用于存放“其他要复制的字段”的设置的数组。
properties. (字段代码).lookup.fieldMappings.field字符串必须“其他要复制的字段”的复制到的字段中指定的字段的代码。
properties. (字段代码).lookup.fieldMappings.relatedField字符串必须“其他要复制的字段”的复制来源的字段中指定的字段的代码。
properties. (字段代码).lookup.filterCond字符串必须筛选的初始设置用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).lookup.lookupPickerFields数组
通过字段代码的数组指定“要在搜选列表中显示的字段”。
properties. (字段代码).lookup.sort字符串必须排序的初始设置用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).maxLength整 数
指定最多字符数。
properties. (字段代码).maxValue整 数
指定最大值。
properties. (字段代码).minLength整 数
指定最字符数。
properties. (字段代码).minValue整 数
指定最小值。
properties. (字段代码).noLabel布尔值
指定是否隐藏字段名称
  • 隐藏:true

  • 显示(初始值):false

properties. (字段代码).openGroup布尔值
设置是否显示组合内字段。
  • 显示时:true

  • 隐藏(初始设置):false

properties. (字段代码).options对象
用于存放选项设置的对象。
properties. (字段代码).options.(选项名).index整 数必须用数字指定选项的顺序。选项根据所指定的数字来升序排列。
properties. (字段代码).options.(选项名).label字符串
指定选项名。添加选项时,需要指定此参数。
不指定的选项将被删除。
指定了不存在的选项时,会被添加为新选项。
properties. (字段代码).protocol字符串
指定链接的种类。
  • Web网站地址:WEB

  • 电话号码:CALL

  • 邮件地址:MAIL

properties. (字段代码).referenceTable对象
用于存放关联记录列表字段的设置的数组。
properties. (字段代码).referenceTable.condition对象
用于存放“设置要显示的记录”中的设置的对象。
properties. (字段代码).referenceTable.condition.field字符串
“设置要显示的记录”中指定的、与关联记录列表字段同一应用的字段的代码。
properties. (字段代码).referenceTable.condition.relatedField字符串
在“设置要显示的记录”中指定的、要参照的应用的代码。
properties. (字段代码).referenceTable.displayFields数组
通过字段代码的数组来指定”要显示的字段“中指定的字段。
properties. (字段代码).referenceTable.fliterCond字符串
“更多筛选条件”的设置用查询形式显示。查询形式请参考以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).referenceTable.relatedApp对象
用于存放”要引用的应用“的设置的对象。如果指定了此参数,关联记录列表字段的设置中,除了“要参照的应用”之外,其他的设置会被初始化。
properties. (字段代码).referenceTable.relatedApp.app整 数
“要引用的应用”中指定的应用ID。指定“properties.(字段代码).referenceTable.relatedApp.code”参数时,优先该参数。
properties. (字段代码).referenceTable.relatedApp.code字符串
“要引用的应用”中指定的应用代码。
properties. (字段代码).referenceTable.size整 数
一次最多可显示的记录数可指定5, 10, 20, 30的任意一个。
properties. (字段代码).referenceTable.sort字符串
设置记录的排序。用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).required布尔值
设置是否必填。
  • 必填:true

  • 任意(初始值):false

properties. (字段代码).thumbnailSize整 数
以像素为单位,从50, 150, 250, 500中选择一个作为缩略图的大小。
properties. (字段代码).type字符串
指定字段的类型。
  • 复选框:CHECK_BOX

  • 表格:SUBTABLE

  • 下拉菜单:DROP_DOWN

  • 选择用户:USER_SELECT

  • 单选框:RADIO_BUTTON

  • 文本编辑框:RICH_TEXT

  • 链接:LINK

  • lookup:SINGLE_LINE_TEXT、または NUMBER *

  • 记录编号:RECORD_NUMBER

  • 关联记录列表:REFERENCE_TABLE

  • 计算:CALC

  • 更新人:MODIFIER

  • 更新时间:UPDATED_TIME

  • 创建人:CREATOR

  • 创建时间:CREATED_TIME

  • 时间:TIME

  • 数值:NUMBER

  • 附件:FILE

  • 日期与时间:DATETIME

  • 日期:DATE

  • 多选:MULTI_SELECT

  • 单行文本框:SINGLE_LINE_TEXT

  • 多行文本框:MULTI_LINE_TEXT

*: 指定要参照的字段的类型。
properties. (字段代码).unique布尔值
设置是否值为唯一。
  • 值为唯一:true

  • 允许重复(初始值):false

properties. (字段代码).unit字符串
指定单位符号。
properties. (字段代码).unitPosition字符串
指定单位符号的显示位置。
  • 放在字段前(初始设置):BEFORE

  • 放在字段后:AFTER

revision整 数
指定应用的设置更改之前的修订号。如指定的修订号不是最新的,请求将报错。
如果省略或指定“-1”,将不对修订号进行验证。

 以下字段不可添加也不可更改设置。

  • 状态

  • 执行者

  • 类别

请求的范例

头部

PUT /k/v1/preview/app/form/fields.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

应答

参数

参数名称值的类型说明
revision字符串应用的设置更改之后的修订号。

应答的范例

删除字段

从表单删除字段。删除组合或表格时,其包含的字段也一并被删除。

值会自动输入的以下字段,如果从表单中删除,不会删除数据。

  • 记录编号

  • 创建人

  • 更新人

  • 创建时间

  • 更新时间

另外,不可删除以下字段。

  • 状态

  • 执行者

  • 类别

URI

https://(子域名).cybozu.cn/k/v1/preview/app/form/fields.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/form/fields.json

HTTP 方法

DELETE

访问权限

  • 需要有应用的记录管理权限。

  • 不可使用API令牌来执行该API。

请求

参数

参数名称要指定的值必须说明
app整 数必须指定应用的ID。
fields数组必须

指定要删除的字段的代码。

※可指定的字段上限为100个

revision整 数
指定应用的设置更改之前的修订号。如指定的修订号不是最新的,请求将报错。
如果省略或指定“-1”,将不对修订号进行验证。

(1) 参数通过 HTTP 请求字符串发送时

头部

DELETE /k/v1/preview/app/form/fields.json?app=1&fields[0]=%E6%96%87%E5%AD%97%E5%88%97__1%E8%A1%8C_&fields[1]=%E6%95%B0%E5%80%A4&revision=2 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

(2) 参数通过JSON形式发送时(在HTTP 请求的请求body中写JSON 数据)

头部

DELETE /k/v1/preview/app/form/fields.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

应答

参数

参数名称值的类型说明
revision字符串应用的设置更改之后的修订号。

应答的范例

更改表单的布局

URI

https://(子域名).cybozu.cn/k/v1/preview/app/form/layout.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/form/layout.json

HTTP 方法

PUT

访问权限

  • 需要有应用的记录管理权限。

  • 不可使用API令牌来执行该API。

请求

参数

以下是要指定的参数一览。
表单上的所有字段都需要指定布局。参数省略时,不会更改其设置。

参数名称要指定的值必须说明
app整 数必须指定应用的ID。
layout数组
用于存放表单各行的布局的数组。
layout[].code字符串
指定表格或组合的代码。非表格也非组合的标准行,可省略此参数。
layout[].fields数组
用于存放行里的字段的数组。
layout[].fields[].code字符串
指定字段代码。标签、空白栏以及边框不需要指定此参数。
layout[].fields[].elementId字符串
如果是空白栏字段,要指定元素ID。
layout[].fields[].label字符串
标签字段要指定标签名称。
layout[].fields[].size对象
用于存放字段大小的对象。根据布局情况,字段有可能不会按照指定的大小来显示。
layout[].fields[].size.height整 数
包含字段名称在内的、以像素为单位的字段的纵向长度。仅可对空白栏字段进行指定。
layout[].fields[].size.innerHeight整 数
除了字段名称之外的、以像素为单位的字段的纵向长度。
仅可指定以下字段。
  • 文字列(複数行)

  • 文本编辑框

layout[].fields[].size.width整 数
以像素为单位的字段宽度。
仅可指定以下字段。
  • 单行文本框

  • 多行文本框

  • 文本编辑框

  • 数値

  • 计算

  • 时间

  • 日期

  • 日期与时间

  • 多选

  • 下拉菜单

  • 单选框

  • 复选框

  • 附件

  • 选择用户

  • 链接

  • lookup

  • 标签

  • 空白栏

  • 边框

  • 记录编号

  • 创建人

  • 创建时间

  • 更新人

  • 更新时间

layout[].fields[].type字符串必须指定字段的类型。
  • 类别:CATEGORY

  • 空白栏:SPACER

  • 复选框:CHECK_BOX

  • 表格:SUBTABLE

  • 下拉菜单:DROP_DOWN

  • 选择用户:USER_SELECT

  • 单选框:RADIO_BUTTON

  • 标签:LABEL

  • 文本编辑框:RICH_TEXT

  • 链接:LINK

  • lookup:SINGLE_LINE_TEXT或 NUMBER *

  • 记录编号:RECORD_NUMBER

  • 关联记录列表:REFERENCE_TABLE

  • 计算:CALC

  • 边框:HR

  • 更新人:MODIFIER

  • 更新时间:UPDATED_TIME

  • 创建人:CREATOR

  • 创建时间:CREATED_TIME

  • 时间:TIME

  • 数值:NUMBER

  • 附件:FILE

  • 日期与时间:DATETIME

  • 日期:DATE

  • 多选:MULTI_SELECT

  • 单行文本框:SINGLE_LINE_TEXT

  • 多行文本框:MULTI_LINE_TEXT

*: 指定要参照的字段的类型。
layout[].layout数组
用于存放组合内的字段的布局的数组。参数和“layout”参数一样。
layout[].type字符串必须指定行的种类。
  • 标准行:ROW

  • 表格:SUBTABLE

  • 组合字段:GROUP

revision整 数
指定应用的设置更改之前的修订号。如指定的修订号不是最新的,请求将报错。
如果省略或指定“-1”,将不对修订号进行验证。

请求的范例

头部

PUT /k/v1/preview/app/form/layout.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

应答

参数

参数名称值的类型说明
revision字符串应用的设置更改之后的修订号。

应答的范例

    您需要登录后才可以回复