飞书项目(Meegle)API 文档社区版
首页飞书项目插件管理Node.js SDK
首页飞书项目插件管理Node.js SDK
  1. 流程与节点
  • 插件相关
    • 获取plugin_token
      POST
    • 获取code
      POST
    • 获取user_plugin_token
      POST
    • 刷新token
      POST
  • 附件
    • 添加附件
      POST
    • 文件上传
      POST
    • 下载附件
      POST
    • 删除附件
      POST
  • 空间
    • 获取空间列表
      POST
    • 获取空间详情
      POST
    • 获取空间下业务线详情
      GET
    • 获取空间下工作项类型
      GET
    • 获取空间下团队成员
      GET
  • 用户
    • 获取用户详情
      POST
    • 搜索租户内的用户列表
      POST
    • 创建自定义用户组
      POST
    • 更新用户组成员
      PATCH
    • 查询用户组成员
      POST
  • 空间关联
    • 获取空间关联规则列表
      POST
    • 获取空间关联下的关联工作项实例列表
      POST
    • 绑定空间关联的关联工作项实例
      POST
    • 解绑空间关联的关联工作项实例
      DELETE
  • 工作项实例搜索
    • 获取指定的工作项列表(单空间)
    • 获取指定的工作项列表(跨空间)
    • 获取指定的工作项列表(单空间-复杂传参)
    • 获取指定的工作项列表(全局搜索)
    • 获取指定的关联工作项列表(单空间)
  • 工作项实例读写
    • 评审管理
      • 批量查询评审意见、评审结论
      • 修改评审结论和评审意见
      • 评审结论标签值查询
    • 工作项工时
      • 获取工作项的工时记录列表
      • 创建实际工时
      • 更新实际工时
      • 删除实际工时
    • 创建工作项资源库
    • 交付物信息批量查询(WBS)
    • 工作项冻结/解冻
    • 获取工作项详情
    • 获取创建工作项元数据
    • 创建工作项
    • 更新工作项
    • 批量更新工作项字段值
    • 获取批量更新处理进度
    • 删除工作项
    • 终止/恢复工作项
    • 获取工作项操作记录
  • 工作项配置
    • 字段配置
      • 获取字段信息
      • 创建自定义字段
      • 更新自定义字段
    • 关系配置
      • 获取工作项关系列表
      • 新增工作项关系
      • 更新工作项关系
      • 删除工作项关系
    • 获取工作项基础信息配置
    • 更新工作项基础信息配置
  • 流程与节点
    • 获取指定节点/状态流转所需必填信息
      POST
    • 获取工作流详情
      POST
    • 获取工作流详情(WBS)
      GET
    • 更新节点/排期
      PUT
    • 节点完成/回滚
      POST
    • 状态流转
      POST
  • 流程配置
    • 获取工作项下的流程模板列表
    • 获取流程模板配置详情
    • 新增流程模板
    • 更新流程模板
    • 删除流程模板
  • 角色与人员配置
    • 获取流程角色配置详情
  • 子任务
    • 获取指定的子任务列表(跨空间)
    • 获取子任务详情
    • 创建子任务
    • 更新子任务
    • 子任务完成/回滚
    • 删除子任务
  • 视图
    • 获取视图列表及配置信息
    • 获取视图下工作项列表
    • 获取视图下工作项列表(全景视图)
    • 创建固定视图
    • 更新固定视图
    • 创建条件视图
    • 更新条件视图
    • 删除视图
  • 评论
    • 添加评论
    • 查询评论
    • 更新评论
    • 删除评论
  • 群组
    • 拉机器人入群
  • 度量
    • 获取度量图表明细数据
  1. 流程与节点

获取工作流详情

