字段格式

aki发表于:2016年08月29日 15:19:15更新于:2016年11月17日 11:15:48

关于可使用的字段的type和value

字段的JSON格式如下。type和value因字段类型的不同而不同。

  • 获取、添加或更新记录时须指定【字段代码】。
    ※【字段代码】可在字段的【设置】页面中查看。但,以下类型的字段请指定【字段名称】。
    ※【字段名称】可在字段的【设置】页面中查看。

    • 类别

    • 状态

    • 执行者

  • 使用添加或更新API发送JSON数据时,只需发送【value】参数。【type】无需发送。
    ※下文中也会提及到,个别JavaScript API在添加或更新【表格】数据时需要指定【type】。

关于记录编号和记录ID

  • 记录编号:系统自动分配给记录的、与其他记录不重复的编号。 
    但是,如设置了应用代码,则应用代码和编号组合起来作为记录编号。 
    例如:应用代码为【APPCODE】的应用,其记录编号为【APPCODE-1】。

  • 记录ID:系统自动分配给记录的、与其他记录不重复的编号,必须为数值。 
    处理API时,请使用记录ID。

原始信息

字段类型typevalue的范例
※此处,【value的范例】的【字段代码】用< >括起开,实际使用时不需要。
记录编号 ※3RECORD_NUMBER
  • 获取时的应答数据

"<字段代码>": {
    "type": "RECORD_NUMBER",
    "value": "1"
}
以下为应用代码中指定了【APPCODE】时的范例。
"<字段代码>": {
    "type": "RECORD_NUMBER",
    "value": "APPCODE-1"
}
记录ID ※3__ID__
  • 获取时的应答数据

"$id": {
    "type": "__ID__",
    "value": "1"
}
版本 ※3__REVISION__
  • 获取时的应答数据

"$revision": {
    "type": "__REVISION__",
    "value": "5"
}
创建人 ※4CREATOR
  • 获取时的应答数据

"<字段代码>": {
    "type": "CREATOR",
    "value": {
        "code": "zhou",
        "name": "zhou shijie"
    }
}

来宾用户的情况

"<字段代码>": {
    "type": "CREATOR",
    "value": {
        "code": "guest/zhou@cybozu.cn",
        "name": "zhou shijie"
    }
}
  • 添加时的请求数据

"<字段代码>": {
    "value": {
        "code": "zhou"
    }
}
创建时间 ※4CREATED_TIME
  • 获取时的应答数据

"<字段代码>": {
    "type": "CREATED_TIME",
    "value": "2012-01-11T11:30:00Z"
}
・【YYYY-MM-DD】和【HH:MM:SS】之间的【T】为固定值。 

・【HH:MM:SS】之后的【Z】为固定值,表示UTC。

  • 添加时的请求数据

"<字段代码>": {
    "value": "2012-01-11T11:30:00Z"
}
・【YYYY-MM-DD】和【HH:MM:SS】之间的【T】为固定值。 
・【HH:MM:SS】之后的【Z】为固定值,表示UTC。
"<字段代码>": {
    "value": "2012-01-11T11:30:00+08:00"
}

・需使用【±HH:MM】指定与UTC的时差。

・不可指定未来的时间。

更新人 ※4MODIFIER
  • 获取时的应答数据

"<字段代码>": {
    "type": "MODIFIER",
    "value": {
        "code": "zhou",
        "name": "zhou shijie"
    }
}

来宾用户的情况

"<字段代码>": {
    "type": "MODIFIER",
    "value": {
        "code": "guest/zhou@cybozu.cn",
        "name": "zhou shijie"
    }
}
  • 添加时的请求数据

"<字段代码>": {
    "value": {
        "code": "zhou"
    }
}
更新时间 ※4UPDATED_TIME
  • 获取时的应答数据

"<字段代码>": {
    "type": "UPDATED_TIME",
    "value": "2012-01-11T11:30:00Z"
}
・【YYYY-MM-DD】和【HH:MM:SS】之间的【T】为固定值。 
・【HH:MM:SS】之后的【Z】为固定值,表示UTC。
  • 添加时的请求数据

"<字段代码>": {
    "value": "2012-01-11T11:30:00Z"
}
・【YYYY-MM-DD】和【HH:MM:SS】之间的【T】为固定值。 
・【HH:MM:SS】之后的【Z】为固定值,表示UTC。
"<字段代码>": {
    "value": "2012-01-11T11:30:00+08:00"
}
・需使用【±HH:MM】指定与UTC的时差。 
・不可指定未来的时间。


自定义字段

字段类型typevalue
单行文本框SINGLE_LINE_TEXT
  • 获取时的应答数据

"<字段代码>": {
    "type": "SINGLE_LINE_TEXT",
    "value": "文本内容。"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "文本内容。"
}
数值NUMBER
  • 获取时的应答数据

"<字段代码>": {
    "type": "NUMBER",
    "value": "123"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "123"
}
计算 ※3CALC
  • 获取时的应答数据

