Querying Work Item Associations

Function

This API is used to query the E2E tracing graph of a specified work item and display the upstream and downstream relationships of the work item, including parent/child work items, associated documents, code branches, code commits, and test cases.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
issue_id	Yes	String	Definition Unique ID of a work item. You can obtain the value from the Querying Work Items or Querying Tree-shaped Work Items API. The value is id in the response body. Constraints N/A Range A string of 18 to 19 digits. Default Value N/A
category	Yes	String	Definition Work item type, which specifies the type of the work item to be queried. Constraints N/A Range RR: raw requirement SF: system feature IR: R&D requirement SR: system requirement AR: allocated requirement Task Bug Epic FE: feature US: user story Default Value N/A
is_src	No	Boolean	Definition Whether to query work items across projects. When the work item type is RR or Bug, set this parameter to true for querying work items in a project. Constraints N/A Range true: cross-project query false: query only in the current project Default Value false

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition Work item ID. You can obtain the value from the Querying Work Items or Querying Tree-shaped Work Items API. The value is id in the response body. Range A string of 18 to 19 digits.
project_id	String	Definition Project ID, which uniquely identifies a project. Obtain the value by calling the Querying the IPD Project List API. The value of id in the response message body is the project ID. Range UUID string of 32 characters.
belonging	String	Definition Name of the requirement space. Range N/A
category	String	Definition Work item type. Range RR: raw requirement SF: system feature IR: R&D requirement SR: system requirement AR: allocated requirement Task Bug Epic FE: feature US: user story
number	String	Definition Work item ID, which is automatically generated by the system. Range N/A
status	String	Definition Work item status. Range N/A
title	String	Definition Work item title. Range Max. 256 characters.
trace_list	Array of OpenAPIE2ETraceEntityMap objects	Definition Trace item list, including the upstream and downstream relationships of work items. Range Max. 200 trace items.

**Table 4** OpenAPIE2ETraceEntityMap
Parameter	Type	Description
associate_type	String	Definition Work item association type. Range parent_issues: associating parent work items child_issues: associating child work items associate_workitems: associating work items associate_documents: associating documents associate_branches: associating code branches associate_commits: associating code commit records associate_mergerequest: associating code merge requests associate_testcases: associating test cases associate_testplans: associating test plans wikis: associating Wikis
direction	String	Definition Association direction. Range left: upstream right: downstream
sequence	String	Definition Display sequence number of the association type. Range N/A
entities	Array of OpenAPIE2ETraceBaseEntity objects	Definition List of trace item entities under the current association type. Range Max. 200 entities.
children	Array of OpenAPIE2ETraceEntityMap objects	Definition Sub-level trace item mapping list, which is used to display multi-level associations. Range Max. 200 sub-level mappings.
count	Integer	Definition Total number of trace items of the current association type. Range 0 to 100

**Table 5** OpenAPIE2ETraceBaseEntity
Parameter	Type	Description
id	String	Definition Trace item ID. For work items, the value is a string of 18 to 19 digits. For code commits, the value is a string. Range N/A
title	String	Definition Trace item title. Range Max. 256 characters.
belonging	String	Definition Name of the requirement space to which a trace item belongs. Range N/A
project_id	String	Definition ID of the project to which the trace item belongs. Range UUID string of 32 characters.
type	String	Definition Work item type of the trace item. Range For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug.
storage_type	String	Definition Storage type, which is used for document trace items. Range local: local storage obs: OBS file library
category	String	Definition Trace item type, which is the same as the work item type. Range N/A
number	String	Definition Trace item ID (such as work item ID and code branch name). Range N/A
status	String	Definition Trace item status (only work items have status). Range N/A
commit_id	String	Definition Complete commit ID of a code commit (valid only for code commits). Range Git SHA-1 hash value.
commit_short_id	String	Definition Short commit ID (first seven characters) of a code commit. Range First seven characters of the Git SHA-1 hash value.
commit_msg	String	Definition Message of a code commit. Range Max. 512 characters.
commit_url	String	Definition URL of a code commit. Range N/A
uri	String	Definition URI of the trace item (used for external resources such as documents and Wikis). Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error description, which is a supplement to error_code. Range N/A

Example Requests

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

Example Responses

Status code: 200

{
  "status" : "Initial",
  "id" : "1121459690961543169",
  "belonging" : "YCQ_IPD_M1_0419",
  "project_id" : "58b214adfc834e0bb71c09e212759423",
  "category" : "SF",
  "number" : "SF20250422376840",
  "title" : "SF Migration Test",
  "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
  } ]
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code	Description
200	OK
400	Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: E2E Tracing of IPD Projects

Previous topic: E2E Tracing of IPD Projects

Next topic: IPD Status Management