获取表单的设置

aki发表于:2016年12月22日 13:51:52更新于:2017年08月04日 16:32:32

获取应用的表单的设置。
获取表单的设置时,根据如下两个操作的不同,要使用的API也不一样。

  • 获取字段的列表
    获取字段列表及其设置。

  • 获取表单的布局
    获取以下设置。

    • 字段的长度和宽度

    • 设为表格的字段及其顺序

    • 放在组合里的字段及其布局

    • 标签、空白栏及其边框的设置

获取字段的列表

URI

获取正式环境的设置时所使用的URI跟获取测试环境设置时不一样。

获取正式环境的设置时

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

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

获取测试环境的设置时

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

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

HTTP 方法

GET

访问权限

  • 要获取正式环境的设置,需要有应用记录的查看权限。

  • 要获取测试环境的设置,需要有应用的管理权限。

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

请求

参数

参数名称要指定的值必须说明
app整 数必须指定应用的ID。
lang字符串
给字段或选项的名称设置了多语言的情况,需要指定要获取的名称的语言。
  • 获取日语的名称时:ja

  • 获取英语的名称时:en

  • 获取中文的名称时:zh

  • 获取头部的「Accept-Language」属性中的语言时:user
    ※如果头部中不指定“Accept-Language”,会默认获取中文。

  • 获取默认的名称时:default

省略时,获取默认名称。

请求的范例

要发送的请求根据参数发送方式的不同而不同。以下是指定参数“app”和“lang”的请求的例子。

URL中包含参数时

GET /k/v1/app/form/fields.json?app=8&lang=ja HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

请求正文中包含参数时
头部

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

正文

应答

参数

参数名称值的类型说明
properties对象字段设置的对象。
properties. (字段代码).align字符串选项的排列。
  • HORIZONTAL:横

  • VERTICAL:纵

properties. (字段代码).code字符串字段代码。
properties. (字段代码).defaultNowValue字符串设置是否将添加记录时的日期作为初始值。
  • true:将添加记录时的日期作为初始值

  • false:不将添加记录时的日期作为初始值

properties. (字段代码).defaultValue字符串或数组初始值。可设置多个初始值的字段,将以数组的形式返回。
properties. (字段代码).digit字符串设置是否显示数值的千位分隔符。
  • true:显示千位分隔符

  • false:不显示千位分隔符

properties. (字段代码).displayScale字符串小数点以下显示位数。未设置时为空。
properties. (字段代码).enabled字符串

设置是否启用功能。这个参数仅可用于状态字段和类别字段。

  • 状态字段

    • true:启用流程管理功能

    • false:禁用流程管理功能

  • 类别

    • true:启用类别功能

    • false:禁用类别功能

properties. (字段代码).entities数组用于存放选项中的用户的数组。未设置时为空。
properties. (字段代码).entities[].code字符串选择中的用户、组或组织的代码。
properties. (字段代码).entities[].type字符串值的种类。
  • USER:用户

  • GROUP:组

  • ORGANIZATION:组织

properties. (字段代码).expression字符串自动计算公式。未设置时为空。
properties. (字段代码).fields对象用于存放表格内字段的对象。对象的参数和“properties”参数一样。
properties. (字段代码).format字符串计算字段的显示形式。
  • NUMBER:数值(例:1000)

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

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

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

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

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

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

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

  • false:显示

properties. (字段代码).label字符串字段名称。
properties. (字段代码).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.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.size字符串一次最多可显示的最大记录数。
properties. (字段代码).referenceTable.sort字符串设置记录的排序。用查询形式显示。关于查询形式,请参照以下页面。
批量获取记录(在查询中指定条件)
properties. (字段代码).required字符串设置是否必填。
  • true:必填

  • false:任意

