文档首页/ 需求管理 CodeArts Req/ API参考/ API/ OpenAPI管理/ 查询工作项附件列表
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

查询工作项附件列表

功能介绍

查询工作项附件列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/ipdprojectservice/projects/{project_id}/attachments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

工作项所属项目Id
表2 Query参数

参数

是否必选

参数类型

描述

issue_id

是

String

工作项Id

source_project_id

是

String

当工作项类型为RR或Bug时，在提出项目查询提给外部的工作项附件时，project_id为提出 项目Id，source_project_id为工作项归属项目Id。其他场景非必填。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态

message

String

信息

result

Array of AttachmentEntity objects

附件列表
表4 AttachmentEntity

参数

参数类型

描述

id

String

附件Id

issue_id

String

附件所属工作项Id

file_size

Long

附件大小，单位为Byte，单个附件最大为50MB

file_name

String

附件原名称

attachment_type

String

附件类型，即文件扩展名

modified_by

UserEntity object

修改人

created_by

UserEntity object

创建人

created_date

String

附件上传时间的时间戳
表5 UserEntity

参数

参数类型

描述

id

String

用户Id

name

String

用户名称

nick_name

String

用户昵称

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{url}/v1/ipdprojectservice/projects/68158c24d6d14e48bab08befefae150f/attachments?issue_id=984407816014831616

响应示例

状态码： 200

附件响应

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "id" : "984409429450334208",
    "issue_id" : "984407816014831616",
    "file_size" : "79234",
    "file_name" : "IPD系统设备-缺陷-导入模板.xlsx",
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试账号"
    },
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试账号"
    },
    "attachment_type" : "xlsx",
    "created_date" : "1712631097000"
  } ]
}

状态码： 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

状态码

状态码

描述

200

附件响应

400

通用错误响应

错误码

请参见错误码。

父主题： OpenAPI管理

相关文档