文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 获取资源修改历史记录
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

获取资源修改历史记录

功能介绍

融合项目API

URI

POST /v4/resources/{resource_uri}/histories/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

resource_uri

是

String

资源uri

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

conditions

否

Array of SearchCondition objects

搜索条件

type

否

String

资源类型

useOffset

否

Boolean

是否使用offset分页

project_id

否

String

项目ID

version_uri

否

String

分支/迭代uri

page_no

否

Integer

页码

page_size

否

Integer

每页展示条数
表4 SearchCondition

参数

是否必选

参数类型

描述

field_name

否

String

字段名

field_value

否

String

字段值

operator

否

String

数据库字段操作

sour_value

否

String

源值

tar_value

否

String

目标值

field_type

否

String

字段类型

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

status

String

success|error;

result

ResultValueListResourceHistoryVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

本次请求的受理的服务地址
表6 ResultValueListResourceHistoryVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

Array of ResourceHistoryVo objects

实际的数据类型：单个对象，集合 或 NULL

reason

String

错误信息

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表7 ResourceHistoryVo

参数

参数类型

描述

uri

String

资源历史记录Uri

author

String

资源历史记录创建人

region

String

逻辑region

changes

Array of ResourceChangeVo objects

资源历史记录字段变更列表

resource_uri

String

资源uri

resource_type

String

资源类型

version_uri

String

分支/迭代uri

creation_date

String

创建时间

create_date_timestamp

Long

创建时间时间戳

author_name

String

创建人名称

not_empty

Boolean

非空

project_id

String

项目id
表8 ResourceChangeVo

参数

参数类型

描述

only_new_value

Boolean

只展示新值

field_name

String

变更字段

old_value

String

旧值

old_tracker_name

String

旧工作项类型

new_tracker_name

String

新工作项类型

new_value

String

新值

old_key

String

原key

new_key

String

新key

old_object_value

Object

旧对象值

new_object_value

Object

新对象值

old_object_key

Object

新object key

new_object_key

Object

新object key

old_tracker_names

Object

旧tracker_names

new_tracker_names

Object

新旧tracker_names

old_board_info

Array of JSONObject objects

变更前归属看板信息，用例关联工作项信息使用

new_board_info

Array of JSONObject objects

变更后归属看板信息，用例关联工作项信息使用

old_display_ids

Array of strings

老值，用于前端展示。IPD和Xboard项目的需求和缺陷sequenceId列表，非IPD和Xboard项目的需求和缺陷Id列表。由于需求只能关联一个，所以需求取第一个值

new_display_ids

Array of strings

新值，用于前端展示。IPD和Xboard项目的需求和缺陷sequenceId列表，非IPD和Xboard项目的需求和缺陷Id列表。由于需求只能关联一个，所以需求取第一个值

old_test_item_path_name

String

变更前路径（目录名称路径）

new_test_item_path_name

String

变更后路径（目录名称路径）

custom_field_type

String

测试用例自定义字段类型
表9 JSONObject

参数

参数类型

描述

empty

Boolean

是否为空

additionalProperties

Object

变更后归属看板信息，用例关联工作项信息使用
表10 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

获取资源修改历史记录

post https://{endpoint}/v4/resources/v91j0000vq997opk/histories/batch-query

{
  "page_no" : 1,
  "project_uuid" : "30649eb093c2479d92c74c75d36ef280",
  "version_uri" : "v91i0000vq98suq1",
  "page_size" : 10,
  "type" : "TestCase"
}

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "total" : 2,
    "value" : [ {
      "uri" : "v9210000vrmhplil",
      "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3",
      "region" : "cn-north-7",
      "changes" : [ {
        "field_name" : "defectId",
        "old_key" : "",
        "new_key" : "8444611",
        "new_object_value" : [ "用例3新建" ],
        "new_object_key" : [ "8444611" ],
        "new_tracker_names" : [ "Bug" ],
        "new_board_info" : [ ],
        "new_display_ids" : [ "8444611" ]
      } ],
      "resource_uri" : "v91j0000vq997opk",
      "resource_type" : "TestCase",
      "version_uri" : "v91i0000vq98suq1",
      "creation_date" : "2024-09-10 10:49:43",
      "create_date_timestamp" : 1725936583000,
      "author_name" : "xxx"
    }, {
      "uri" : "v91i0000vrmh72fb",
      "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3",
      "region" : "cn-north-7",
      "changes" : [ {
        "field_name" : "svnScriptPath",
        "new_value" : "fail1.py"
      } ],
      "resource_uri" : "v91j0000vq997opk",
      "resource_type" : "TestCase",
      "version_uri" : "v91i0000vq98suq1",
      "creation_date" : "2024-09-10 10:39:34",
      "create_date_timestamp" : 1725935974000,
      "author_name" : "xxx"
    } ],
    "page_size" : 10,
    "page_no" : 1
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档