获取应用的表单的设置。
获取表单的设置时，根据如下两个操作的不同，要使用的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

必要的访问权限

获取正式环境的设置时，需要以下至少其中一个访问权限。

• 应用的记录查看权限

• 应用的记录添加权限
  

获取测试环境的设置时

• 应用的管理权限

※从2020年2月版本开始可以使用API令牌来执行此API。

请求参数

请求的范例

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

URL中包含参数时

GET /k/v1/app/form/fields.json?app=8&lang=zh 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

正文

{
  "app": 1,
  "lang": "default"
}

应答

参数

应答的范例

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

JavaScript 范例

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

var body = {
    "app": 1
};

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

使用 XMLHttpRequest 请求

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

获取表单的布局

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

必要的访问权限

获取正式环境的设置时，需要以下至少其中一个访问权限。

• 应用的记录查看权限

• 应用的记录添加权限
  

获取测试环境的设置时

• 应用的管理权限

※从2020年2月版本开始可以使用API令牌来执行此API。

请求参数

请求的范例

要发送的请求根据参数的发送方式不同而不同。以下是指定参数“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

正文

{
  "app": "8"
}

应答

参数

应答的范例

{
    "revision": "2",
    "layout": [
        {
            "type": "ROW",
            "fields": [
                {
                    "type": "SINGLE_LINE_TEXT",
                    "code": "单行文本框",
                    "size": {
                        "width": "200"
                    }
                },
                {
                    "type": "MULTI_LINE_TEXT",
                    "code": "多行文本框",
                    "size": {
                        "width": "200",
                        "innerHeight": "100"
                    }
                },
                {
                    "type": "LABEL",
                    "label": "label",
                    "size": {
                        "width": "200"
                    }
                },
                {
                    "type": "SPACER",
                    "elementId": "spacer",
                    "size": {
                        "width": "200",
                        "height": "100"
                    }
                },
                {
                    "type": "HR",
                    "size": {
                        "width": "200"
                    }
                }
            ]
        },
        {
            "type": "SUBTABLE",
            "code": "表格",
            "fields": [
                {
                    "type": "NUMBER",
                    "code": "数值",
                    "size": {
                        "width": "200"
                    }
                }
            ]
        },
        {
            "type": "GROUP",
            "code": "组",
            "layout": [
                {
                    "type": "ROW",
                    "fields": [
                        {
                            "type": "NUMBER",
                            "code": "数值2",
                            "size": {
                                "width": "200"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

JavaScript 范例

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

var body = {
    "app": 1
};

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

使用 XMLHttpRequest 请求

var url = 'https://{subdomain}.cybozu.cn/k/v1/app/form/layout.json?app=1';
 
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
    if (xhr.status === 200) {
        // success
        console.log(JSON.parse(xhr.responseText));
    } else {
        // error
        console.log(JSON.parse(xhr.responseText));
    }
};
xhr.send();