文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 外部服务管理/ 外部系统获取资源修改历史记录
更新时间:2025-07-24 GMT+08:00
分享

外部系统获取资源修改历史记录

功能介绍

获取资源修改历史记录

调用方法

请参见如何调用API

URI

POST /v4/testhub/projects/{project_id}/resources/{resource_uri}/histories/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

resource_uri

String

资源uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

offset

Integer

起始偏移

limit

Integer

每页展示条数

version_id

String

分支/测试计划id

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

error

ApiError object

错误信息

request_id

String

由接口调用方传入,建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址

result

ExternalPageVoListTestCaseHistoryExternalVo object

请求结果

表4 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

表5 ExternalPageVoListTestCaseHistoryExternalVo

参数

参数类型

描述

total

Long

总数

values

Array of TestCaseHistoryExternalVo objects

结果集合

表6 TestCaseHistoryExternalVo

参数

参数类型

描述

author

String

资源历史记录创建人

region

String

逻辑region

changes

Array of ResourceChangeExternalVo objects

历史记录字段变更列表

id

String

历史记录id

testcase_id

String

用例id

creation_date

String

创建时间

create_date_timestamp

Long

创建时间时间戳

author_name

String

创建人名称

project_id

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

表7 ResourceChangeExternalVo

参数

参数类型

描述

field_name

String

变更字段

custom_field_type

String

测试用例自定义字段类型

old_change_info

ElementResourceChangeExternalVo object

变更前的数据信息

new_change_info

ElementResourceChangeExternalVo object

变更后的数据信息

表8 ElementResourceChangeExternalVo

参数

参数类型

描述

tracker_name

String

工作项类型

value

String

key

String

key

object_value

Object

对象值

object_key

Object

对象key

tracker_names

Object

缺陷类型

board_info

Array of objects

归属看板信息,用例关联工作项信息使用

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

post https://{endpoint}/v4/testhub/projects/c4e36f20d35a4720a1647e8e6215b737/resources/v90600010i8ev89s/histories/batch-query

{
  "offset" : 1,
  "limit" : 20,
  "version_id" : "1d4fgf5gexss13"
}

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "values" : {
      "author" : "zhangshan",
      "region" : "szv",
      "changes" : [ { } ],
      "id" : "001s90u5o2d1",
      "testcase_id" : "001s16gt6q5",
      "creation_date" : "2025-06-19T11:58:39.225Z",
      "create_date_timestamp" : 1660617231016,
      "author_name" : "名称",
      "project_id" : "klasier2dfj3qaw4jedfts"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档