文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 附件管理/ 上传测试报告背景设置图片 - UploadBackground
更新时间:2025-12-27 GMT+08:00
分享

上传测试报告背景设置图片 - UploadBackground

功能介绍

此接口用于上传测试报告背景设置图片

测试设置 -> 测试报告设置 -> 上传图片

调用方法

请参见如何调用API

URI

POST /v4/{project_id}/background/upload

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

background_type

String

参数解释:

图片类型

约束限制:

根据图片类型传入对应的值

取值范围:

  • cover,封面。

  • background,背景。

  • logo,标志。

默认取值:

不涉及

请求参数

表3 FormData参数

参数

是否必选

参数类型

描述

param

File

背景图片

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

value

BackgroundInfoVo object

上传测试报告背景设置图片返回体

表5 BackgroundInfoVo

参数

参数类型

描述

project_uuid

String

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

cover_file_name

String

覆盖文件名称

background_file_name

String

背景文件名称

logo_file_name

String

图标文件名称

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

post https://{endpoint}/v4/efdb403066474ab08836b9eeaaa23bca/background/upload?background_type=background

file:binary

响应示例

状态码:200

OK

{
  "value" : {
    "project_uuid" : "4f36d90bf1c244b0a41b454f61b33d68",
    "cover_file_name" : "",
    "logo_file_name" : "",
    "background_file_name" : "background.png"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档