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

查询IR历史记录

功能介绍

查询ir的历史记录。

调用方法

请参见如何调用API

URI

GET /v4/irs/{ir_id}/histories

表1 路径参数

参数

是否必选

参数类型

描述

ir_id

String

参数解释:

IR的ID,可以通过查询工作项详情接口获取,响应消息体中的id字段的值就是IR的ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

分页索引,偏移量,offset是limit的整数倍数。

约束限制:

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

取值范围:

最小值:0。

默认取值:

0

limit

Integer

参数解释:

每页显示查询IR历史记录的数量

约束限制:

不涉及

取值范围:

最小值:1 最大值:100

默认取值:

10

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

histories

Array of InitialRequirementHistory objects

参数解释:

历史记录

total

Integer

参数解释:

总数

取值范围:

不涉及

表4 InitialRequirementHistory

参数

参数类型

描述

created_time

Long

参数解释:

操作时间

取值范围:

不涉及

details

Array of IrRecordDetail objects

参数解释:

详细操作(该字段为包含0个或1个元素的数组,包含元素时,其内容表示对某个字段的操作)

ir_id

String

参数解释:

历史记录所属IR的id

取值范围:

不涉及

operation_type

String

参数解释:

操作类型

取值范围:

不涉及

operator

User object

参数解释:

操作人员

表5 IrRecordDetail

参数

参数类型

描述

field_id

String

参数解释:

操作的字段id。

取值范围:

不涉及。

field_label

String

参数解释:

字段名称。

取值范围:

不涉及。

new_value

String

参数解释:

修改后的值。

取值范围:

不涉及。

old_value

String

参数解释:

修改前的值。

取值范围:

不涉及。

表6 User

参数

参数类型

描述

domain_id

String

参数解释:

租户uuid

取值范围:

不涉及

domain_name

String

参数解释:

租户名

取值范围:

不涉及

gender

String

参数解释:

性别

取值范围:

不涉及

nick_name

String

参数解释:

昵称

取值范围:

不涉及

user_id

String

参数解释:

用户uuid

取值范围:

不涉及

user_name

String

参数解释:

用户名

取值范围:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET /v4/irs/4647058403938004992/histories

响应示例

状态码:200

OK

{
  "histories" : [ {
    "created_time" : 1623411441842,
    "details" : [ {
      "field_id" : "6",
      "field_label" : "状态",
      "new_value" : "开发中",
      "old_value" : "新建"
    } ],
    "ir_id" : "4647242717936652288",
    "operation_type" : "更新",
    "operator" : {
      "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
      "domain_name" : "devcloud_test",
      "gender" : "男",
      "nick_name" : "红海",
      "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
      "user_name" : "Banna"
    }
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档