更改应用的表单的设置

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

• 添加字段
  将字段添加到表单。

• 更改字段的设置
  更改表单的字段的设置。

• 删除字段
  删除表单中的字段。

• 更改表单的布局
  更改以下设置。

  • 字段的长度和宽度

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

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

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

添加字段

在表单中添加字段。

此API仅将应用的设置反映到测试环境中，如需反映到正式环境，需要执行将应用的设置反映到正式环境中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

必要的访问权限

应用的管理权限。

请求参数

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

• 状态

• 执行者

• 类别

请求的范例

头部

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": {
      "单行文本框": {
        "type": "SINGLE_LINE_TEXT",
        "code": "单行文本框",
        "label": "单行文本框",
        "noLabel": false,
        "required": false,
        "minLength": "",
        "maxLength": "",
        "expression": "",
        "hideExpression": false,
        "unique": false,
        "defaultValue": ""
      },
      "文本编辑框": {
        "type": "RICH_TEXT",
        "code": "文本编辑框",
        "label": "文本编辑框",
        "noLabel": false,
        "required": false,
        "defaultValue": ""
      },
      "多行文本框": {
        "type": "MULTI_LINE_TEXT",
        "code": "多行文本框",
        "label": "多行文本框",
        "noLabel": false,
        "required": false,
        "defaultValue": ""
      },
      "数值": {
        "type": "NUMBER",
        "code": "数值",
        "label": "数值",
        "noLabel": false,
        "required": false,
        "minValue": "",
        "maxValue": "",
        "digit": false,
        "unique": false,
        "defaultValue": "",
        "displayScale": "",
        "unit": "",
        "unitPosition": "BEFORE"
      },
      "计算": {
        "type": "CALC",
        "code": "计算",
        "label": "计算",
        "noLabel": false,
        "required": false,
        "expression": "数值",
        "format": "NUMBER",
        "displayScale": "",
        "hideExpression": false,
        "unit": "",
        "unitPosition": "BEFORE"
      },
      "单选框": {
        "type": "RADIO_BUTTON",
        "code": "单选框",
        "label": "单选框",
        "noLabel": false,
        "required": true,
        "options": {
          "sample1": {
            "label": "sample1",
            "index": "0"
          },
          "sample2": {
            "label": "sample2",
            "index": "1"
          }
        },
        "defaultValue": "sample1",
        "align": "HORIZONTAL"
      },
      "复选框": {
        "type": "CHECK_BOX",
        "code": "复选框",
        "label": "复选框",
        "noLabel": false,
        "required": false,
        "options": {
          "sample1": {
            "label": "sample1",
            "index": "0"
          },
          "sample2": {
            "label": "sample2",
            "index": "1"
          }
        },
        "defaultValue": [],
        "align": "HORIZONTAL"
      },
      "多选": {
        "type": "MULTI_SELECT",
        "code": "多选",
        "label": "多选",
        "noLabel": false,
        "required": false,
        "options": {
          "sample1": {
            "label": "sample1",
            "index": "0"
          },
          "sample2": {
            "label": "sample2",
            "index": "1"
          },
          "sample3": {
            "label": "sample3",
            "index": "2"
          },
          "sample4": {
            "label": "sample4",
            "index": "3"
          }
        },
        "defaultValue": []
      },
      "下拉框": {
        "type": "DROP_DOWN",
        "code": "下拉框",
        "label": "下拉框",
        "noLabel": false,
        "required": false,
        "options": {
          "sample1": {
            "label": "sample1",
            "index": "0"
          },
          "sample2": {
            "label": "sample2",
            "index": "1"
          }
        },
        "defaultValue": ""
      },
      "日期": {
        "type": "DATE",
        "code": "日期",
        "label": "日期",
        "noLabel": false,
        "required": false,
        "unique": false,
        "defaultValue": "",
        "defaultNowValue": true
      },
      "时间": {
        "type": "TIME",
        "code": "时间",
        "label": "时间",
        "noLabel": false,
        "required": false,
        "defaultValue": "",
        "defaultNowValue": true
      },
      "日期与时间": {
        "type": "DATETIME",
        "code": "日期与时间",
        "label": "日期与时间",
        "noLabel": false,
        "required": false,
        "unique": false,
        "defaultValue": "",
        "defaultNowValue": true
      },
      "附件": {
        "type": "FILE",
        "code": "附件",
        "label": "附件",
        "noLabel": false,
        "required": false,
        "thumbnailSize": "150"
      },
      "链接": {
        "type": "LINK",
        "code": "链接",
        "label": "链接",
        "noLabel": false,
        "required": false,
        "protocol": "WEB",
        "minLength": "",
        "maxLength": "",
        "unique": false,
        "defaultValue": ""
      },
      "选择用户": {
        "type": "USER_SELECT",
        "code": "选择用户",
        "label": "选择用户",
        "noLabel": false,
        "required": false,
        "entities": [],
        "defaultValue": []
      },
      "选择组织": {
        "type": "ORGANIZATION_SELECT",
        "code": "选择组织",
        "label": "选择组织",
        "noLabel": false,
        "required": false,
        "entities": [],
        "defaultValue": []
      },
      "选择组": {
        "type": "GROUP_SELECT",
        "code": "选择组",
        "label": "选择组",
        "noLabel": false,
        "required": false,
        "entities": [],
        "defaultValue": []
      },
      "关联记录列表": {
        "type": "REFERENCE_TABLE",
        "code": "关联记录列表",
        "label": "关联记录列表",
        "noLabel": false,
        "referenceTable": {
          "relatedApp": {
            "app": "2",
            "code": ""
          },
          "condition": {
            "field": "记录编号",
            "relatedField": "数值"
          },
          "filterCond": "",
          "displayFields": [
            "单行文本框"
          ],
          "sort": "记录编号 desc",
          "size": "5"
        }
      },
      "lookup": {
        "type": "NUMBER",
        "code": "lookup",
        "label": "lookup",
        "noLabel": false,
        "required": false,
        "lookup": {
          "relatedApp": {
            "app": "2",
            "code": ""
          },
          "relatedKeyField": "记录编号",
          "fieldMappings": [
            {
              "field": "选择用户",
              "relatedField": "创建人"
            }
          ],
          "lookupPickerFields": [],
          "filterCond": "",
          "sort": "记录编号 desc"
        }
      },
      "组合": {
        "type": "GROUP",
        "code": "组合",
        "label": "组合",
        "noLabel": false,
        "openGroup": false
      },
      "Table": {
        "type": "SUBTABLE",
        "code": "Table",
        "fields": {
          "单行文本框_0": {
            "type": "SINGLE_LINE_TEXT",
            "code": "单行文本框_0",
            "label": "单行文本框",
            "noLabel": false,
            "required": false,
            "minLength": "",
            "maxLength": "",
            "expression": "",
            "hideExpression": false,
            "unique": false,
            "defaultValue": ""
          }
        }
      }
    }
  }

