文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报告管理/ 获取测试报告的模板设置
更新时间：2025-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取测试报告的模板设置

功能介绍

获取测试报告的模板设置

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/background

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释

符合条件的所有记录数

取值范围

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

value

BackgroundInfoVo object

参数解释

测试报告背景设置信息

取值范围

不涉及

reason

String

参数解释

错误信息

取值范围

业务失败的提示内容

page_size

Integer

参数解释

每页展示条数

取值范围

不涉及

page_no

Integer

参数解释

页码

取值范围

不涉及

has_more

Boolean

参数解释

是否有更多

取值范围

true:是 false:否
表4 BackgroundInfoVo

参数

参数类型

描述

project_uuid

String

参数解释

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

取值范围

长度等于32位，包含大小写字母、数字

cover_file_name

String

参数解释

cover文件名称

取值范围

不涉及

background_file_name

String

参数解释

背景文件名称

取值范围

不涉及

logo_file_name

String

参数解释

logo文件名称

取值范围

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：401

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：404

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：500

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

请求示例

GET https://{endpoint}/GT3KServer/v4/90f8dc52eb7b4c47b853c661152ca62d/background

响应示例

状态码：200

OK

{
  "value" : {
    "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d",
    "cover_file_name" : "cover.png",
    "background_file_name" : "background.png",
    "logo_file_name" : "logo.png"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报告管理

相关文档