"<字段代码>": {
    "type": "CALC",
    "value": "123"
}
根据显示格式的设置, "value" 的值也不同。
  • 数值: "1234"

  • 数值(逗号隔开): "1234"

  • 日期与时间: "2012-01-11T11:30:00Z"

  • 日期: "2012-01-11"

  • 时间: "11:30"

  • 时间(小时、分): "49:30" (页面上显示"49小时30分")

  • 时间(天、小时、分): "49:30" (页面上显示"2天1小时30分")

  • 无法使用添加/更新时的请求数据进行添加/更新。

多行文本框MULTI_LINE_TEXT
  • 获取时的应答数据

"<字段代码>": {
    "type": "MULTI_LINE_TEXT",
    "value": "文本\n内容。"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "文本\n内容。"
}
文本编辑框RICH_TEXT
  • 获取时的应答数据

"<字段代码>": {
    "type": "RICH_TEXT",
    "value": "<a href=\"http://www.cybozu.cn\">才望子</a>"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "<a href=\"http://www.cybozu.cn\">才望子</a>"
}
复选框 ※1CHECK_BOX
  • 获取时的应答数据

"<字段代码>": {
     "type": "CHECK_BOX",
     "value": [
         "选项1",
         "选项2"
     ]
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": [
        "选项1",
        "选项2"
    ]
}
单选框 ※1RADIO_BUTTON
  • 获取时的应答数据

"<字段代码>": {
    "type": "RADIO_BUTTON",
    "value": "选项3"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "选项3"
}
下拉菜单 ※1DROP_DOWN
  • 获取时的应答数据

"<字段代码>": {
    "type": "DROP_DOWN",
    "value": "选项3"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "选择3"
}
多选 ※1MULTI_SELECT
  • 获取时的应答数据

"<字段代码>": {
    "type": "MULTI_SELECT",
    "value": [
        "选项1",
        "选项2"
    ]
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": [
        "选项1",
        "选项2"
    ]
}
附件FILE
  • 获取时的应答数据

"<字段代码>": {
    "type": "FILE",
    "value": [
        {
            "contentType": "text/plain",
            "fileKey":"201202061155587E339F9067544F1A92C743460E3D12B3297",
            "name": "17to20_VerupLog (1).txt",
            "size": "23175"
        },
        {
            "contentType": "text/plain",
            "fileKey": "201202061155583C763E30196F419E83E91D2E4A03746C273",
            "name": "17to20_VerupLog.txt",
            "size": "23175"
        }
    ]
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": [
        {
            "fileKey":"201202061155587E339F9067544F1A92C743460E3D12B3297",
        },
        {
            "fileKey": "201202061155583C763E30196F419E83E91D2E4A03746C273",
        }
    ]
}
链接LINK
  • 获取时的应答数据

"<字段代码>": {
    "type": "LINK",
    "value": "http://cybozu.cn/"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "http://cybozu.cn/"
}
日期 ※2DATE
  • 获取时的应答数据

"<字段代码>": {
    "type": "DATE",
    "value": "2012-01-11"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "2012-01-11"
}
时间 ※2TIME
  • 获取时的应答数据

"<字段代码>": {
    "type": "TIME",
    "value": "11:30"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "11:30"
}
日期与时间 ※2DATETIME
  • 获取时的应答数据

"<字段代码>": {
    "type": "DATETIME",
    "value": "2012-01-11T11:30:00Z"
}
・【YYYY-MM-DD】和【HH:MM:SS】之间的【T】为固定值。 

・【HH:MM:SS】之后的【Z】为固定值,表示UTC。

・通过JST指定时,需按照ISO8601的格式指定如下。

  2012-01-11T11:30:00+08:00
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "2012-01-11T11:30:00Z"
}

・【YYYY-MM-DD】和【HH:MM:SS】之间的【T】为固定值。 
・【HH:MM:SS】之后的【Z】为固定值,表示UTC。

"<字段代码>": {
    "value": "2012-01-11T11:30:00+08:00"
}
・需使用【±HH:MM】指定与UTC的时差
选择用户USER_SELECT
  • 获取时的应答数据(域名的用户)

"<字段代码>": {
    "type": "USER_SELECT",
    "value": [
        {
            "code": "zhou",
            "name": "zhou shijie"
        },
        {
            "code": "chen",
            "name": "chen fei"
        }
    ]
}

来宾用户的情况

"<字段代码>": {
    "type": "USER_SELECT",
    "value": [
        {
            "code": "guest/zhou@cybozu.cn",
            "name": "zhou shijie"
        },
        {
            "code": "guest/zhou@cybozu.cn",
            "name": "zhou shijie"
        }
    ]
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": [
        {
            "code": "zhou"
        },
        {
            "code": "chen"
        }
    ]
}
类别 ※3CATEGORY
  • 获取时的应答数据

"<字段名称>": {
    "type": "CATEGORY",
    "value": [
        "category1",
        "category2"
    ]
}
  • 无法使用添加/更新时的请求数据进行添加/更新。

状态 ※3STATUS
  • 获取时的应答数据

"<字段名称>": {
    "type": "STATUS",
    "value": "未处理"
}
  • 无法使用添加/更新时的请求数据进行添加/更新。

执行者 ※3STATUS_ASSIGNEE
  • 获取时的应答数据

