文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD附件管理/ 上传图片到工作项描述中
更新时间:2025-08-11 GMT+08:00
分享

上传图片到工作项描述中

功能介绍

上传图片并更新到工作项描述中

调用方法

请参见如何调用API

URI

POST /v2/ipdprojectservice/projects/{project_id}/images

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

正则表达式,^[A-Za-z0-9]{32}$。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

issue_id

String

参数解释:工作项唯一Id。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID

约束限制:正则表达式,^([0-9]{18,19})$

默认取值:不涉及

请求参数

表3 FormData参数

参数

是否必选

参数类型

描述

file

File

上传的图片内容,当前支持jpg,jpeg,png,gif,bmp,tiff,svg格式的图片

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

请求状态,成功为success,失败时会抛出异常

message

String

请求信息,一般情况为空。

result

IssueEntity object

工作项详情信息

表5 IssueEntity

参数

参数类型

描述

id

String

参数解释:

需要更新的工作项id,可通过查询树状工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

正则表达式,^([0-9]{18,19})$

取值范围:

不涉及。

默认取值:

不涉及。

title

String

参数解释:

工作项标题,可通过查询树状工作项接口获取,响应消息体中的title字段的值就是工作项标题。

约束限制:

最小长度:1,最大长度:256。

取值范围:

不涉及。

默认取值:

不涉及。

description

String

参数解释:

工作项描述字段,可通过查询树状工作项接口获取,响应消息体中的description字段的值就是工作项描述字段。

约束限制:

最小长度:1,最大长度:50000。

取值范围:

不涉及。

默认取值:

不涉及。

type

String

参数解释:

工作项大分类定义。工作项创建、编辑无此字段,仅作展示用,可通过查询树状工作项接口获取,响应消息体中的type字段的值就是工作项大分类定义。

约束限制:

最小长度:0,最大长度:128。

取值范围:

requirement(研发需求),bug(缺陷),task(任务),feature(特性),raw_requirement(原始需求)。

默认取值:

不涉及。

number

String

参数解释:

工作项编号,可通过查询树状工作项接口获取,响应消息体中的number字段的值就是工作项编号

约束限制:

最小长度:0,最大长度:128。

取值范围:

不涉及。

默认取值:

不涉及。

category

String

参数解释:

工作项类型,可通过查询树状工作项接口获取,响应消息体中的category字段的值就是工作项类型

约束限制:

不涉及。

取值范围:

系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug。

独立软件类项目可选值为:RR/SF/IR/US/Task/Bug。

云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。

默认取值:

不涉及。

parent_id

String

参数解释:

父工作项id,可通过查询树状工作项接口获取,响应消息体中的parent_id字段的值就是父工作项id

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

正则表达式,[A-Za-z0-9]{32}。

取值范围:

不涉及

默认取值

不涉及。

status

String

参数解释:

工作项状态code,可通过查询树状工作项接口获取,响应消息体中的status字段的值就是工作项状态code。

约束限制:

最小长度:2,最大长度:32。

取值范围:

不涉及。

默认取值:

不涉及。

state

String

参数解释:

工作项的生命周期,可选值为"正在工作","作废",可通过查询树状工作项接口获取,响应消息体中的state字段的值就是工作项的生命周期。

约束限制:

最小长度:2,最大长度:8。

取值范围:

正在工作,作废。

默认取值:

不涉及。

assignee

UserEntity object

参数解释:

工作项责任人。

assigned_cc

Array of UserEntity objects

参数解释:

工作项抄送人,支持多个抄送人。同一工作项最多支持50个抄送人。

created_by

UserEntity object

参数解释:

工作项创建人。

created_time

String

参数解释:

工作项创建时间,unix时间戳,单位:毫秒。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

modified_by

UserEntity object

参数解释:

工作项最近更新人。

modified_time

String

参数解释:

工作项最近更新时间,unix时间戳,单位:毫秒。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

plan_end_date

String

参数解释:

工作项计划结束日期,unix时间戳,单位:毫秒。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

close_time

String

参数解释:

工作项关闭时间,unix时间戳,单位:毫秒。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

workload

String

参数解释:

工作项计划工时,保留一位小数,取值范围为0~999999999.9。

约束限制:

不涉及。

取值范围:

0~999999999.9。

默认取值:

不涉及。

workload_sum

String

参数解释:

工作项计划工时,保留一位小数,取值范围为0~999999999.9,不可编辑。

约束限制:

