飞书项目帮助中心

Appearance

Return to top
页面导航

数据结构汇总

RoleOwner

字段
类型
说明
role
string
角色id
name
string
名称，作为请求参数非必填
owners
list<string>
负责人user_key数组

Schedule

字段
类型
说明
owners
list<string>
负责人user_key数组，作为请求参数且更新差异化排期时必填，其余接口填了不识别
estimate_start_date
int64
估计开始时间戳，精度毫秒（不填默认排期起始时间为空）
estimate_end_date
int64
估计结束时间戳，精度毫秒（不填默认排期结束时间为空）
points
float64
排期估分，选填

Business

字段
类型
说明
id
string
业务线id
name
string
业务线名称
project
string
所属空间id
labels
list<string>
标签数组
role_owners
Map<string, RoleOwner>
默认角色及负责人，Map的key为角色标识（RoleOwner.role）
watchers
list<string>
默认的关注者数组
order
float64
排序字段
super_masters
list<string>
管理员数组
parent
string
父级业务线id
disabled
bool
是否弃用
level_id
int
层级id，最顶层为1，子节点层级id等于父节点层级id+1

WbsViewResponse

字段
类型
说明
template_key
string
模板key
related_sub_work_items
子工作项数组

WBSWorkItem

字段
类型
说明
node_uuid
string
子节点ID
work_item_id
int64
子工作项ID,
不是子工作项 - 该字段不返回
type
string
子工作项类型 node/sub_workitem/sub_task
wbs_status
string
子工作项所属状态, 就是泳道图中的状态
sub_work_item
子工作项数组 当且仅当type="node","sub_workitem"该字段有值
name
string
子工作项名称
deliverable
交付物
wbs_status_map
map<string, string>
wbs状态映射<status_key,status_name>
schedule
非差异化排期
schedules
list<Schedule>
差异化排期
points
float64
估分
role_owners
list<RoleOwner>
角色负责人

FieldValuePair

字段
类型
说明
field_key
string
字段key，作为请求参数和field_alias二选一必填
field_alias
string
字段对接标识，作为请求参数和field_key二选一必填
field_value
Object
字段值，作为请求参数必填
field_type_key
string
字段类型，作为请求参数非必填
target_state
指代流转至该目标状态需要填写对应字段，状态流使用，作为请求参数非必填

TargetState

字段
类型
说明
state_key
string
目标状态key
transition_id
int64
流转到目标状态的id

WorkItemKeyType

字段
类型
说明
type_key
string
工作项类型key
name
string
工作项类型的名称

WorkItemInfo

字段
类型
说明
id
int64
工作项的id
name
string
工作项的名称
work_item_type_key
string
工作项类型key
project_key
string
所属空间id
template_id
int64
模板id
template_type
string
模板类型
pattern
string
工作项模式,分为节点模式(Node)/状态模式(State)
sub_stage
string
当前阶段状态(仅需求)
current_nodes
当前节点信息（状态模式节点为空）
created_by
string
创建人user_key
updated_by
string
更新人user_key
deleted_by
string
删除人user_key
created_at
int64
创建时间戳，毫秒精度
updated_at
int64
更新时间戳，毫秒精度
deleted_at
int64
删除时间戳，毫秒精度
fields
工作项的其他字段
work_item_status
WorkItemStatus
工作项状态(除需求外)
workflow_infos
工作项节点流信息(仅在获取工作项详情接口指定了额外参数时返回)
state_times
list<StateTime>
节点时间

WorkItemStatus

字段
类型
说明
state_key
string
状态key（作为搜索参数时只需传入该字段）
is_archived_state
bool
状态是否到达
is_init_state
bool
是否初始状态
updated_at
int64
状态更新时间，毫秒精度
updated_by
string
状态更新人user_key

NodeBasicInfo

字段
类型
说明
id
string
节点id
name
string
节点名称
owners
list<string>
负责人user_key 数组

PagedWorkItemIds

字段
类型
说明
work_item_ids
list<int64>
工作项id列表
page_num
int64
当前页码
page_size
int64
当前页大小
total
int64
匹配的工作项总数

NodesConnections

字段
类型
说明
workflow_nodes
工作项下的工作流节点数组
connections
工作项下的连接数组
stateflow_nodes
工作项下的状态流节点数组

WorkflowNode

字段
类型
说明
id
string
节点id
state_key
string
节点key
name
string
节点名称
status
int
节点状态,见"WFState.status对应表"
fields
工作项的其他字段
owners
list<string>
负责人user_key数组
node_schedule
节点总排期
schedules
list<Schedule>
不同用户的排期数组（仅在差异化排期时有值）
sub_tasks
list<SubTask>
子任务数组
actual_begin_time
string
实际开始时间
actual_finish_time
string
实际结束时间
role_assignee
list<RoleOwner>
节点绑定的角色负责人(未绑定角色时不返回)

Connection

字段
类型
说明
source_state_key
string
开始节点的key
target_state_key
string
结束节点的key
transition_id
int64
状态流转id，仅状态流返回

SubTask

字段
类型
说明
id
string
任务id
name
string
任务名称
schedules
list<Schedule>
排期数组
order
double
排序字段
passed
bool
是否通过
owners
list<string>
负责人user_key数组
note
string
备注
actual_begin_time
string
创建时间
actual_finish_time
string
完成时间
assignee
list<string>
子任务负责人userKey列表，节点负责人类型为非角色负责人时可用
role_assignee
list<RoleOwner>
子任务角色负责人列表，节点负责人类型为角色负责人时可用
deliverable
交付物

StateFlowNode

