批量关联docman文件
功能介绍
批量关联docman文件
调用方法
请参见如何调用API。
URI
POST /v4/{project_id}/resources/{resource_uri}/attachments/association
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
|
resource_uri |
是 |
String |
资源Uri |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
attachments |
否 |
Array of TestCaseAttachmentInfo objects |
文件信息 |
|
resource_type |
否 |
String |
资源类型 |
|
system_type |
否 |
String |
系统类型 |
|
version_uri |
否 |
String |
版本uri |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
override |
否 |
Boolean |
参数解释 附件是否要被覆盖 约束限制 不涉及 取值范围 true|false 默认取值 不涉及 |
|
doc_id |
否 |
String |
参数解释 文档id 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
file_name |
否 |
String |
参数解释 文件名 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
file_path |
否 |
String |
参数解释 文件路径 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
file_type |
否 |
String |
参数解释 文件类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
file_size |
否 |
String |
参数解释 文件大小 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
override_id |
否 |
String |
参数解释 重复用例ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
related_type |
否 |
String |
参数解释 相关类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
store_file_name |
否 |
String |
参数解释 保存文件名 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
system_type |
否 |
String |
参数解释 系统区分 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
storage_system |
否 |
String |
参数解释 区分文件存储系统 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error |
|
result |
ResultValueListAttachmentVo object |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释 总数据量 取值范围 不涉及 |
|
value |
Array of AttachmentVo objects |
参数解释 请求返回的数据 取值范围 实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
参数解释 业务失败的提示内容 取值范围 不涉及 |
|
page_size |
Integer |
参数解释 分页大小 取值范围 不涉及 |
|
page_no |
Integer |
参数解释 分页编码 取值范围 不涉及 |
|
has_more |
Boolean |
参数解释 是否有更多 取值范围 true:是 false:否 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 关联文档 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
post https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154}/resources/2dopbu6aaf/attachments/association
{
"version_uri" : "2dopbu6aaf",
"attachments" : [ {
"override" : true,
"file_name" : "aa.txt",
"file_path" : "/opt/cloud"
} ]
}
响应示例
状态码：200
批量关联docman文件返回体
{
"status" : "success",
"result" : {
"value" : {
"uri" : "v92s10cmov8ek1jd",
"doc_id" : "1322",
"file_path" : "/opt/cloud"
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
批量关联docman文件返回体 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