应答参数

应答的范例

{    
  "revision": "1"    
}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {
  'app': 1,
  'revision': 2,
  'properties': {
    '单行文本框': {
      'type': 'SINGLE_LINE_TEXT',
      'code': '单行文本框',
      'label': '单行文本框',
      'noLabel': false,
      'required': false,
      'minLength': '',
      'maxLength': '',
      'expression': '',
      'hideExpression': false,
      'unique': false,
      'defaultValue': ''
    }
  }
};

kintone.api(kintone.api.url('/k/v1/preview/app/form/fields', true), 'POST', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

使用 XMLHttpRequest 请求

var body = {
  'app': 1,
  'revision': 2,
  'properties': {
    '单行文本框': {
      'type': 'SINGLE_LINE_TEXT',
      'code': '单行文本框',
      'label': '单行文本框',
      'noLabel': false,
      'required': false,
      'minLength': '',
      'maxLength': '',
      'expression': '',
      'hideExpression': false,
      'unique': false,
      'defaultValue': ''
    }
  },
  // CSRF TOKEN: 在kintone上执行API(POST, PUT, DELETE)时需要设置
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.cybozu.cn/k/v1/preview/app/form/fields.json';
var xhr = new XMLHttpRequest();
xhr.open('POST', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(JSON.stringify(body));

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