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

获取工作项历史记录

功能介绍

获取工作项历史记录

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/issue/{issue_id}/records

表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 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

分页索引,偏移量。

约束限制:

offset是limit的整数倍,limit=10,offset=0,10,20...。

取值范围:

最小值:0

默认取值:

0

limit

Integer

参数解释:

每页显示的数量

约束限制:

不涉及

取值范围:

最小值:1,最大值:1000。

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

records

Array of IssueRecordV4 objects

参数解释:

工作项记录详情

total

Integer

参数解释:

操作记录总数

取值范围:

不涉及

表5 IssueRecordV4

参数

参数类型

描述

created_time

Long

参数解释:

操作记录创建时间

取值范围:

不涉及

details

Array of details objects

参数解释:

操作记录

id

Integer

参数解释:

操作记录id

取值范围:

不涉及

user

user object

参数解释:

工作项操作的用户

表6 details

参数

参数类型

描述

id

Integer

参数解释:

操作记录id

取值范围:

不涉及

name

String

参数解释:

操作的字段名称

取值范围:

不涉及

new_value

String

参数解释:

当前值

取值范围:

不涉及

old_value

String

参数解释:

上次的记录

取值范围:

不涉及

operation

String

参数解释:

操作。

取值范围:

JOURNAL_1( "修改");

JOURNAL_2( "新建");

JOURNAL_3( "删除");

JOURNAL_4( "复制");

JOURNAL_5( "导入");

JOURNAL_6( "代码提交流转");

JOURNAL_7( "导入更新");

JOURNAL_8( "批量编辑");

ARCHIVING( "归档");

CANCEL_ARCHIVING( "取消归档");

ASSOCIATE_TEST_CASE( "关联用例");

CANCEL_ASSOCIATED_TEST_CASE( "取消关联用例");

ASSOCIATE_CODE_BRANCH( "关联分支");

ASSOCIATE_ISSUE( "关联工作项");

CANCEL_ASSOCIATED_ISSUE( "取消关联工作项");

CLOSE_SPRINT( "迭代结束")。

property

String

参数解释:

操作属性

取值范围:

不涉及

表7 user

参数

参数类型

描述

nick_name

String

参数解释:

昵称

取值范围:

不涉及

user_id

String

参数解释:

用户32位的uuid

取值范围:

不涉及

user_name

String

参数解释:

登录名

取值范围:

不涉及

user_num_id

Integer

参数解释:

用户数字id

取值范围:

不涉及

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/issue/3458/records

响应示例

状态码:200

OK

{
  "records" : [ {
    "id" : 1234,
    "created_time" : 1617764919000,
    "user" : {
      "user_num_id" : 4091,
      "user_name" : "demo_user_name",
      "nick_name" : "aaa",
      "user_id" : "a360371833bf4c558f796fd707b44daf"
    },
    "details" : [ {
      "property" : 1,
      "old_value" : 1,
      "new_value" : 2,
      "operation" : "批量编辑",
      "id" : 3597,
      "name" : "标题"
    } ]
  } ],
  "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 ListIssueRecordsV4Solution {

    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();
        ListIssueRecordsV4Request request = new ListIssueRecordsV4Request();
        request.withProjectId("{project_id}");
        request.withIssueId({issue_id});
        try {
            ListIssueRecordsV4Response response = client.listIssueRecordsV4(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 = ListIssueRecordsV4Request()
        request.project_id = "{project_id}"
        request.issue_id = {issue_id}
        response = client.list_issue_records_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.ListIssueRecordsV4Request{}
	request.ProjectId = "{project_id}"
	request.IssueId = int32({issue_id})
	response, err := client.ListIssueRecordsV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档