properties. (字段代码).thumbnailSize字符串图片的缩略图大小(单位是像素)。
properties. (字段代码).type字符串字段的类型。
  • CALC:计算

  • CATEGORY:类别

  • CHECK_BOX:复选框

  • CREATED_TIME:创建时间

  • CREATOR:创建人

  • DATE:日期

  • DATETIME:日期与时间

  • DROP_DOWN:下拉菜单

  • FILE:附件

  • LINK:链接

  • MODIFIER:更新人

  • MULTI_LINE_TEXT:多行文本框

  • MULTI_SELECT:多选

  • NUMBER:数值或lookup *

  • RADIO_BUTTON:单选框

  • RECORD_NUMBER:记录编号

  • RICH_TEXT:文本编辑框

  • SINGLE_LINE_TEXT:单行文本框或lookup *

  • STATUS:流程管理功能的状态

  • STATUS_ASSIGNEE:流程管理功能的执行者

  • SUBTABLE:表格

  • TIME:时间

  • UPDATED_TIME:更新时间

  • USER_SELECT:选择用户

*: lookup字段被视为与所参照的字段相同类型。
properties. (字段代码).unique字符串设置是否值为唯一。
  • true:值为唯一

  • false:允许重复

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

  • AFTER:放在字段后

revision字符串应用的设定的修订号。 

应答的范例

JavaScript 范例

kintone REST API

XMLHttpRequest

获取表单的布局

URI

获取正式环境的设置时所使用的URI跟获取测试环境设置时不一样。

获取正式环境的设置时

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

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

获取测试环境的设置时

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

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

HTTP 方法

GET

访问权限

  • 要获取正式环境的设置,需要有应用记录的查看权限。

  • 要获取测试环境的设置,需要有应用的管理权限。

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

请求

参数

参数名称要指定的值必须说明
app字符串必须指定应用的ID。

请求的范例

要发送的请求根据参数的发送方式不同而不同。以下是指定参数“app”时的请求范例。

URL中包含参数时

GET /k/v1/app/form/layout.json?app=8 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

请求正文中包含参数时
头部

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

正文

应答

参数

参数名称值的类型说明
layout数组用于存放表单各行的布局的数组。
layout[].code字符串表格或组合的代码。如果都不是这两者的话,该参数不输出。
layout[].fields数组用于存放行里的字段的数组。
layout[].fields[].code字符串字段代码。
layout[].fields[].elementId字符串元素ID。作为空白栏字段输出。
layout[].fields[].label字符串标签名。作为标签字段输出。
layout[].fields[].size对象用于存放字段大小的对象。
layout[].fields[].size.heigit字符串包含字段名称在内的、以像素为单位的字段长度。
layout[].fields[].size.innerHeight字符串除了字段名称之外的、以像素为单位的字段长度。
layout[].fields[].size.width字符串以像素为单位的字段宽度。
layout[].fields[].type字符串字段的类型。
  • CALC:计算

  • CATEGORY:类别

  • CHECK_BOX:复选框

  • CREATED_TIME:创建时间

  • CREATOR:创建人

  • DATE:日期

  • DATETIME:日期与时间

  • DROP_DOWN:下拉菜单

  • FILE:附件

  • HR:边框

  • LABEL:标签

  • LINK:链接

  • MODIFIER:更新人

  • MULTI_LINE_TEXT:多行文本框

  • MULTI_SELECT:多选

  • NUMBER:数值或lookup *

  • RADIO_BUTTON:单选框

  • RECORD_NUMBER:记录编号

  • RICH_TEXT:文本编辑框

  • SINGLE_LINE_TEXT:单行文本框或lookup *

  • SPACER:空白栏

  • STATUS:流程管理功能的状态

  • STATUS_ASSIGNEE:流程管理功能的执行者

  • SUBTABLE:表格

  • TIME:时间

  • UPDATED_TIME:更新时间

  • USER_SELECT:选择用户

*: lookup字段被视为与所参照的字段相同类型。
layout[].layout数组用于存放组合内的字段的布局的数组。
layout[].type字符串行的种类。
  • ROW:标准行。

  • SUBTABLE:表格。

  • GROUP:组合字段。

revision字符串应用的设定的修订号。

应答的范例

JavaScript 范例

kintone REST API

XMLHttpRequest

    您需要登录后才可以回复