查询附件列表
功能介绍
查询附件列表
调用方法
请参见如何调用API。
URI
GET /v4/{project_id}/resources/{resource_uri}/attachments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
resource_uri |
是 |
String |
参数解释 资源Uri 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resource_type |
是 |
String |
参数解释 资源类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
请求示例
GET https://{endpoint}/GT3KServer/v4/90f8dc52eb7b4c47b853c661152ca62d/resources/v901000109n3a3mt/attachments?resource_type=TestCase
响应示例
状态码:200
OK
{ "value" : [ { "uri" : "v90b000109n4c8kn", "creator" : "dfc5347b9b16491e942ce55ce7f79dbc", "region" : { "region" : null }, "doc_id" : "", "parent_uri" : "v901000109n3a3mt", "parent_type" : "TestCase", "file_name" : "20220802-091407(WeLinkPC).png", "store_file_name" : "20220802-091407(WeLinkPC).png", "file_path" : "attachment_obs/90f8dc52eb7b4c47b853c661152ca62d/TestCase/v901000109n3a3mt/20220802-091407(WeLinkPC).png", "file_size" : 67962, "system_type" : "testman", "create_time" : "2025-03-03 15:54:12", "create_time_timestamp" : 1740988452000, "update_time" : "2025-03-03 15:54:12", "update_time_timestamp" : 1740988452000, "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。