Querying the Child Work Item List (V2)

Function

This API is used to query the child work item list (V2).

Calling Method

For details, see Calling APIs.

URI

POST /v2/issues/child-issue-list

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory. Value range: Minimum length: 10 characters. Maximum length: 32,768 characters. Default value: N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
parent_id	No	Integer	Definition: Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID. Constraints: The value must contain 1 to 10 digits. Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: N/A
project_uuid	No	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A
subject	No	String	Definition: Work item title, which can be obtained from the Performing Advanced Query of Work Items API. The value of the name field in the response message body is the work item title. Constraints: N/A Value range: N/A Default value: N/A
query_type	No	String	Definition: Query mode of a transaction. Constraints: N/A Value range: basic (basic query) custom (temporary filtering) query (filter) Default value: N/A
page_no	No	String	Definition: Page index. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
page_size	No	String	Definition: Page size. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Response result.
status	String	Definition: Response status.

**Table 4** result
Parameter	Type	Description
total_count	Integer	Definition: Total number of child work items. Value range: N/A
issues	Array of issues objects	Definition: Work item list information. Value range: N/A

**Table 5** issues
Parameter	Type	Description
updated_on	String	Definition: Work item update time (in timestamp format, for example, 1839340800000). Value range: N/A
subject	String	Description: Work item title. Value range: N/A
parent_issue	ParentIssue object	Definition: Parent work item. Value range: N/A
description	String	Definition: Work item description. Value range: N/A
project	Project object	Definition: Project information. Value range: N/A
done_ratio	Integer	Definition: Work item completion rate. For example, 20 indicates that the completion rate is 20%. Value range: Minimum value: 0. Maximum value: 100.
find_release_dev	String	Definition: Released version where the bug was found. Value range: N/A
tracker	Tracker object	Definition: Work item type. Value range: N/A
id	Integer	Definition: Work item ID. Value range: 0 to 9,999,999,999
release_dev	String	Definition: Release version of a work item. Value range: N/A
customValueNew	Object	Definition: Custom field value of a work item. Value range: N/A
order	IssueOrderV4 object	Definition: Position of a work item in the list.
assigned_to	IssueAuthorVO object	Definition: Handler.
status_attribute	StateAttribute object	Definition: Status attribute. The value can be To do, Doing, or Done. Value range: N/A
severity	Severity object	Definition: Work item severity. Value range: N/A
is_parent	Boolean	Definition: Whether the current work item is a parent work item. Value range: N/A
author	IssueAuthorVO object	Definition: Work item submitter. Value range: N/A
module	Object	Definition: Module of a work item. Value range: N/A
expected_work_hours	Integer	Definition: Estimated workloads for completion (unit: person-hour). Value range: Minimum value: 0.
priority	Priority object	Definition: Work item priority. Value range: N/A
actual_work_hours	Integer	Definition: Actual workloads (unit: person-hour). Constraints: N/A
is_watcher	Boolean	Definition: Whether the user has favorited the work item. Value range: true: The user has favorited the work item. true: The user has not favorited the work item.
deleted	Boolean	Definition: Whether the work item has been deleted. Value range: true: deleted false: not deleted
fixed_version	Object	Definition: Version in which a work item is resolved. Value range: N/A
is_archived	Boolean	Definition: Whether a work item has been archived. Value range: true: archived false: not archived
created_on	String	Definition: Time when a work item is created (in timestamp format, for example, 1839340800000). Value range: N/A
domain	Object	Definition: Domain information. Value range: N/A
developer	Object	Definition: Developer of a work item. Value range: N/A
closeder	Object	Definition: Person who closes a work item. Value range: N/A
parent_issue_id	Integer	Definition: Parent work item ID. Value range: N/A
position	String	Definition: Sorting value of a work item on the page. Value range: N/A
closed_flag	Integer	Definition: Whether the work item is closed. Value range: 0: not closed 1: closed
assigned_cc_user	Array of strings	Definition: Cc recipient of a work item. Value range: N/A
status	Status object	Definition: Work item status. Value range: N/A

**Table 6** ParentIssue
Parameter	Type	Description
subject	String	Definition: Parent work item name. Value range: N/A
id	Integer	Definition: Digital ID of the parent work item. Value range: Minimum value: 0.

**Table 7** Project
Parameter	Type	Description
identifier	String	Definition: Project UUID. Value range: N/A
name	String	Definition: Project name. Value range: N/A
id	Integer	Definition: Digital ID of a project. Value range: N/A
type	String	Definition: Project type. Value range: Scrum

