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

查询项目的工作项

功能介绍

工作项类型id,分页参数,创建时间查询项目的工作项。

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/issues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围:

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量 从0开始

约束限制:

正则表达式,0|[1-9]\d{0,10}。

取值范围:

最小值:0

默认取值:

0

limit

Integer

参数解释:

每页数量 最小1,最大100

约束限制:

不涉及

取值范围:

最小值:1 最大值:100

默认取值:

100

tracker_id

Integer

参数解释:

工作项类型

约束限制:

工作项类型枚举:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

取值范围:

最小值 2 最大值 7

默认取值:

不涉及

created_time_interval

String

参数解释:

创建工作项的时间(查询的起始时间,查询的结束时间)

约束限制:

正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。

取值范围:

不涉及

默认取值:

不涉及

updated_time_interval

String

参数解释:

更新工作项的时间(查询的起始时间,查询的结束时间)

约束限制:

正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

issues

Array of IssueItemSfV4 objects

参数解释:

工作项列表信息

total

Integer

参数解释:

工作项总数

取值范围:

不涉及

表5 IssueItemSfV4

参数

参数类型

描述

actual_work_hours

Double

参数解释:

实际工时

取值范围:

不涉及

assigned_user

IssueUser object

参数解释:

处理人

author

IssueUser object

参数解释:

作者

begin_time

Long

参数解释:

工作项开始时间

取值范围:

不涉及

closed_time

Long

参数解释:

关闭工作项的时间

取值范围:

不涉及

created_time

Long

参数解释:

创建时间

取值范围:

不涉及

custom_feilds

Array of CustomFeildRecord objects

参数解释:

自定义属性

developer

IssueUser object

参数解释:

开发人员

discover_version

String

参数解释:

发现问题的版本

取值范围:

不涉及

domain

domain object

参数解释:

id, 领域

14(性能)

15(功能)

16(可靠性)

17(网络安全)

18(可维护性)

19(其他DFX)

20(可用性)

done_ratio

Integer

参数解释:

工作项进度值

取值范围:

不涉及

end_time

Long

参数解释:

工作项结束时间

取值范围:

不涉及

expected_work_hours

Double

参数解释:

预计工时

取值范围:

不涉及

iteration

iteration object

参数解释:

迭代

module

module object

参数解释:

模块

order

Integer

参数解释:

顺序

parent_issue_id

Integer

参数解释:

父工作项的id

取值范围:

不涉及

priority

priority object

参数解释:

工作项优先级

release_version

String

参数解释:

发布的版本

取值范围:

不涉及

root_issue_id

Integer

参数解释:

根工作项的id

取值范围:

不涉及

severity

severity object

参数解释:

工作项重要程度

status

status object

参数解释:

工作项状态

story_point

story_point object

参数解释:

故事点id

1(0)

2(1/2)

3(1)

4(2)

5(3)

6(5)

7(8)

8(13)

9(21)

10(40)

11(80)

12(100)

13(∞)

14(?)

subject

String

参数解释:

工作项标题

取值范围:

不涉及

tracker

tracker object

参数解释:

工作项类型

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

updated_time

Long

参数解释:

工作项更新时间

取值范围:

不涉及

表6 CustomFeildRecord

参数

参数类型

描述

key

String

参数解释:

自定义工作项属性

取值范围:

不涉及

name

String

参数解释:

自定义工作项名称

取值范围:

不涉及

value

String

参数解释:

自定义工作项值

取值范围:

不涉及

表7 IssueUser

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

不涉及。

name

String

参数解释:

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

取值范围:

不涉及。

nick_name

String

参数解释:

昵称。

取值范围:

不涉及。

user_id

String

参数解释:

用户uuid。

取值范围:

不涉及。

user_num_id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

表8 SecurityLevelResult

参数

参数类型

描述

id

String

参数解释:

密级编码。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

密级字段名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sequence

Integer

参数解释:

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

表9 domain

参数

参数类型

描述

id

Integer

参数解释:

领域id

取值范围:

不涉及

name

String

参数解释:

领域

取值范围:

不涉及

表10 iteration

参数

参数类型

描述

id

Integer

参数解释:

迭代id

取值范围:

不涉及

name

String

参数解释:

迭代名

取值范围:

不涉及

表11 module

参数

参数类型

描述

id

Integer

参数解释:

模块id

取值范围:

不涉及

name

String

参数解释:

模块

取值范围:

不涉及

表12 priority

参数

参数类型

描述

id

Integer

参数解释:

优先级id

取值范围:

不涉及

name

String

参数解释:

优先级

取值范围:

不涉及

表13 severity

参数

参数类型

描述

id

Integer

参数解释:

重要程度id

取值范围:

不涉及

name

String

参数解释:

重要程度

取值范围:

不涉及

表14 status

参数

参数类型

描述

id

Integer

参数解释:

状态id

取值范围:

不涉及

name

String

参数解释:

状态名称

取值范围:

不涉及

表15 story_point

参数

参数类型

描述

id

Integer

参数解释:

故事点id

取值范围:

不涉及

name

String

参数解释:

故事点

取值范围:

不涉及

表16 tracker

参数

参数类型

描述

id

Integer

参数解释:

类型id

取值范围:

不涉及

name

String

参数解释:

类型名称

取值范围:

不涉及

状态码:400

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Get https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues

响应示例

状态码:200

OK

{
  "issues" : [ {
    "actual_work_hours" : 10,
    "assigned_user" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "demo"
    },
    "author" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "demo"
    },
    "begin_time" : 1590940800000,
    "closed_time" : 1590940800000,
    "created_time" : 1590940800000,
    "custom_feilds" : [ {
      "key" : "customField15",
      "name" : "single",
      "value" : "15Demo"
    } ],
    "developer" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "demo"
    },
    "discover_version" : "ProjectMan 8.0.0",
    "end_time" : 1590940800000,
    "done_ratio" : 0,
    "expected_work_hours" : 9,
    "order" : 1,
    "parent_issue_id" : 123,
    "release_version" : "ProjectMan 8.0.0",
    "root_issue_id" : 0,
    "story_point" : {
      "id" : 1,
      "name" : "0"
    },
    "domain" : {
      "id" : 14,
      "name" : "性能"
    },
    "iteration" : {
      "id" : 456,
      "name" : "迭代1"
    },
    "module" : {
      "id" : 456,
      "name" : "Project"
    },
    "priority" : {
      "id" : 1,
      "name" : "低"
    },
    "severity" : {
      "id" : 12,
      "name" : "一般"
    },
    "status" : {
      "id" : 1,
      "name" : "新建"
    },
    "tracker" : {
      "id" : 7,
      "name" : "story"
    },
    "subject" : "demo",
    "updated_time" : 1576114296000
  } ],
  "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
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 ListIssuesSfV4Solution {

    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();
        ListIssuesSfV4Request request = new ListIssuesSfV4Request();
        request.withProjectId("{project_id}");
        try {
            ListIssuesSfV4Response response = client.listIssuesSfV4(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
# 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 = ListIssuesSfV4Request()
        request.project_id = "{project_id}"
        response = client.list_issues_sf_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
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.ListIssuesSfV4Request{}
	request.ProjectId = "{project_id}"
	response, err := client.ListIssuesSfV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档