更新时间:2024-11-19 GMT+08:00
分享

查询附件列表

功能介绍

查询附件列表

URI

GET /GT3KServer/v4/{project_id}/resources/{resource_uri}/attachments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

resource_uri

String

资源Uri

表2 Query参数

参数

是否必选

参数类型

描述

resource_type

String

资源类型

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

value

Array of AttachmentVo objects

实际的数据类型:单个对象,集合 或 NULL

表5 AttachmentVo

参数

参数类型

描述

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

项目id

related_type

String

附件类型 0 本地上传 other 关联文档

状态码: 400

表6 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 401

表7 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 404

表8 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 500

表9 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档