Obtaining Child Work Items

Function

This API is used to obtain child work items.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

GET /v4/projects/{project_id}/issues/{issue_id}/child

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A
issue_id	Yes	Integer	Definition Work item ID, which can be obtained from the API for performing advanced query of work items. The value of the id field in the response body is the work item ID. Constraints N/A Range ≥ 0 Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
issues	Array of IssueResponseV4 objects	Definition: Work item list.
total	Integer	Definition: Total number. Options: N/A

**Table 4** IssueResponseV4
Parameter	Type	Description
actual_work_hours	Double	Definition Actual workloads. Range ≥ 0
assigned_cc_user	Array of IssueUser objects	Parameter description: Cc recipient.
assigned_user	IssueUser object	Parameter description: Handler.
begin_time	String	Parameter description: Estimated start time. The format is YYYY-MM-DD. Value range: N/A
closed_time	String	Definition: Closing time. The format is YYYY-MM-DD. Value range: N/A
created_time	String	Parameter description: Creation time. The format is YYYY-MM-DD HH:MM:SS. Value range: N/A
creator	IssueUser object	Parameter description: Creator.
custom_fields	Array of CustomField objects	Parameter description: Custom property value, which is not recommended. Refer to the new_custom_fields field.
developer	IssueUser object	Parameter description: Developer.
domain	domain object	Definition: Domain.
done_ratio	Integer	Definition Work item completion rate. For example, 20 indicates that the completion rate is 20%. Range 0–100
end_time	String	Definition Estimated end time. The format is YYYY-MM-DD. Range N/A
expected_work_hours	Double	Definition Estimated workloads. Range Min.: 0.
id	Integer	Definition Work item ID. Range ≥ 0
iteration	iteration object	Definition Sprint.
module	module object	Definition Module.
name	String	Definition: Title. Options: N/A
new_custom_fields	Array of NewCustomField objects	Definition: Custom property value.
parent_issue	parent_issue object	Definition: Parent work item.
priority	priority object	Definition: Work item priority.
project	IssueProjectResponseV4 object	Definition: Project information.
severity	severity object	Definition: Work item severity.
status	status object	Definition: Work item status.
tracker	tracker object	Definition: Work item type.
updated_time	String	Definition: Update time. The format is YYYY-MM-DD HH:MM:SS. Options: N/A
find_release_dev	String	Definition Version number. Range N/A
release_dev	String	Definition Release version number. Range N/A
env	IssueAttribute object	Definition Environment. Range N/A
tag_list	Array of TagRelation objects	Definition Tag list. Range N/A

**Table 5** IssueUser
Parameter	Type	Description
id	Integer	Definition User ID. Range N/A
name	String	Definition Username. Range N/A
nick_name	String	Definition: Alias. Options: N/A
user_id	String	Definition User UUID. Range N/A
user_num_id	Integer	Definition Digital ID of a user. Range N/A
first_name	String	Definition: Username. Value range: N/A

**Table 6** CustomField
Parameter	Type	Description
name	String	Definition: Custom property name. Value range: N/A
new_name	String	Definition: Custom property name. Value range: N/A
value	String	Definition: Value of the custom property. Value range: N/A

**Table 7** domain
Parameter	Type	Description
id	Integer	Definition: Domain ID. The options are as follows: 14: performance 15: performance 16: reliability 17: cyber security 18: maintainability 19: other DFX 20: availability Value range: 14, 15, 16, 17, 18, 19, and 20
name	String	Definition: Domain name. Options: N/A

**Table 8** iteration
Parameter	Type	Description
id	Integer	Definition Sprint ID. Range ≥ 0
name	String	Definition: Sprint name. Options: N/A

**Table 9** module
Parameter	Type	Description
id	Integer	Definition Module ID. Range ≥ 0
name	String	Definition: Module. Options: N/A

