文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 附件管理/ 批量关联docman文件 - AddAttachments
更新时间：2025-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量关联docman文件 - AddAttachments

功能介绍

批量关联docman文件

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/resources/{resource_uri}/attachments/association

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

resource_uri

是

String

资源Uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

attachments

是

Array of TestCaseAttachmentInfo objects

文件信息

resource_type

是

String

参数解释:

资源类型

约束限制:

根据资源类型传入对应的值

取值范围:

  • TestResult，测试结果。

  • Task，测试任务。

  • TestCase，测试用例。

  • TestReport，测试报告。

默认取值:

不涉及

system_type

是

String

参数解释:

系统类型

约束限制:

根据系统类型传入对应的值

取值范围:

  • docman，docman系统。

  • testman，testman系统。

默认取值:

不涉及

version_uri

否

String

版本uri
表3 TestCaseAttachmentInfo

参数

是否必选

参数类型

描述

override

否

Boolean

参数解释

附件是否要被覆盖

约束限制

不涉及

取值范围

true|false

默认取值

不涉及

doc_id

否

String

参数解释

文档id

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

file_name

是

String

参数解释

文件名

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

file_path

否

String

参数解释

文件路径

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

file_type

否

String

参数解释:

文件类型

约束限制:

根据文件后缀扩展名填入

取值范围:

  • txt，文本文件。

  • img，图片文件。

等等

默认取值:

不涉及

file_size

否

String

参数解释

文件大小

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

override_id

否

String

参数解释

重复用例ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

related_type

否

String

参数解释:

相关类型

约束限制:

不涉及

取值范围:

  • 0，本地上传。

  • 1，关联文档。

默认取值:

不涉及

store_file_name

否

String

参数解释

保存文件名

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

system_type

否

String

参数解释:

系统类型

约束限制:

根据系统类型传入对应的值

取值范围:

  • docman，docman系统。

  • testman，testman系统。

默认取值:

不涉及

storage_system

否

String

参数解释

区分文件存储系统

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

value

Array of AttachmentVo objects

批量关联 docman 文件返回体
表5 AttachmentVo

参数

参数类型

描述

uri

String

参数解释

附件Uri

取值范围

不涉及

creator

String

参数解释

创建人

取值范围

不涉及

updator

String

参数解释

更新人

取值范围

不涉及

region

String

参数解释

逻辑region

取值范围

不涉及

doc_id

String

参数解释

文档id

取值范围

不涉及

parent_uri

String

参数解释

父节点Uri

取值范围

不涉及

parent_type

String

参数解释:

父节点类型

取值范围:

  • exportFile，导出用例文件附件。

  • exportErrorFile，导出错误用例文件附件。

file_name

String

参数解释

文件名

取值范围

不涉及

store_file_name

String

参数解释

保存文件名

取值范围

不涉及

file_path

String

参数解释

文件路径

取值范围

不涉及

file_size

Integer

参数解释

文件大小

取值范围

不涉及

file_type

String

参数解释:

文件类型

约束限制:

根据文件后缀扩展名填入

取值范围:

  • txt，文本文件。

  • img，图片文件。

等等

默认取值:

不涉及

system_type

String

参数解释:

系统类型

约束限制:

根据系统类型传入对应的值

取值范围:

  • docman，docman系统。

  • testman，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，本地上传。

  • 1，关联文档。

默认取值:

不涉及

状态码：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/f3087a82b44744c29a1bd69ab6ada154/resources/2dopbu6aaf/attachments/association

{
  "resource_type" : "TestCase",
  "system_type" : "docman",
  "attachments" : [ {
    "file_name" : "250KB.png",
    "store_file_name" : "fe46fd23c5f94d5abf0f920ccd717cda",
    "file_size" : 255568,
    "file_type" : "png",
    "doc_id" : 0
  } ]
}

响应示例

状态码：200

OK

{
  "value" : [ {
    "project_uuid" : "4f36d90bf1c244b0a41b454f61b33d68",
    "file_path" : "roma-guian-2/dolphindrive/bc0d30a4f35541dca361a580dccb5a0d/250KB_20251016144014.png",
    "creator" : "a17801c5d15f46e28112eec8a880683d",
    "file_name" : "250KB.png",
    "parent_type" : "TestCase",
    "uri" : "v90100010rvggbk5",
    "doc_id" : "",
    "storage_system" : "CodeArtsWiki",
    "file_size" : 255568,
    "store_file_name" : "fe46fd23c5f94d5abf0f920ccd717cda",
    "system_type" : "docman",
    "file_type" : "png",
    "parent_uri" : "v90200010rt5g4ur",
    "region" : "roma-guian-2"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 附件管理

相关文档