Skip to content
页面导航

字段与属性解析格式

API 统一了用户创建和查询的字段格式,以属性和字段的方式进行描述。

  • 属性:作为工作项的原始信息展示,不以field的方式进行暴露,主要是平台-字段管理页面的系统字段以及内置基础字段。
  • 字段:区别于原始信息,作为通用的field方式使用,平台-字段管理页面的部分系统字段和用户自定义字段。

系统字段和用户自定义字段均可通过查询空间字段接口查询字段的配置信息。

属性

属性名
含义
value数据格式
id
工作项id
int,64位
name
工作项名称
string
work_item_status
工作项状态
{//出参格式
"state_key": "xxx", // 状态
"is_archived_state": true, // 是否是归档状态
"is_init_state": false, // 是否是初始状态
"updated_at": 111111111, // 更新时间戳,毫秒精度
"updated_by": "" // 更新人
}
{//入参格式
"state_key": "xxx", // 状态
}
template_id
工作项模板id
int,64位
template_type
工作项模板类型
string
sub_stage
需求当前状态
string
project_key
空间key
string
work_item_type_key
工作项类型
string
pattern
工作项模式
string
current_nodes
当前节点
[{
"id": "", // 节点id
"name": "", // 节点名
"owners": [""] // 节点人员
}]
created_by
创建者
string
updated_by
更新者
string
deleted_by
删除者
string
created_at
创建时间
int时间戳,毫秒精度,64位
updated_at
更新时间
int时间戳,毫秒精度,64位
deleted_at
删除时间
int时间戳,毫秒精度,64位

字段

字段类型
含义
value数据格式
text
文本
string
link
链接
string
date
时间
int时间戳,毫秒精度,64位
schedule
排期
{
"start_time": 111, // int时间戳,毫秒精度
"end_time": 222, // int时间戳,毫秒精度
}
number
数字
float
work_item_related_select
关联工作项
int,工作项id,64位
work_item_related_multi_select
多选关联工作项
int列表,工作项id列表,64位
signal
信号
bool,已通过:true,未通过:false,处理中:null
bool
布尔
bool
radio
单选按钮
{//出参格式
"label": "",
"value": ""
}
{//入参格式
"value": ""
}
select
单选
{//出参格式
"label": "",
"value": ""
}
{//入参格式
"value": ""
}
multi_select
多选
[{//出参格式
"label": "",
"value": ""
}]
[{//入参格式
"value": ""
}]
tree_select
级联单选
{//出参格式
"label": "",
"value": "",
"children": {
"label": "",
"value": "",
"children": {} // 嵌套结构
}
}
{//入参格式
"value": "",
"children": {
"value": "",
"children": {} // 嵌套结构
}
}
tree_multi_select
级联多选
[{//出参格式
"label": "",
"value": "",
"children": {
"label": "",
"value": "",
"children": {} // 嵌套结构
}
}]
[{//入参格式
"value": "",
"children": {
"value": "",
"children": {} // 嵌套结构
}
}]
user
人员
string,人员userkey
multi_user
多选人员
string列表,人员userkey列表
compound_field
复合字段
复合字段value是一个列表,每个列表项为一个复合字段的子字段实例列表
[
[{// 子字段实例1
"field_key": "", // 子字段key
"value": 字段类型对应的数据格式,
"field_type_key": "", // 子字段类型
"field_alias": "" // 子字段对接标识
},
{// 子字段实例2
"field_key": "", // 子字段key
"value": 字段类型对应的数据格式,
"field_type_key": "", // 子字段类型
"field_alias": "" // 子字段对接标识
}], // 第一个子字段列表实例
[{
"field_key": "", // 子字段key
"value": 字段类型对应的数据格式,
"field_type_key": "", // 子字段类型
"field_alias": "" // 子字段对接标识
},
{
"field_key": "", // 子字段key
"value": 字段类型对应的数据格式,
"field_type_key": "", // 子字段类型
"field_alias": "" // 子字段对接标识
}], // 第二个子字段列表实例
]
multi_text
富文本
string
file
文件
{
"name": "",
"type": "",
"size": "",
"uid": "",
"url": "",
}
aborted
终止
{
"reason": "",
"is_aborted": true,
}
deleted
删除
bool
role_owners
角色人员
[{
"owners": [""],
"role": "",
}]
linked_work_item
关联工作项
{
"wi_object_id": 111,
"id": 111,
"type": "",
"name": ""
}
business
业务线
string
chat_group
群id
string
group_id
群id
string
group_type
拉群方式
string,自动拉群:"auto";不拉群:"disabled";绑定群:"bind";更新和创建时暂不支持绑定现有群
work_item_template
模板类型
{
"id":12345,
"version":11
}

常见FAQ

关注人(watchers)字段属于什么类型

关注人属于多选人员(multi_user),类似字段可以参考字段管理页面的字段类型