文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD项目E2E追溯/ 查询工作项关联 - ListE2EGraphsOpenAPI
更新时间:2026-09-01 GMT+08:00
分享

查询工作项关联 - ListE2EGraphsOpenAPI

功能介绍

查询指定工作项的端到端(E2E)追溯图谱,展示工作项的上下游关联关系,包括父/子工作项、关联文档、代码分支、代码提交、测试用例等追溯信息。

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

GET /v1/ipdprojectservice/projects/{project_id}/e2e/graphs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目32位ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。

约束限制

不涉及。

取值范围

32个字符,由英文字母和数字组成。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

issue_id

String

参数解释

工作项唯一ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。

约束限制

不涉及。

取值范围

18~19个字符的数字字符串。

默认取值

不涉及。

category

String

参数解释

工作项类型,用于指定查询的工作项类别。

约束限制

不涉及。

取值范围

  • RR:原始需求

  • SF:系统特性

  • IR:研发需求

  • SR:系统需求

  • AR:分配需求

  • Task:任务

  • Bug:缺陷

  • Epic:史诗

  • FE:特性

  • US:用户故事

默认取值

不涉及

is_src

Boolean

参数解释

是否跨项目查询工作项。当工作项类型为RR或Bug时,在提出项目查询时需要设置为true。

约束限制

不涉及。

取值范围

  • true:跨项目查询

  • false:仅当前项目查询

默认取值

false

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

工作项ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。

取值范围

18~19个字符的数字字符串。

project_id

String

参数解释

项目ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。

取值范围

32个字符的UUID字符串。

belonging

String

参数解释

所属需求空间名称。

取值范围

不涉及。

category

String

参数解释

工作项类型。

取值范围

  • RR:原始需求

  • SF:系统特性

  • IR:研发需求

  • SR:系统需求

  • AR:分配需求

  • Task:任务

  • Bug:缺陷

  • Epic:史诗

  • FE:特性

  • US:用户故事

number

String

参数解释

工作项编号,系统自动生成。

取值范围

不涉及。

status

String

参数解释

工作项状态。

取值范围

不涉及。

title

String

参数解释

工作项标题。

取值范围

最大256个字符。

trace_list

Array of OpenAPIE2ETraceEntityMap objects

参数解释

追溯项列表,包含工作项的上下游关联关系。

取值范围

最多200个追溯项。

表4 OpenAPIE2ETraceEntityMap

参数

参数类型

描述

associate_type

String

参数解释

工作项关联类型。

取值范围

  • parent_issues:关联父工作项

  • child_issues:关联子工作项

  • associate_workitems:关联工作项

  • associate_documents:关联文档

  • associate_branches:关联代码分支

  • associate_commits:关联代码提交记录

  • associate_mergerequest:关联代码合入记录

  • associate_testcases:关联测试用例

  • associate_testplans:关联测试计划

  • wikis:关联Wiki

direction

String

参数解释

关联方向。

取值范围

  • left:左向关联(上游)

  • right:右向关联(下游)

sequence

String

参数解释

关联类型的显示序号。

取值范围

不涉及。

entities

Array of OpenAPIE2ETraceBaseEntity objects

参数解释

当前关联类型下的追溯项实体列表。

取值范围

最多200个实体。

children

Array of OpenAPIE2ETraceEntityMap objects

参数解释

子级追溯项映射列表,用于嵌套展示多层关联关系。

取值范围

最多200个子级映射。

count

Integer

参数解释

当前关联类型下的追溯项总数。

取值范围

0~100。

表5 OpenAPIE2ETraceBaseEntity

参数

参数类型

描述

id

String

参数解释

追溯项ID。对于工作项类型为18~19的数字,对于代码提交等为字符串标识。

取值范围

不涉及。

title

String

参数解释

追溯项标题。

取值范围

最大256个字符。

belonging

String

参数解释

追溯项归属的需求空间名称。

取值范围

不涉及。

project_id

String

参数解释

追溯项归属的项目ID。

取值范围

32个字符的UUID字符串。

type

String

参数解释

追溯项的工作项类型。

取值范围

  • 系统设备类项目:RR/SF/IR/SR/AR/Task/Bug

  • 独立软件类项目:RR/SF/IR/US/Task/Bug

  • 云服务类项目:RR/Epic/FE/US/Task/Bug

storage_type

String

参数解释

存储类型,用于文档类追溯项。

取值范围

  • local:本地存储

  • obs:OBS文件库

category

String

参数解释

追溯项类别,与工作项类型相同。

取值范围

不涉及。

number

String

参数解释

追溯项编号(如工作项编号、代码分支名等)。

取值范围

不涉及。

status

String

参数解释

追溯项状态(仅工作项类型有状态)。

取值范围

不涉及

commit_id

String

参数解释

代码提交的完整commit ID(仅代码提交类型有效)。

取值范围

Git SHA-1哈希值。

commit_short_id

String

参数解释

代码提交的短commit ID(前7位)。

取值范围

Git SHA-1哈希值的前7位。

commit_msg

String

参数解释

代码提交的消息。

取值范围

最大512个字符。

commit_url

String

参数解释

代码提交的URL链接。

取值范围

不涉及。

uri

String

参数解释

追溯项的URI地址(用于文档、Wiki等外部资源)。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v1/ipdprojectservice/projects/58b214adfc834e0bb71c09e212759423/e2e/graphs?issue_id=1121459690961543169&category=SF

响应示例

状态码:200

OK

{
  "status" : "初始",
  "id" : "1121459690961543169",
  "belonging" : "YCQ_IPD_M1_0419",
  "project_id" : "58b214adfc834e0bb71c09e212759423",
  "category" : "SF",
  "number" : "SF20250422376840",
  "title" : "SF迁移测试",
  "trace_list" : [ {
    "associate_type" : "associate_documents",
    "direction" : "right",
    "sequence" : 7,
    "entities" : [ ],
    "children" : [ ],
    "count" : 0
  }, {
    "associate_type" : "child_issues",
    "direction" : "right",
    "sequence" : 4,
    "entities" : [ ],
    "children" : [ ],
    "count" : 0
  }, {
    "associate_type" : "wikis",
    "direction" : "right",
    "sequence" : 8,
    "entities" : [ ],
    "children" : [ ],
    "count" : 0
  }, {
    "associate_type" : "associate_workitems",
    "direction" : "right",
    "sequence" : 6,
    "entities" : [ ],
    "children" : [ {
      "associate_type" : "Task",
      "direction" : "right",
      "sequence" : 8,
      "entities" : [ ],
      "children" : [ ],
      "count" : 0
    }, {
      "associate_type" : "RR",
      "direction" : "right",
      "sequence" : 1,
      "entities" : [ ],
      "children" : [ ],
      "count" : 0
    } ],
    "count" : 0
  }, {
    "associate_type" : "associate_testcases",
    "direction" : "right",
    "sequence" : 9,
    "entities" : [ ],
    "children" : [ ],
    "count" : 0
  } ]
}

状态码:400

请求失败的响应。例如无操作权限、项目不存在。

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

状态码

状态码

描述

200

OK

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码

相关文档