**Table 10** NewCustomField
Parameter	Type	Description
custom_field	String	Parameter description: Custom field. You can obtain the custom_field value returned using the [Querying Custom Fields of a Scrum Work Item]ListIssueCustomFields.xml) API.
field_name	String	Definition: Values of custom properties. Use commas (,) to separate multiple values, which can be obtained by querying the name value returned when calling the Querying Custom Fields of a Scrum Work Item API.
value	String	Definition: Values of custom properties. Use commas (,) to separate multiple values. You can obtain the value by querying the options value returned when calling the Querying Custom Fields of a Scrum Work Item API.

**Table 11** parent_issue
Parameter	Type	Description
id	Integer	Definition Parent work item ID. Range Min.: 0.
name	String	Definition: Parent work item. Options: N/A

**Table 12** priority
Parameter	Type	Description
id	Integer	Definition Priority ID. The options are as follows: 1: low 2: medium 3: high Range 1: low 2: medium 3: high
name	String	Definition Priority. Range Low Medium High

**Table 13** IssueProjectResponseV4
Parameter	Type	Description
project_id	String	Definition Project ID. Range N/A
project_name	String	Definition: Project name. Value range: N/A
project_num_id	Integer	Definition Digital ID of a project. Range ≥ 0

**Table 14** severity
Parameter	Type	Description
id	Integer	Definition: Severity ID. The options are as follows: 10: critical 11: major 12: minor 13: info Options: 10, 11, 12, and 13
name	String	Definition: Severity. Options: N/A

**Table 15** status
Parameter	Type	Description
id	Integer	Definition: Status ID. The options are as follows: 1: initial 2: in progress 3: solved 4: testing 5: closed 6: rejected Options: 1, 2, 3, 4, 5, and 6
name	String	Definition: Status name. Options: N/A

**Table 16** tracker
Parameter	Type	Description
id	Integer	Definition: Type ID. The options are as follows: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) Options: 2, 3, 5, 6, and 7
name	String	Definition: Type name. Options: N/A

**Table 17** IssueAttribute
Parameter	Type	Description
id	Integer	Definition Environment ID. Range N/A
name	String	Definition Environment name. Range N/A

**Table 18** TagRelation
Parameter	Type	Description
relationId	Integer	Definition Association ID. Range N/A
tagId	Integer	Definition Tag ID. Range N/A
region	String	Definition Region. Range N/A
name	String	Definition Tag name. Range N/A

Status code: 400

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error description. Value range: N/A

Status code: 401

**Table 20** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error description. Value range: N/A
request_id	String	Definition Request ID, which is automatically generated by the system. Range N/A

Example Requests

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921/child

Example Responses

Status code: 200

{
  "issues" : [ {
    "actual_work_hours" : 0,
    "assigned_cc_user" : [ {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "Tom"
    } ],
    "assigned_user" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "Tom"
    },
    "begin_time" : "2020-09-12",
    "created_time" : "2020-09-13 14:40:11",
    "creator" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "Tom"
    },
    "custom_fields" : [ {
      "name" : "customField16",
      "value" : "Check box",
      "new_name" : "custom_field16"
    } ],
    "new_custom_fields" : [ {
      "custom_field" : "custom_field16",
      "field_name" : "field_name",
      "value" : "Check box 1, Check box 2"
    } ],
    "developer" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "Tom"
    },
    "domain" : {
      "id" : 14,
      "name" : "Performance"
    },
    "done_ratio" : 0,
    "end_time" : "2020-09-19",
    "expected_work_hours" : 9,
    "id" : 4567,
    "project" : {
      "project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
      "project_name" : "testDemo",
      "project_num_id" : 78953
    },
    "iteration" : {
      "id" : 456,
      "name" : "Sprint 1"
    },
    "module" : {
      "id" : 456,
      "name" : "Project"
    },
    "name" : "Internationalization improvement",
    "parent_issue" : {
      "id" : 123,
      "name" : "Querying project members"
    },
    "priority" : {
      "id" : 1,
      "name" : "Low"
    },
    "severity" : {
      "id" : 12,
      "name" : "General"
    },
    "status" : {
      "id" : 1,
      "name" : "New"
    },
    "tracker" : {
      "id" : 7,
      "name" : "story"
    },
    "updated_time" : "2020-09-14 14:40:11",
    "closed_time" : "2020-09-15 14:40:11"
  } ],
  "total" : 1
}