更改表单的设置1

aki发表于:2016年12月27日 17:21:58更新于:2019年02月11日 11:38:26

更改应用的表单的设置

更改表单的设置时,根据操作的不同,要使用的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

正文

{
  "app": 1,
  "revision": 2,
  "properties": {
    "单行文本框": {
      "code": "单行文本框",
      "defaultValue": "",
      "expression": "",
      "hideExpression": false,
      "maxLength": 64,
      "minLength": 0,
      "label": "单行文本框",
      "noLabel": false,
      "required": true,
      "type": "SINGLE_LINE_TEXT",
      "unique": true
    },
    "数值": {
      "code": "数值",
      "defaultValue": "12345",
      "digit": true,
      "displayScale": "",
      "expression": "",
      "maxValue": 64,
      "minValue": 0,
      "label": "数值",
      "noLabel": true,
      "required": false,
      "type": "NUMBER",
      "unique": false,
      "unit": "$",
      "unitPosition": "BEFORE"
    },
    "单选框": {
      "code": "单选框",
      "defaultValue": "sample2",
      "label": "单选框",
      "noLabel": false,
      "options": {
        "sample1": {
          "label": "sample1",
          "index": 0
        },
        "sample2": {
          "label": "sample2",
          "index": 1
        },
        "sample3": {
          "label": "sample3",
          "index": 2
        }
      },
      "align": "horizontal",
      "required": true,
      "type": "RADIO_BUTTON"
    },
    "复选框": {
      "code": "复选框",
      "defaultValue": [
        "sample1",
        "sample3"
      ],
      "label": "复选框",
      "noLabel": false,
      "options": {
        "sample1": {
          "label": "sample1",
          "index": 0
        },
        "sample2": {
          "label": "sample2",
          "index": 2
        },
        "sample3": {
          "label": "sample3",
          "index": 1
        }
      },
      "align": "horizontal",
      "required": false,
      "type": "CHECK_BOX"
    },
    "日期": {
      "code": "日期",
      "defaultNowValue": true,
      "defaultValue": "",
      "label": "日期",
      "noLabel": false,
      "required": false,
      "type": "DATE",
      "unique": true
    },
    "日期与时间": {
      "code": "日期与时间",
      "defaultNowValue": false,
      "defaultValue": "2012-07-19T00:00:00.000Z",
      "label": "日期与时间",
      "noLabel": false,
      "required": false,
      "type": "DATETIME",
      "unique": false
    },
    "附件": {
      "code": "附件",
      "label": "附件",
      "noLabel": true,
      "required": false,
      "type": "FILE",
      "thumbnailSize": "150"
    },
    "链接": {
      "code": "链接",
      "defaultValue": "http://hoge.xxx",
      "maxLength": 64,
      "minLength": 0,
      "label": "链接",
      "noLabel": true,
      "protocol": "WEB",
      "required": false,
      "type": "LINK",
      "unique": false
    },
    "选择用户": {
      "code": "选择用户",
      "label": "选择用户",
      "noLabel": true,
      "required": false,
      "type": "USER_SELECT",
      "entities": [
        {
          "code": "user1",
          "type": "USER"
        },
        {
          "code": "group1",
          "type": "GROUP"
        }
      ],
      "defaultValue": [
        {
          "code": "user1",
          "type": "USER"
        },
        {
          "code": "group1",
          "type": "GROUP"
        },
        {
          "code": "org1",
          "type": "ORGANIZATION"
        },
        {
          "code": "LOGINUSER()",
          "type": "FUNCTION"
        }
      ]
    },
    "关联记录列表": {
      "code": "关联记录列表",
      "label": "关联记录列表",
      "noLabel": true,
      "referenceTable": {
        "relatedApp": {
          "app": 3,
          "code": "要参照的应用"
        },
        "condition": {
          "field": "此应用的字段",
          "relatedField": "要参照的应用的字段"
        },
        "filterCond": "数值 > 10 and 数值2 > 20",
        "displayFields": [
          "要显示的字段1",
          "要显示的字段2"
        ],
        "sort": "排序字段1 desc, 排序字段2 asc",
        "size": 5
      },
      "type": "REFERENCE_TABLE"
    },
    "lookup": {
      "code": "lookup",
      "label": "lookup",
      "lookup": {
        "relatedApp": {
          "app": 100,
          "code": "复制来源应用"
        },
        "relatedKeyField": "复制来源字段",
        "fieldMappings": [
          {
            "field": "复制目标字段",
            "relatedField": "复制来源字段"
          }
        ],
        "lookupPickerFields": [
          "选择lookup时显示的字段1"
        ],
        "filterCond": "数值 > 10 and 数值2 > 20",
        "sort": "排序字段1 desc, 排序字段2 asc"
      },
      "noLabel": true,
      "required": false,
      "type": "SINGLE_LINE_TEXT"
    },
    "组合": {
      "code": "组合",
      "label": "组合",
      "noLabel": true,
      "type": "GROUP",
      "openGroup": true
    },
    "表格": {
      "code": "表格",
      "type": "SUBTABLE",
      "fields": {
        "单行文本_表格": {
          "code": "单行文本_表格",
          "defaultValue": "",
          "expression": "",
          "hideExpression": false,
          "maxLength": 64,
          "minLength": 0,
          "label": "单行文本_表格",
          "noLabel": false,
          "required": true,
          "type": "SINGLE_LINE_TEXT",
          "unique": false
        }
      }
    }
  }
}

应答

参数

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

应答的范例

{    
  "revision": "1"    
}


更改字段的设置删除字段 及 更改表单的布局 请参见 更改表单的设置2


    您需要登录后才可以回复