Help Center/ CodeArts Req/ API Reference/ APIs/ Work Items of the Scrum Project/ Queries the work items associated with the current work item.

Updated on 2023-06-12 GMT+08:00

View PDF

Queries the work items associated with the current work item.

Function

URI

GET /v4/projects/{project_id}/issues/{issue_id}/associated-issues

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32
issue_id	Yes	Integer	Work Item ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page
offset	No	Integer	Offset

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
issues	Array of AssociateIssueDetail objects	Associated Work Item List
total	Integer	Total

**Table 5** AssociateIssueDetail
Parameter	Type	Description
subject	String	Indicates the title of the work item.
issue_id	Integer	Work Item ID
project	SimpleProject object
user	SimpleUser object
status	StatusVo object	Status

**Table 6** SimpleProject
Parameter	Type	Description
project_name	String	Project name
project_id	String	Project ID

**Table 7** SimpleUser
Parameter	Type	Description
user_num_id	Integer	User ID
user_id	String	Indicates the user UUID.
user_name	String	Account name
nick_name	String	Nickname of the user.

**Table 8** StatusVo
Parameter	Type	Description
id	String	Identifies a status.
name	String	Value of the status ID.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

GET https://{endpoint}/v4/projects/{project_id}/issues/{issue_id}/associated-issues

Example Responses

Status code: 200

{
  "issues" : [ {
    "subject" : "demo",
    "issue_id" : 1234,
    "project" : {
      "project_name" : "demo",
      "project_id" : "58d9050550c847c89885c1797a718b0c"
    },
    "user" : {
      "user_num_id" : 4091,
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_name" : "demo_user_name_xiongzhitest001",
      "nick_name" : "bear"
    },
    "status" : {
      "id" : "1",
      "name" : ""
    }
  } ],
  "total" : 12
}