文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报告表管理/ 根据测试报告Uri获取测试报告自定义模块列表
更新时间:2025-07-24 GMT+08:00
分享

根据测试报告Uri获取测试报告自定义模块列表

功能介绍

根据测试报告Uri获取测试报告自定义模块列表

调用方法

请参见如何调用API

URI

GET /v4/{project_id}/versions/{version_uri}/test-reports/{report_uri}/custom-infos

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

version_uri

String

计划uri

report_uri

String

测试报告Uri

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListTestReportCustomDetailVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

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

表3 ResultValueListTestReportCustomDetailVo

参数

参数类型

描述

total

Integer

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

value

Array of TestReportCustomDetailVo objects

实际的数据类型:单个对象,集合 或 NULL

reason

String

业务失败的提示内容,对内接口才有此值

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多

表4 TestReportCustomDetailVo

参数

参数类型

描述

uri

String

测试报告自定义模块Uri

name

String

测试报告自定义模块名称

display

Integer

是否显示(0:否,1:是)

description

String

描述

attachments

Array of AttachmentVo objects

附件信息

creator

String

创建人ID

updator

String

修改人ID

test_report_uri

String

测试报告uri

create_time

String

创建时间

create_timestamp

Long

创建时间戳

creator_name

String

创建人名

update_time

String

修改时间

update_timestamp

Long

修改时间戳

updator_name

String

修改人名

表5 AttachmentVo

参数

参数类型

描述

uri

String

参数解释

附件Uri

取值范围

不涉及

creator

String

参数解释

创建人

取值范围

不涉及

updator

String

参数解释

更新人

取值范围

不涉及

region

String

参数解释

逻辑region

取值范围

不涉及

doc_id

String

参数解释

文档id

取值范围

不涉及

parent_uri

String

参数解释

父节点Uri

取值范围

不涉及

parent_type

String

参数解释

父节点类型

取值范围

不涉及

file_name

String

参数解释

文件名

取值范围

不涉及

store_file_name

String

参数解释

保存文件名

取值范围

不涉及

file_path

String

参数解释

文件路径

取值范围

不涉及

file_size

Integer

参数解释

文件大小

取值范围

不涉及

file_type

String

参数解释

文件类型

取值范围

不涉及

system_type

String

参数解释

系统区分

取值范围

docman或testman

create_time

String

参数解释

创建时间

取值范围

不涉及

create_time_timestamp

Long

参数解释

创建时间时间戳

取值范围

不涉及

update_time

String

参数解释

更新时间

取值范围

不涉及

update_time_timestamp

Long

参数解释

更新时间时间戳

取值范围

不涉及

project_uuid

String

参数解释

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

取值范围

不涉及

related_type

String

参数解释

附件类型

取值范围

0 本地上传 other 关联文档

表6 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154/versions/2dopbu6aaf/test-reports/1222/custom-infos

响应示例

状态码:200

根据测试报告Uri获取测试报告自定义模块列表返回体

{
  "status" : "success",
  "result" : {
    "value" : {
      "uri" : "v92u00010id84o7m",
      "name" : "测试报告",
      "display" : 1,
      "description" : "描述"
    }
  }
}

状态码

状态码

描述

200

根据测试报告Uri获取测试报告自定义模块列表返回体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档