"<字段名称>": {
    "type": "STATUS_ASSIGNEE",
    "value": [
        {
            "code": "zhou",
            "name": "zhou shijie"
        }
    ]
}
  • 无法使用添加/更新时的请求数据进行添加/更新。

Lookup 
※3 ※5

SINGLE_LINE_TEXT

NUMBER

※根据作为key的字段的类型不同而不同。
※添加/更新时,要从关联的应用中拷贝的字段,必须设置值为唯一。

  • 获取时的应答数据

作为key的项目为SINGLE_LINE_TEXT时
"<字段代码>": {
    "type": "SINGLE_LINE_TEXT",
    "value": "Code001"
}
作为key的项目为NUMBER 时
"<字段代码>": {
    "type": "NUMBER",
    "value": "10"
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": "Code001"
}

无法使用API令牌进行添加/更新操作。

表格SUBTABLE
  • 获取时的应答数据

"<字段代码>": {
    "type": "SUBTABLE",
    "value": [
        {
            "id": "48290",
            "value": {
                "单行文本框_0": {
                    "type": "SINGLE_LINE_TEXT",
                    "value": "范例1"
                },
                "数值_0": {
                    "type": "NUMBER",
                    "value": "1"
                },
                "复选框_0": {
                    "type": "CHECK_BOX",
                    "value": [
                        "选项1"
                    ]
                }
            }
        },
        {
             "id": "48291",
             "value": {
                 "单行文本框__0": {
                     "type": "SINGLE_LINE_TEXT",
                     "value": "范例2"
                 },
                 "数值_0": {
                     "type": "NUMBER",
                     "value": "2"
                 },
                 "复选框_0": {
                     "type": "CHECK_BOX",
                     "value": [
                         "选项2"
                     ]
                 }
             }
        }
    ]
}
  • 添加/更新时的请求数据

    • 添加或更新表格时,须指定所有行的值。

    • 如指定行的 "id",则更新行的值。

    • 仅在使用JavaScript API(事件)向表格添加记录时才需要指定字段类型。请参考重写字段的值

"<字段代码>": {
    "value": [
        {
            "id": "48291", 
            "value": {
                "单行文本框__0": {
                    "value": "范例0"
                },
                "数值_0": {
                    "value": "0"
                }
            }
        },
        {
            "value": {
                "单行文本框__0": {
                    "value": "范例1"
                },
                "数值_0": {
                    "value": "1"
                }
            }
        },
        {
            "value": {
                "单行文本框_0": {
                    "value": "范例2"
                },
                "数值_0": {
                    "value": "2"
                }
            }
        }
    ]
}
选择组织字段

ORGANIZATION_SELECT

  • 获取时的应答数据

"<字段代码>": {
    "type": "ORGANIZATION_SELECT",
    "value": [
        {
            "code": "beijing",
            "name": "开发部"
        },
        {
            "code": "shanghai",
            "name": "人事部"
        }
    ]
}

添加/更新时的请求数据

"<字段代码>": {
    "value": [
        {
            "code": "beijing"
        },
        {
            "code": "shanghai"
        }
    ]
}


选择组字段

GROUP_SELECT

  • 获取时的应答数据

"<字段代码>": {
    "type": "GROUP_SELECT",
    "value": [
        {
            "code": "project_manager",
            "name": "项目负责人"
        },
        {
            "code": "team_leader",
            "name": "组长"
        }
    ]
}
  • 添加/更新时的请求数据

"<字段代码>": {
    "value": [
        {
            "code": "project_manager"
        },
        {
            "code": "team_leader"
        }
    ]
}


  • ※1 【value】中指定的值是:kintone应用的表单设置里,【项目与顺序】中设置的值。
    另外,这些字段中的选项即使已被删除,也可通过API以及CSV来指定。

  • ※2 关于日期、时间、日期与时间、创建时间、更新时间字段的格式或时区的处理请参考日期的格式

  • ※3 以下字段仅可获取值,不能添加/更新值。

    • 记录编号

    • 记录ID

    • 版本

    • 计算

    • 类别

    • 状态

    • 执行者

    • 通过Lookup输入值的字段

  • ※4 以下的字段可获取及添加值。不能更新值。

    • 创建人

    • 创建时间

    • 更新人

    • 更新时间

  • ※5 以下字段使用密码验证可以获取、添加、更新值。使用API令牌验证可获取值,但不能添加、更新值。

    • Lookup

  • 字段的值为空时,"value"的值如下。即使字段的值设为空,也要给每个字段类型设置值。
    ※单选框不能设置值为空。

  • 字段类型设置方法
    • 复选框

    • 多选

    • 附件

    • 选择用户

    • 选择组织字段

    • 选择组字段

    • 表格

    • 类别
      ※仅可获取

    "value":[]
    • 日期

    • 时间

    • 下拉菜单

    • 单选框

    "value":null
    • 单行文本框

    • 多行文本框

    • 文本编辑框

    • 数值

    • 计算

    • 链接

    • 日期与时间

    • Lookup

    • 状态
      ※仅可获取

    "value":""



    您需要登录后才可以回复