POST
/open_api/{project_key}/work_item/{work_item_type_key}/{work_item_id}/workflow/query
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/open_api//work_item///workflow/query' \
--header 'X-PLUGIN-TOKEN: {{plugin_token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"fields": [""],
	"flow_type": 0,
	"expand": {
	"need_workflow": true,
	"relation_fields_detail": true,
	"need_multi_text": true,
	"need_user_detail": true,
	"need_sub_task_parent": true
}
}'
响应示例响应示例
200 - 节点流 - 示例 1
{ //节点流
    "data": {
        "template_id": 267706, //模版ID
        "version": 41, //模版版本
        "workflow_nodes": [ //工作流中各个节点的详细信息
            {
                "id": "started", //节点id
                "state_key": "started", //节点key,和节点id相同,两者可等价使用
                "name": "flowNode1", //节点名称
                "status": 2, //节点状态,1:未开始,2:进行中,3:已完成,详见WFState.status
                "actual_begin_time": "2024-05-19T14:38:13.019Z", //节点实际开始时间
                "actual_finish_time": "2024-05-29T14:38:13.021Z", //节点实际结束时间
                "fields": [ //节点表单字段
                    {
                        "field_alias": "sentry_link", //字段对接标识
                        "field_key": "field_658c22", //字段key
                        "field_type_key": "text", //字段类型
                        "field_value": "23333" //字段值
                    }
                ],
                "owners": [ //节点负责人的user_key列表
                    "7009146719661228031",
                    "7009146719661228032"
                ],
                "owner_usage_mode": 1, // 节点负责人分配模式,1=自行添加(不限范围/限制范围),2=与角色联动
                "role_assignee": [ //体现实例侧角色配置情况
                    {
                        "role": "DA",
                        "owners": [
                            "735679528XXXXXX7476"
                        ], // 人员未填时会返回
                        "exist": true // 该角色在当前实例上是否存在
                    }
                ],
                "owner_roles": [ // 节点负责人范围或者关联的角色,当mode=1且该值为空,意味着负责人分配方式是自动添加,无范围限制
                    "DA"
                ],
                "node_schedule": { //节点总排期
                    "owners": [ //负责人 user_key 数组
                        "7009146719661228031",
                        "7009146719661228032"
                    ],
                    "estimate_start_date": 1724169600000, // 预计开始时间(毫秒时间戳,精确到天,开始时间为00:00:00)
                    "estimate_end_date": 1724428799999, // 预计结束时间(毫秒时间戳,精确到天,结束时间为23:59:59)
                    "points": 10.4 // 估分
                },
                "schedules": [ //不同用户的排期数组(仅在差异化排期时有值)
                    {
                        "owners": [
                            "7009146719661228031"
                        ],
                        "estimate_start_date": 1724169600000, // 预计开始时间(毫秒时间戳,精确到天,开始时间为00:00:00)
                        "estimate_end_date": 1724428799999, // 预计结束时间(毫秒时间戳,精确到天,结束时间为23:59:59)
                        "points": 10.4 //估分
                    },
                    {
                        "owners": [
                            "7009146719661228032"
                        ],
                        "estimate_start_date": 1724169600000, // 预计开始时间(毫秒时间戳,精确到天,开始时间为00:00:00)
                        "estimate_end_date": 1724428799999, // 预计结束时间(毫秒时间戳,精确到天,结束时间为23:59:59)
                        "points": 10.4 //估分
                    }
                ],
                "sub_tasks": [ //节点子任务,详见SubTask
                    {
                        "id": "1", //子任务id
                        "name": "子任务1", //子任务名称
                        "schedules": [ //子任务排期
                            {
                                "owners": [
                                    "7009146719661228031",
                                    "7009146719661228032"
                                ],
                                "estimate_start_date": 1724169600000, // 预计开始时间(毫秒时间戳,精确到天,开始时间为00:00:00)
                                "estimate_end_date": 1724428799999, // 预计结束时间(毫秒时间戳,精确到天,结束时间为23:59:59)
                                "points": 10.4
                            }
                        ],
                        "owner_usage_mode": 2, // 子任务负责人分配模式,1=自行添加(不限范围/限制范围),2=与角色联动
                        "owner_roles": [ // 子任务负责人范围或者关联的角色,当mode=1且该值为空,意味着负责人分配方式是自动添加,无范围限制
                            "DA"
                        ],
                        "role_assignee": [
                            {
                                "role": "DA",
                                "owners": [
                                    "7356795280408297476"
                                ], // 人员未填时会返回
                                "exist": true // 该角色在当前实例上是否存在
                            }
                        ],
                        "order": 1.2, //子任务顺序
                        "details": "详情abc", //子任务备注
                        "passed": false, //是否通过
                        "owners": [
                            "7009146719661228031",
                            "7009146719661228032"
                        ]
                    }
                ]
            }
        ],
        "connections": [ //节点上下游信息,详见Connection
            {
                "source_state_key": "70091467196612280", //开始节点id
                "target_state_key": "70091467196612281" //目标节点id
            }
        ]
    },
    "err": {},
    "err_msg": "",
    "err_code": 0
}

请求参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200节点流
application/json
Body

🟢200状态流
修改于 2025-07-11 06:57:15
上一页
获取指定节点/状态流转所需必填信息
下一页
获取工作流详情(WBS)
Built with