最小长度:0,最大长度:11。

取值范围:

0~999999999.9。

默认取值:

不涉及。

tenant_id

String

参数解释:

工作项所属租户id,可通过查询树状工作项接口获取,响应消息体中的tenant_id字段的值就是工作项所属租户id。

约束限制:

最小长度:32,最大长度:32。

取值范围:

不涉及。

默认取值:

不涉及。

link

String

参数解释:

工作项关联项id,多个关联项用英文逗号分隔,同一工作项最多支持50个关联项,可通过查询树状工作项接口获取,响应消息体中的link字段的值就是工作项关联项id。

约束限制:

最小长度:0,最大长度:2048。

取值范围:

不涉及。

默认取值:

不涉及。

suspended

Boolean

参数解释:

工作项是否已挂起。

约束限制:

不涉及。

取值范围:

true,false。

默认取值:

不涉及。

status_modified_time

String

参数解释:

工作项状态改变时间,可用于计算工作项在当前状态停留天数,unix时间戳,单位:毫秒。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

labels

Array of LabelEntity objects

参数解释:

工作项标签。

custom_fields

Array of FieldCodeValuePair objects

参数解释:

工作项自定义字段映射,用户添加的系统字段也在此列

{

"code":"字段code",

"value":"字段值"

}。

children

Array of IssueEntity objects

参数解释:

工作项的子工作项集合。

path

String

参数解释:

子工作项的路径。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

ir2feature

String

参数解释:

IR和FE的关联字段,工作项类型为IR时,有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

need_break

String

参数解释:

工作项是否需要分解,仅可以分解的工作项类型有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

break_status

String

参数解释:

分解状态,

已分解(decomposed)

未分解(undecomposed)

不涉及( --)。

约束限制:

不涉及。

取值范围:

decomposed,undecomposed,--。

默认取值:

不涉及。

baseline

String

参数解释:

工作项基线状态,

未基线(null)

已基线(baselined)

基线评审中(baseline-reviewing)。

约束限制:

不涉及。

取值范围:

null,baselined,baseline-reviewing。

默认取值:

不涉及。

priority

String

参数解释:

工作项优先级,部分工作项有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

related_network_security

String

参数解释:

是否涉及网络安全。预设字段中,仅研发需求有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

collaboratives

String

参数解释:

研发需求协同信息,协同任务id,可通过查询树状工作项接口获取,响应消息体中的collaboratives字段的值就是研发需求协同信息,协同任务id。

约束限制:

最小长度:0,最大长度:256。

取值范围:

不涉及。

默认取值:

不涉及。

business_domain

String

参数解释:

领域字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

plan_pi

String

参数解释:

工作项发布计id,可通过查询树状工作项接口获取,响应消息体中的plan_pi字段的值就是工作项发布计id。

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

plan_iteration

String

参数解释:

工作项完成的迭代计划id,在Bug中为修复迭代计划id,可通过查询树状工作项接口获取,响应消息体中的plan_iteration字段的值就是迭代计划id。

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

change_status

String

参数解释:

工作项变更状态,

变更评审中(change-reviewing)

已变更(changed)

未变更(unchange或null)。

约束限制:

最小长度:0,最大长度:32。

取值范围:

change-reviewing,changed,unchange,null。

默认取值:

不涉及。

no_break_reason

String

参数解释:

无需分解原因,need_break=no时有此字段

约束限制:

最小长度:0,最大长度:512。

取值范围:

不涉及。

默认取值:

不涉及。

submitted_by

Array of UserEntity objects

参数解释:

工作项提出人。

ir2rr

String

参数解释:

IR关联的RR id,多选时用英文逗号分隔。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

feature_set

String

参数解释:

特性集id,可通过查询树状工作项接口获取,响应消息体中的feature_set字段的值就是特性集id。

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

expected_repair_date

String

参数解释:

期望修复时间。预设字段中,仅Bug有此字段,unix时间戳,单位:毫秒。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

found_pi

String

参数解释:

缺陷发现发布计划id,预设字段中,仅Bug有此字段,可通过查询树状工作项接口获取,响应消息体中的found_pi字段的值就是缺陷发现发布计划id。

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

found_iteration

String

参数解释:

缺陷发现迭代计划id,预设字段中,仅Bug有此字段,可通过查询树状工作项接口获取,响应消息体中的found_iteration字段的值就是缺陷发现迭代计划id。

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

reason_analysis

String

参数解释:

