文档首页/ 需求管理 CodeArts Req/ API参考/ API/ 看板项目的工作项/ 查询看板项目下工作项的状态历史记录 - ListWorkitemStatusRecordsV4
更新时间:2025-12-11 GMT+08:00
分享

查询看板项目下工作项的状态历史记录 - ListWorkitemStatusRecordsV4

功能介绍

分页查询看板项目下工作项的状态历史记录

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/work-items/status-records

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围:

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量 从0开始

limit

Integer

每页数量 最小1,最大100

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

records

Array of WorkitemStatusRecords objects

操作历史

total

Integer

总数

表4 WorkitemStatusRecords

参数

参数类型

描述

project_id

String

项目的32位id

work_item_id

String

工作项id

work_item_record_id

String

工作项的记录id,一个工作项对应一条记录

work_item_statuses

Array of WorkitemStatus objects

操作历史

表5 WorkitemStatus

参数

参数类型

描述

id

String

工作项状态变更记录的id,每次变更产生一条新的记录id

status

status object

工作项的状态

表6 status

参数

参数类型

描述

description

String

工作项状态的描述

id

String

工作项的状态id

name

String

状态名称

parent_status_id

String

工作项状态的父状态id

type

String

工作项状态的类型,

BACKLOG( "初始化"),

READY("待启动"),

IN_PROGRESS("进行中"),

COMPLETE("已完成"),

DONE("已结束"),

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述。

取值范围

不涉及。

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items/status-records

响应示例

状态码:200

OK

{
  "records" : [ {
    "work_item_record_id" : "7401906a85de466c81fd90e22824eb19",
    "work_item_id" : "4633454879781163008",
    "project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
    "work_item_statuses" : [ {
      "id" : "7401906a85de466c81fd90e22824eb19",
      "status" : {
        "id" : "d25fe91f7f6b489db5f804e66ac3b360",
        "name" : "7401906a85de466c81fd90e22824eb19",
        "type" : "BACKLOG",
        "description" : "demo",
        "parent_status_id" : "7401906a85de466c81fd90e22824aaaa"
      }
    } ]
  } ],
  "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 ListWorkitemStatusRecordsV4Solution {

    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();
        ListWorkitemStatusRecordsV4Request request = new ListWorkitemStatusRecordsV4Request();
        request.withProjectId("{project_id}");
        try {
            ListWorkitemStatusRecordsV4Response response = client.listWorkitemStatusRecordsV4(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 = ListWorkitemStatusRecordsV4Request()
        request.project_id = "{project_id}"
        response = client.list_workitem_status_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
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.ListWorkitemStatusRecordsV4Request{}
	request.ProjectId = "{project_id}"
	response, err := client.ListWorkitemStatusRecordsV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档