文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询项目下所有工作项的历史记录
更新时间:2024-11-19 GMT+08:00
分享

查询项目下所有工作项的历史记录

功能介绍

查询项目下所有工作项的历史记录

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/issues/records

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

devcloud项目的32位id

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量 从0开始,offset是limit的整数倍,limit=10,offset=0,10,20...

最小值:0

缺省值:0

limit

Integer

每页数量 最小1,最大100

最小值:1

最大值:100

缺省值:100

operated_time_interval

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:10

最大长度:32768

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

records

Array of IssueAttrHistoryRecord objects

历史记录

total

Integer

总数

表5 IssueAttrHistoryRecord

参数

参数类型

描述

field_key

String

操作的字段

field_name

String

操作字段的含义

id

Long

历史记录id

issue_id

Long

工作项id

new_value

String

变更后的值,json字符串

old_value

String

变更前的值,json字符串

operated_time

Long

变更的时间

operation

String

操作类型,新建,修改,删除

operator

IssueUser object

操作者

property

String

变更的属性

表6 IssueUser

参数

参数类型

描述

user_id

String

用户uuid

user_num_id

Integer

用户数字id

id

Integer

用户id

name

String

用户名

nick_name

String

昵称

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

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

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

响应示例

状态码: 200

OK

{
  "records" : [ {
    "field_key" : "status",
    "field_name" : "状态",
    "id" : 789,
    "issue_id" : 123,
    "new_value" : "{\"id\":\"2\", \"name\":\"开发中\"}",
    "old_value" : "{\"id\":\"1\", \"name\":\"创建\"}",
    "operated_time" : 1601175640000,
    "operation" : "修改",
    "operator" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "张三"
    },
    "property" : "attr"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档