**Table 8** Tracker
Parameter	Type	Description
name	String	Definition: Type name. Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story)
id	Integer	Definition: Type ID. Value range: 2, 3, 5, 6, and 7

**Table 9** IssueOrderV4
Parameter	Type	Description
id	Integer	Definition: Sequence ID of a work item in the list. Value range: N/A
name	String	Definition: Sequence of a work item in the list. Value range: N/A

**Table 10** StateAttribute
Parameter	Type	Description
id	String	Definition: Attribute ID of the work item status. Value range: N/A
name	String	Definition: Name of a work item status. Value range: To Do Doing Done

**Table 11** Severity
Parameter	Type	Description
name	String	Definition: Work item severity. Value range: 10: critical 11: major 12: minor 13: trivial
id	Integer	Definition: Severity ID. Value range: 10, 11, 12, and 13

**Table 12** IssueAuthorVO
Parameter	Type	Description
first_name	String	Definition: Username. Value range: N/A
last_name	String	Definition: Last name of the user. Value range: N/A
identifier	String	Definition: Unique ID of the author. Value range: N/A
image_id	String	Definition: User avatar ID. Value range: N/A
assigned_nick_name	String	Definition: User alias. Value range: N/A
name	String	Definition: Username with tenant information, in the format of Tenant name_Username. Value range: N/A
id	Integer	Definition: User ID. Value range: N/A

**Table 13** Priority
Parameter	Type	Description
name	String	Definition: Work item priority. Value range: 1: low 2: medium 3: high
id	Integer	Definition: Priority ID. Value range: 1, 2, and 3

**Table 14** Status
Parameter	Type	Description
name	String	Definition: Status name. Value range: 1: new 2: developing 3: resolved 4: testing 5: closed 6: rejected
id	Integer	Definition: Status ID. Value range: 1, 2, 3, 4, 5, and 6

Example Requests

POST http://{endpoint}/v2/issues/child-issue-list

{
  "parent_id" : 69783229,
  "project_uuid" : "d00fd603ddf64115939e7d3609d6cb05",
  "subject" : "",
  "query_type" : "basic",
  "page_no" : "1",
  "page_size" : "10"
}

Example Responses

Status code: 200

OK (The request has succeeded).

{
  "result" : {
    "total_count" : 1,
    "issues" : [ {
      "updated_on" : "1753346232000",
      "subject" : "Task - Tag filtering 01",
      "parent_issue" : {
        "subject" : "Story - Tag filtering 01",
        "id" : 9184452
      },
      "description" : "<p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> As </span><User role></p><p><br /></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> I want </span><to do something></p><p><br /></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> so as to </span><do something> </p>",
      "project" : {
        "identifier" : "873ca7d1592f4921b4644dc16a1176f5",
        "name" : "Scrum-tree filter by tag",
        "id" : 35165288,
        "type" : "scrum"
      },
      "done_ratio" : 0,
      "tracker" : {
        "name" : "Task",
        "id" : 2
      },
      "id" : 9184453,
      "customValueNew" : { },
      "order" : {
        "name" : 1,
        "id" : 1
      },
      "assigned_to" : {
        "first_name" : "devcloud_devcloud_s00404480_01",
        "last_name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "image_id" : "photo01.png",
        "assigned_nick_name" : "Sam 1",
        "name" : "devcloud_devcloud_s00404480_01",
        "id" : 4091
      },
      "status_attribute" : {
        "name" : "To Do",
        "id" : 35160238
      },
      "severity" : {
        "name" : "Minor",
        "id" : 12
      },
      "author" : {
        "first_name" : "devcloud_devcloud_s00404480_01",
        "last_name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "image_id" : "photo01.png",
        "assigned_nick_name" : "Sam 1",
        "name" : "devcloud_devcloud_s00404480_01",
        "id" : 4091
      },
      "module" : { },
      "expected_work_hours" : 0,
      "priority" : {
        "name" : "Medium",
        "id" : 2
      },
      "actual_work_hours" : 0,
      "is_watcher" : false,
      "deleted" : false,
      "fixed_version" : { },
      "is_archived" : false,
      "created_on" : "1753346232000",
      "domain" : { },
      "developer" : { },
      "closeder" : { },
      "parent_issue_id" : 9184452,
      "position" : "9184453.0000000000",
      "closed_flag" : 0,
      "assigned_cc_user" : [ ],
      "status" : {
        "name" : "New",
        "id" : 1
      }
    } ]
  },
  "status" : "success"
}