Obtaining Child Work Items
Function
This API is used to obtain child work items.
Calling Method
For details, see Calling APIs.
URI
GET /v4/projects/{project_id}/issues/{issue_id}/child
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
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: Regular expression: [A-Za-z0-9]{32} Options: N/A Default value: N/A |
issue_id |
Yes |
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 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token. Constraints: Mandatory. Range: Minimum length: 10 character. Maximum length: 32,768 characters. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
issues |
Array of IssueResponseV4 objects |
Definition: Work item list. |
total |
Integer |
Definition: Total number. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
actual_work_hours |
Double |
Parameter description: Actual workloads. Value range: Minimum value: 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%. Options: Minimum value: 0. Maximum value: 100. |
end_time |
String |
Definition: Estimated end time. The format is YYYY-MM-DD. Options: N/A |
expected_work_hours |
Double |
Definition: Estimated workloads. Options: Minimum value: 0. |
id |
Integer |
Definition: Work item ID. Options: 0 to 9,999,999,999 |
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 |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: User ID. Value range: N/A |
name |
String |
Definition: Username with the tenant name: Tenant name_Username. Options: N/A |
nick_name |
String |
Definition: Alias. Options: N/A |
user_id |
String |
Definition: User UUID. Value range: N/A |
user_num_id |
Integer |
Definition: Digital ID of a user. Value range: N/A |
first_name |
String |
Definition: Username. Value range: N/A |
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 |
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 Options: 14, 15, 16, 17, 18, 19, and 20 |
name |
String |
Definition: Domain name. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Sprint ID. Options: Minimum value: 0. |
name |
String |
Definition: Sprint name. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Module ID. Options: Minimum value: 0. |
name |
String |
Definition: Module. Options: N/A |
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. Constraints: This field can be left blank. Options: N/A Default value: N/A |
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. Constraints: This field can be left blank. Value range: N/A Default value: N/A |
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. Constraints: This field can be left blank. Value range: N/A Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Parent work item ID. Options: Minimum value: 0. |
name |
String |
Definition: Parent work item. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Priority ID. The options are as follows: 1: low 2: medium 3: high Options: 1, 2, and 3 |
name |
String |
Definition: Priority. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Definition: Project ID. Value range: N/A |
project_name |
String |
Definition: Project name. Value range: N/A |
project_num_id |
Integer |
Definition: Digital ID of a project. Options: Minimum value: 0. |
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 |
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 |
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 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Security level code. Constraints: N/A Value range: N/A Default value: N/A |
name |
String |
Definition: Security level field name. Constraints: N/A Value range: N/A Default value: N/A |
sequence |
Integer |
Definition: Security level sorting value. A larger value indicates a higher security level. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921/child
Example Responses
Status code: 200
OK
{ "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 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot