更新时间:2025-08-11 GMT+08:00
分享

获取子工作项

功能介绍

获取子工作项

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

正则表达式,[A-Za-z0-9]{32}。

取值范围:

不涉及。

默认取值

不涉及。

issue_id

Integer

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

issues

Array of IssueResponseV4 objects

参数解释:

工作项列表。

total

Integer

参数解释:

总数。

取值范围:

不涉及。

表4 IssueResponseV4

参数

参数类型

描述

actual_work_hours

Double

参数解释:

实际工时

取值范围:

最小值:0

assigned_cc_user

Array of IssueUser objects

参数解释:

抄送人

assigned_user

IssueUser object

参数解释:

处理人

begin_time

String

参数解释:

预计开始时间,日期格式:YYYY-MM-DD

取值范围:

不涉及

closed_time

String

参数解释:

关闭时间,日期格式:YYYY-MM-DD

取值范围:

不涉及

created_time

String

参数解释:

创建时间,日期格式:YYYY-MM-DD HH:MM:SS

取值范围:

不涉及

creator

IssueUser object

参数解释:

创建人

custom_fields

Array of CustomField objects

参数解释:

自定义属性值,不建议使用,建议参考new_custom_fields字段

developer

IssueUser object

参数解释:

开发人员

domain

domain object

参数解释:

领域

done_ratio

Integer

参数解释:

工作项完成度 ,如20,表示完成度为20%

取值范围:

最小值 0 最大值 100

end_time

String

参数解释:

预计结束时间,日期格式:YYYY-MM-DD

取值范围:

不涉及

expected_work_hours

Double

参数解释:

预计工时

取值范围:

最小值:0

id

Integer

参数解释:

工作项id

取值范围:

0至9999999999

iteration

iteration object

参数解释:

迭代

module

module object

参数解释:

模块

name

String

参数解释:

标题

取值范围:

不涉及

new_custom_fields

Array of NewCustomField objects

参数解释:

自定义属性值

parent_issue

parent_issue object

参数解释:

父工作项

priority

priority object

参数解释:

工作项优先级

project

IssueProjectResponseV4 object

参数解释:

项目信息

severity

severity object

参数解释:

工作项重要程度

status

status object

参数解释:

工作项状态

tracker

tracker object

参数解释:

工作项类型

updated_time

String

参数解释:

更新时间,日期格式:YYYY-MM-DD HH:MM:SS

取值范围:

不涉及

表5 IssueUser

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

不涉及。

name

String

参数解释:

带租户名的用户名(租户名_用户名)。

取值范围:

不涉及。

nick_name

String

参数解释:

昵称。

取值范围:

不涉及。

user_id

String

参数解释:

用户uuid。

取值范围:

不涉及。

user_num_id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

表6 CustomField

参数

参数类型

描述

name

String

参数解释:

自定义属性名。

取值范围:

不涉及。

new_name

String

参数解释:

自定义属性名。

取值范围:

不涉及。

value

String

参数解释:

自定义属性对应的值。

取值范围:

不涉及。

表7 domain

参数

参数类型

描述

id

Integer

参数解释:

领域id,枚举:

14(性能)

15(功能)