字段
类型
说明
id
string
状态id
name
string
状态名称
status
int
状态节点的状态,见"WFState.status对应表"
owners
list<RoleOwner>
负责人
fields
字段
actual_begin_time
string
状态开始时间
actual_finish_time
string
状态结束时间

SimpleField

字段
类型
说明
field_key
string
字段key
field_alias
string
字段对接标识
field_type_key
string
字段类型
field_name
string
字段名称
is_custom_field
bool
是否自定义字段
is_obsoleted
bool
字段是否废弃
options
list<Option>
选项
compound_fields
复合字段

Option

字段
类型
说明
label
string
选项标签
value
string
选项值
children
list<Option>
子选项

Comment

字段
类型
说明
id
int
评论id
work_item_id
int
评论所属工作项id
work_item_type_key
string
评论所属工作项类型
created_at
int
评论创建时间，毫秒精度
operator
string
评论人
content
string
评论内容

Project

字段
类型
说明
project_key
string
空间id
name
string
空间名
simple_name
string
空间路由名
administrators
list<string>
空间管理员 userkey 列表（仅管理员可见）

FixView

字段
类型
说明
view_id
string
视图ID
name
string
视图名称
created_by
string
创建人user_key
created_at
int
创建时间，毫秒精度
modified_by
string
最后一次修改人user_key
work_item_id_list
list<int>
固定视图包含的工作项ID列表
editable
bool
当前视图是否可编辑

TimeInterval

字段
类型
说明
start
int64
开始时间，毫秒精度
end
int64
结束时间，毫秒精度

NodeTask

字段
类型
说明
id
string
节点id
state_key
string
节点key
sub_tasks
list<SubTask>
节点下子任务列表

ViewConf

字段
类型
说明
view_id
string
视图id
view_url
string
视图url
name
string
视图名称
view_type
int64
视图类型(条件、固定)
Unknow = 0
Condition = 1 //条件视图
Fixed = 2 //固定视图
auth
int64
是否开放权限
Open = 1 //开放权限开关 开
Close = 2 //开放权限开关 关
system_view
int64
是否系统视图
True = 1 //系统视图
False = 2 //不是系统视图
collaborators
list<string>
协作者
created_at
int64
创建时间
created_by
string
创建者

TemplateConf

字段
类型
说明
template_id
string
流程模板id
template_name
string
流程模板名称
is_disabled
int64
是否禁用
True = 1 //禁用
False = 2 //启用
version
int64
当前版本号
unique_key
string
唯一键，仅查询需求时有值

FieldConf

字段
类型
说明
is_required
int64
展现为必填、非必填、条件必填，若为条件必填，则展示为条件必填，具体条件用户自行到空间查看
Required = 1 //必填
NoRequired = 2 //非必填
CondRequired=3 //条件必填
is_visibility
int64
是否可见，只有默认可见和某条件下可见，条件可见需用户到空间查看
Visibility = 1 //可见
CondVisibility =2 //条件可见
is_validity
int64
有效性
True = 1 //有效
False = 2 //无效
role_assign
字段是role_owners，展现角色出现方式
field_name
string
字段名称
field_key
string
字段key
field_type_key
string
字段类型 开放能力-字段&属性解析格式 文档里没有的和field_key一致
default_value
默认值
label
string
表单项名称
options
选项
compound_fields
list<FieldConf>
复合字段

RoleAssign

字段
类型
说明
role
string
角色ID
name
string
角色名称
default_appear
int64
展现“默认出现”“默认不出现”“条件出现”，则展示为条件出现，具体条件用户自行到空间查看
Appear = 1 //默认出现
NoAppear = 2 //默认不出现
CondAppear = 3 //条件出现
deletable
int64
是否可删除
CanDeleted = 1 //可删除
NoDeleted = 2 //不可删除
member_assign
int64
成员分配方式，“自行添加”“默认分配为指定人员”，“默认分配为创建者”“条件分配”，具体条件用户自行到空间查看
CanAdded = 1 //自行添加
DefaultUser = 2 //指定人员
DefaultCreator = 3 //指定为创建者
CondAssign = 4 //条件分配
members
list<string>
默认出现的成员列表

DefaultValue

字段
类型
说明
default_appear
int64
展现“默认出现”“默认不出现”“条件出现”，则展示为条件出现，具体条件用户自行到空间查看
Appear = 1 //默认出现
NoAppear = 2 //默认不出现
CondAppear = 3 //条件出现
value
interface{}

OptionConf

字段
类型
说明
label
string
选项标签
value
string
选项值
is_visibility
int64
是否可见，只有默认可见和某条件下可见，条件可见需用户到空间查看
Visibility = 1 //可见
CondVisibility = 2 //条件可见
is_disabled
int64
是否禁用
True = 1 //禁用
False = 2 //启用
children
子选项

ExPand

字段
类型
说明
need_workflow
bool
是否需要返回工作流信息(仅工作流模式可以使用)

StateTime

字段
类型
说明
state_key
string
节点key
start_time
int64
节点开始时间
end_time
int64
节点结束时间
name
string
节点名称

SearchUser

字段
类型
说明
user_keys
list<string>
需要查询的用户user_key列表 (field_key和role都不传的时候，仅支持查询角色中包含指定人员的需求-无需传参角色，可查询所有角色下包含传参人员的工作项）
field_key
string
指定的时候，查询该人员字段key包含指定人员的工作项， (只支持查创建人、关注人、经办人、报告人)
role
string
指定的时候，查询指定角色id包含指定人员的工作项

SearchParam

字段
类型
说明
param_key
string
字段名称
value
interface{}
搜索字段值结构
operator
string
操作符类型，枚举

SearchGroup

字段
类型
说明
search_params
固定参数
conjunction
string
枚举 And，Or
search_groups
筛选组