分析原因。预设字段中,仅Bug有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

repair_solution

String

参数解释:

修复方案。预设字段中,仅Bug有此字段。

约束限制:

最小长度:0,最大长度:50000。

取值范围:

不涉及。

默认取值:

不涉及。

test_report

String

参数解释:

测试报告。预设字段中,仅Bug有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sys_no_repair_reason

String

参数解释:

无需修复原因。预设字段中,仅Bug有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sys_activation_reason

String

参数解释:

激活原因。预设字段中,仅Bug有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sys_return_reason

String

参数解释:

退回原因。预设字段中,仅Bug有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

test_failures_times

Integer

参数解释:

回归不通过次数。预设字段中,仅Bug有此字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

close_type

String

参数解释:

关闭类型。预设字段中,仅Bug有此字段,可选值为problem_solved,problem_to_requirement,duplicate_problem,not_a_problem。分别对应问题解决关闭,问题转需求关闭,重复问题关闭,非问题关闭。

约束限制:

不涉及。

取值范围:

problem_solved,problem_to_requirement,duplicate_problem,not_a_problem。

默认取值:

不涉及。

plan_owner

UserEntity object

参数解释:

工作项规划责任人。

doing_owner

UserEntity object

参数解释:

工作项实现责任人。

delivered_owner

UserEntity object

参数解释:

工作项交付责任人。

checking_owner

UserEntity object

参数解释:

工作项验收责任人。

test_owner

UserEntity object

参数解释:

工作项测试责任人。

develop_owner

UserEntity object

参数解释:

工作项开发责任人。

processing_owner

UserEntity object

参数解释:

工作项处理中责任人。

fixed_owner

UserEntity object

参数解释:

工作项修复责任人。

researchanddevelop_owner

UserEntity object

参数解释:

工作项研发责任人。

analyse_owner

UserEntity object

参数解释:

工作项分析责任人。

表6 LabelEntity

参数

参数类型

描述

id

String

参数解释:

标签id,可通过查询标签列表接口获取,响应消息体中的id字段的值就是标签id。

约束限制:

正则表达式,^([0-9]{18,19})$。

取值范围:

不涉及。

默认取值:

不涉及。

label_type

String

参数解释:

标签所属工作项类型,对应工作项的type字段。

约束限制:

最小长度:0,最大长度:32。

取值范围:

不涉及。

默认取值:

不涉及。

color

String

参数解释:

标签颜色RGB。

约束限制:

最小长度:0,最大长度:16。

取值范围:

不涉及。

默认取值:

不涉及。

title

String

参数解释:

标签标题。

约束限制:

最小长度:2,最大长度:256。

取值范围:

不涉及。

默认取值:

不涉及。

表7 FieldCodeValuePair

参数

参数类型

描述

code

String

参数解释:

工作项字段code值。

约束限制:

最小长度:0,最大长度:32。

取值范围:

不涉及。

默认取值:

不涉及。

value

String

参数解释:

工作项自定义字段值,为多选时用英文逗号分隔。

约束限制:

最小长度:0,最大长度:10000。

取值范围:

不涉及。

默认取值:

不涉及。

表8 UserEntity

参数

参数类型

描述

id

String

参数解释:

用户id,可通过获取当前用户信息接口获取,响应消息体中的id字段的值就是用户id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

用户名称。

约束限制:

最小长度:2,最大长度:64。

取值范围:

不涉及。

默认取值:

不涉及。

nick_name

String

参数解释:

用户昵称。

约束限制:

最小长度:2,最大长度:30。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

/v2/ipdprojectservice/projects/e2569a971657464f810949e839ec5640/images?issue_id=1071125987320569856

file=xxxx.png

响应示例

状态码:200

上传成功

{
  "status" : "success",
  "message" : null,
  "result" : {
    "id" : "1061975230944026625",
    "title" : "Task-01",
    "description" : "<p>【任务背景】</p><p><br></p><p>【任务价值】</p><p><br></p><p>【任务详情】</p>",
    "number" : "TASK20241109690657",
    "category" : "Task",
    "status" : "Start",
    "assignee" : {
      "id" : "a360371833bf4c558f796fd707b44daf"
    },
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf"
    },
    "created_time" : "2024-11-09T11:50:25Z",
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf"
    },
    "modified_time" : "2024-11-09T11:50:25Z",
    "custom_fields" : [ ]
  }
}

状态码

状态码

描述

200

上传成功

错误码

请参见错误码

相关文档