飞书项目帮助中心Appearance
获取工作流详情
请求体说明
| 类别 | 值 |
|---|---|
| 请求地址 | {base_url}/open_api/:project_key/work_item/:work_item_type_key/:work_item_id/workflow/query |
| 请求方式 | POST |
请求 Header
| 字段 | 值 | 必须填写 |
|---|---|---|
| Content-Type | application/json | 必须 |
| X-PLUGIN-TOKEN | 用户在开放平台中获取的 Token，参考插件身份凭证章节。 | 必须 |
| X-USER-KEY | 当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取 | 可选 |
| X-IDEM-UUID | 写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断 | 可选 |
参考请求格式如下：
curl --location -g --request GET '{base_url}/open_api/:project_key/work_item/:work_item_type_key/query' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''
路径参数
| 参数名 | 是否必填 | 值类型 | 说明 |
|---|---|---|---|
| project_key | 是 | string | 空间id [project_key]，或者空间域名 [simple_name] |
| work_item_type_key | 是 | string | 工作项类型，可以从获取工作项类型接口获取。 |
| work_item_id | 是 | int64 | 工作项 ID |
请求参数
| 参数名 | 是否必填 | 值类型 | 说明 |
|---|---|---|---|
| flow_type | 否 | list[int64] | 工作流类型： 0：节点流，节点流工作项举例：需求等 1 ：状态流，状态流工作项举例：缺陷、版本等 非必填，默认为 0（节点流） |
| fields | 否 | list[string] | 定义需要返回的字段，非必填，默认返回全部，如果 fields 以-开头，表示返回除 - 号后字段中的所有字段，否则只返回 fields 中的字段，两种方式不能混用。如： ["name","created_at"]表示只返回 name 和created_at字段， ["-name","-created_at"]表示返回除name和created_at外的所有字段 |
请求体格式
{
"flow_type":0
}
返回值类型
NodesConnections
返回格式
{
{//节点流
"data":{
"workflow_nodes":[
{
"id":"started",//节点id
"state_key": "started",
"name":"flowNode1",//节点名称
"status":2,//节点状态，状态映射对应表
"actual_begin_time": "2021-12-27T08:21:51.892Z",//节点实际开始时间
"actual_finish_time": "2021-12-27T08:21:51.892Z",//节点实际结束时间
"fields":[//节点表单字段
{
"field_alias": "sentry_link",
"field_key": "field_658c22",
"field_type_key": "text",
"field_value": "23333"
}
],
"owners":[//节点负责人的user_key列表
"7009146719661228031",
"7009146719661228032"
],
"role_assignee": [//节点绑定的角色负责人(未绑定角色时不返回)
{
"owners": [],
"role": "PM"
}
],
"node_schedule":{//节点总排期
"owners":[
"7009146719661228031",
"7009146719661228032"
],
"estimate_start_date":1633776613033,
"estimate_end_date":1633776813033,
"points":10.4
},
"schedules":[//差异化排期，非差异化排期时不展示
{
"owners":[
"7009146719661228031"
],
"estimate_start_date":1633776613033,
"estimate_end_date":1633776813033,
"points":10.4
},
{
"owners":[
"7009146719661228032"
],
"estimate_start_date":1633776613034,
"estimate_end_date":1633776813035,
"points":10.4
}
],
"sub_tasks":[//节点子任务
{
"id":"1",//子任务id
"name":"子任务1",//子任务名称
"schedules":[//子任务排期
{
"owners":[
"7009146719661228031",
"7009146719661228032"
],
"estimate_start_date":1633776613033,
"estimate_end_date":1633776813033,
"points":10.4
}
],
"order":1.2,//子任务顺序
"details":"详情abc",//子任务备注
"passed":false,//是否通过
"owners":[
"7009146719661228031",
"7009146719661228032"
]
}
]
}
],
"connections":[//节点上下游信息
{
"source_state_key":"70091467196612280",
"target_state_key":"70091467196612281"
}
]
},
"err": {},
"err_msg": "",
"err_code": 0
}
{//状态流
"data": {
"connections": [//状态上下游信息
{
"source_state_key": "OPEN",//源状态key
"target_state_key": "IN PROGRESS",//目标状态key
"transition_id": 145962//流转id
},
{
"source_state_key": "OPEN",
"target_state_key": "RESOLVED",
"transition_id": 145963
},
{
"source_state_key": "IN PROGRESS",
"target_state_key": "RESOLVED",
"transition_id": 145964
},
{
"source_state_key": "RESOLVED",
"target_state_key": "REOPENED",
"transition_id": 145965
},
{
"source_state_key": "RESOLVED",
"target_state_key": "CLOSED",
"transition_id": 145966
},
{
"source_state_key": "REOPENED",
"target_state_key": "IN PROGRESS",
"transition_id": 145967
},
{
"source_state_key": "REOPENED",
"target_state_key": "RESOLVED",
"transition_id": 145968
},
{
"source_state_key": "CLOSED",
"target_state_key": "REOPENED",
"transition_id": 145969
}
],
"state_flow_nodes": [
{
"actual_begin_time": "",//状态实际开始时间
"actual_finish_time": "",//状态实际结束时间
"fields": [],
"id": "IN PROGRESS",//状态key
"name": "IN PROGRESS",//状态名称
"role_owners": [//状态负责角色及人员
{
"owners": [],
"role": "operator"
}
],
"status": 1
},
{
"actual_begin_time": "",
"actual_finish_time": "",
"fields": [],
"id": "RESOLVED",
"name": "RESOLVED",
"role_owners": [
{
"owners": [],
"role": "reporter"
}
],
"status": 2
},
{
"actual_begin_time": "",
"actual_finish_time": "",
"fields": [],
"id": "REOPENED",
"name": "REOPENED",
"role_owners": [
{
"owners": [],
"role": "operator"
}
],
"status": 3
},
{
"actual_begin_time": "",
"actual_finish_time": "",
"fields": [],
"id": "CLOSED",
"name": "CLOSED",
"role_owners": [
{
"owners": [],
"role": "reporter"
}
],
"status": 1
},
{
"actual_begin_time": "2021-12-14T21:43:52.012Z",
"actual_finish_time": "",
"fields": [
{
"field_alias": "description",
"field_key": "description",
"field_type_key": "multi_text",
"field_value": "\"测试\\n2333\"",
"target_state": {
"state_key": "IN PROGRESS",
"transition_id": 145962
}
}
],
"id": "OPEN",
"name": "OPEN",
"role_owners": [
{
"owners": [],
"role": "operator"
}
],
"status": 2
}
]
},
"err": {},
"err_code": 0,
"err_msg": ""
}
WBS
工作分解结构 (Work breakdown structure)
请求体说明
| 类别 | 值 |
|---|---|
| 请求地址 | {base_url}/open_api/:project_key/work_item/:work_item_type_key/:work_item_id/wbs_view |
| 请求方式 | GET |
请求 Header
| 字段 | 值 | 必须填写 |
|---|---|---|
| Content-Type | application/json | 必须 |
| X-PLUGIN-TOKEN | 用户在开放平台中获取的 Token，参考插件身份凭证章节。 | 必须 |
| X-USER-KEY | 当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取 | 可选 |
| X-IDEM-UUID | 写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断 | 可选 |
参考请求格式如下：
curl --location -g --request GET '{base_url}/open_api/:project_key/work_item/:work_item_type_key/query' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''
路径参数
| 参数名 | 是否必填 | 值类型 | 说明 |
|---|---|---|---|
| project_key | 是 | string | 空间id [project_key]，或者空间域名 [simple_name] |
| work_item_type_key | 是 | string | 工作项类型，可以从获取工作项类型接口获取。 |
| work_item_id | 是 | int64 | 工作项 ID |
返回值类型
WbsViewResponse
返回格式
{
"err_code":0,
"data":{
"template_key":"123123123",//使用的模板key
"related_sub_work_items":[//关联子工作项
{
"node_uuid":"1",//节点uuid
"work_item_id":"2",//工作项id
"type":"node",//节点类型(节点node、子任务sub_task、子工作项sub_workitem)
"name": "开始",//节点名称
"wbs_status_map": {//wbs状态映射信息
"status_key": "not_started",
"status_name": "未开始"
},
"sub_wbs_work_item":[
{
"deliverable": [//交付物(里面就是个复合字段)
{
"field_key": "field_b46006",
"field_value": [
[
{
"field_key": "field_cf394a",
"field_value": "2323"
},
{
"field_key": "field_db2cd2",
"field_value": "4545"
},
{
"field_key": "field_ec3f89",
"field_value": "rd"
}
]
]
}
],
"name": "任务1",
"node_uuid":"3",
"work_item_id":"4",
"type":"sub_task",
"wbs_status_map": {
"status_key": "not_started",
"status_name": "未开始"
}，
"sub_work_item": []
}
],
}
],
},
"err_msg":""
}