16('可靠性)

17(网络安全)

18(可维护性)

19(其他DFX)

20(可用性)

取值范围:

14,15,16,17,18,19,20

name

String

参数解释:

领域名称

取值范围:

不涉及

表8 iteration

参数

参数类型

描述

id

Integer

参数解释:

迭代id

取值范围:

最小值:0

name

String

参数解释:

迭代名

取值范围:

不涉及

表9 module

参数

参数类型

描述

id

Integer

参数解释:

模块id

取值范围:

最小值:0

name

String

参数解释:

模块

取值范围:

不涉及

表10 NewCustomField

参数

参数类型

描述

custom_field

String

参数解释:

自定义字段,可以通过查询Scrum工作项自定义字段接口查询Scrum工作项自定义字段中返回的custom_field值获取。

约束限制:

可以为空。

取值范围:

不涉及。

默认取值:

不涉及。

field_name

String

参数解释:

自定义属性对应的值,多个值以英文逗号区分开, 可以通过查询Scrum工作项自定义字段接口查询Scrum工作项自定义字段中返回的name值获取。

约束限制:

可以为空。

取值范围:

不涉及。

默认取值:

不涉及。

value

String

参数解释:

自定义属性对应的值,多个值以英文逗号区分开, 可以通过查询Scrum工作项自定义字段接口查询Scrum工作项自定义字段中返回的options值获取。

约束限制:

可以为空。

取值范围:

不涉及。

默认取值:

不涉及。

表11 parent_issue

参数

参数类型

描述

id

Integer

参数解释:

父工作项id

取值范围:

最小值:0

name

String

参数解释:

父工作项

取值范围:

不涉及

表12 priority

参数

参数类型

描述

id

Integer

参数解释:

优先级id,枚举:

1(低)

2(中)

3(高)

取值范围:

1,2,3

name

String

参数解释:

优先级

取值范围:

不涉及

表13 IssueProjectResponseV4

参数

参数类型

描述

project_id

String

参数解释:

项目id。

取值范围:

不涉及。

project_name

String

参数解释:

项目名称。

取值范围:

不涉及。

project_num_id

Integer

参数解释:

项目数字id。

取值范围:

最小值:0。

表14 severity

参数

参数类型

描述

id

Integer

参数解释:

重要程度id,枚举:

10 (关键)

11 (重要)

12 (一般)

13 (提示)

取值范围:

10,11,12,13

name

String

参数解释:

重要程度

取值范围:

不涉及

表15 status

参数

参数类型

描述

id

Integer

参数解释:

状态id,枚举:

1(新建)

2(进行中)

3(已解决)

4(测试中)

5( 已关闭)

6(已拒绝)

取值范围:

1,2,3,4,5,6

name

String

参数解释:

状态名称

取值范围:

不涉及

表16 tracker

参数

参数类型

描述

id

Integer

参数解释:

类型id,枚举:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

取值范围:

2,3,5,6,7

name

String

参数解释:

类型名称

取值范围:

不涉及

表17 SecurityLevelResult

参数

参数类型

描述

id

String

参数解释:

密级编码。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

密级字段名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sequence

Integer

参数解释:

密级排序值,越大级别越高

状态码:400

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

状态码:200

OK

{
  "issues" : [ {
    "actual_work_hours" : 0,
    "assigned_cc_user" : [ {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "张三"
    } ],
    "assigned_user" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "张三"
    },
    "begin_time" : "2020-09-12",
    "created_time" : "2020-09-13 14:40:11",
    "creator" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "张三"
    },
    "custom_fields" : [ {
      "name" : "customField16",
      "value" : "多选框",
      "new_name" : "custom_field16"
    } ],
    "new_custom_fields" : [ {
      "custom_field" : "custom_field16",
      "field_name" : "field_name",
      "value" : "多选框1,多选框2"
    } ],
    "developer" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "张三"
    },
    "domain" : {
      "id" : 14,
      "name" : "性能"
    },
    "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" : "迭代1"
    },
    "module" : {
      "id" : 456,
      "name" : "Project"
    },
    "name" : "国际化整改",
    "parent_issue" : {
      "id" : 123,
      "name" : "提供查询项目成员的功能"
    },
    "priority" : {
      "id" : 1,
      "name" : "低"
    },
    "severity" : {
      "id" : 12,
      "name" : "一般"
    },
    "status" : {
      "id" : 1,
      "name" : "新建"
    },
    "tracker" : {
      "id" : 7,
      "name" : "story"
    },
    "updated_time" : "2020-09-14 14:40:11",
    "closed_time" : "2020-09-15 14:40:11"
  } ],
  "total" : 1
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class ListChildIssuesV4Solution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        ListChildIssuesV4Request request = new ListChildIssuesV4Request();
        request.withProjectId("{project_id}");
        request.withIssueId({issue_id});
        try {
            ListChildIssuesV4Response response = client.listChildIssuesV4(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListChildIssuesV4Request()
        request.project_id = "{project_id}"
        request.issue_id = {issue_id}
        response = client.list_child_issues_v4(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListChildIssuesV4Request{}
	request.ProjectId = "{project_id}"
	request.IssueId = int32({issue_id})
	response, err := client.ListChildIssuesV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档