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

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

功能介绍

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

devcloud项目的32位id

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量 从0开始

最小值:0

缺省值:0

limit

Integer

每页数量 最小1,最大100

最小值:1

最大值:100

缺省值:100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:10

最大长度:32768

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

records

Array of WorkitemStatusRecords objects

操作历史

total

Integer

总数

表5 WorkitemStatusRecords

参数

参数类型

描述

work_item_record_id

String

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

最小长度:32

最大长度:32

work_item_id

String

工作项id

project_id

String

devcloud项目的32位id

最小长度:32

最大长度:32

work_item_statuses

Array of WorkitemStatus objects

操作历史

表6 WorkitemStatus

参数

参数类型

描述

id

String

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

最小长度:1

最大长度:32

status

status object

工作项的状态

表7 status

参数

参数类型

描述

id

String

工作项的状态id

最小长度:1

最大长度:32

name

String

状态名称

最小长度:1

最大长度:60

type

String

工作项状态的类型, BACKLOG( "初始化"), READY("待启动"), IN_PROGRESS("进行中"), COMPLETE("已完成"), DONE("已结束"),

description

String

工作项状态的描述

parent_status_id

String

工作项状态的父状态id

最小长度:1

最大长度:32

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

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

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
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

分享:

    相关文档

    相关产品