文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 更新工作项
更新时间：2022-12-08 GMT+08:00
查看PDF
分享

更新工作项

功能介绍

更新工作项

URI

PUT /v4/projects/{project_id}/issues/{issue_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

devcloud项目的32位id

最小长度：32

最大长度：32

issue_id

是

Integer

工作项id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：10

最大长度：32768
表3 请求Body参数

参数

是否必选

参数类型

描述

actual_work_hours

否

Double

实际工时

assigned_id

否

Integer

处理人id,对应用户信息的数字id

begin_time

否

String

开始时间，年-月-日

description

否

String

描述信息

developer_id

否

Integer

开发者id,对应用户信息的数字id

domain_id

否

Integer

领域id

done_ratio

否

Integer

工作项进度值

end_time

否

String

结束时间，年-月-日

expected_work_hours

否

Double

预计工时

iteration_id

否

Integer

迭代id

module_id

否

Integer

模块id

name

否

String

标题

parent_issue_id

否

Integer

父工作项的id

priority_id

否

Integer

优先级, 1 低, 2 中, 3 高,

severity_id

否

Integer

重要程度, 10 关键, 11 重要, 12 一般, 13 提示,

status_id

否

Integer

状态 id, 新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已解决 6,

tracker_id

否

Integer

工作项类型,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story

new_custom_fields

否

Array of NewCustomField objects

用户自定义字段
表4 NewCustomField

参数

是否必选

参数类型

描述

custom_field

否

String

自定义字段

field_name

否

String

自定义字段名称

value

否

String

自定义属性对应的值，多个值以英文逗号区分开

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

actual_work_hours

Double

实际工时

assigned_cc_user

Array of IssueUser objects

抄送人

assigned_user

IssueUser object

begin_time

String

预计开始时间，年-月-日

created_time

String

创建时间 年-月-日 时:分:秒

creator

IssueUser object

custom_fields

Array of CustomField objects

自定义属性值,不建议使用，建议参考new_custom_fields字段

new_custom_fields

Array of NewCustomField objects

自定义属性值

developer

IssueUser object

domain

domain object

id, 领域 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性'

done_ratio

Integer

工作项进度值

end_time

String

预计结束时间，年-月-日

expected_work_hours

Double

预计工时

id

Integer

工作项项id

project

IssueProjectResponseV4 object

项目信息

iteration

iteration object

迭代

module

module object

模块

name

String

标题

parent_issue

parent_issue object

父工作项

priority

priority object

工作项优先级

severity

severity object

工作项重要程度

status

status object

工作项状态

tracker

tracker object

工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story

updated_time

String

更新时间 年-月-日 时:分:秒

closed_time

String

关闭时间 年-月-日 时:分:秒
表6 IssueUser

参数

参数类型

描述

user_id

String

用户uuid

user_num_id

Integer

用户数字id

id

Integer

用户id

name

String

用户名

nick_name

String

昵称
表7 CustomField

参数

参数类型

描述

name

String

自定义属性名

value

String

自定义属性对应的值

new_name

String

自定义属性名
表8 NewCustomField

参数

参数类型

描述

custom_field

String

自定义字段

field_name

String

自定义字段名称

value

String

自定义属性对应的值，多个值以英文逗号区分开
表9 domain

参数

参数类型

描述

id

Integer

领域id

name

String

领域
表10 IssueProjectResponseV4

参数

参数类型

描述

project_id

String

项目id

project_name

String

项目名称

project_num_id

Integer

项目数字id
表11 iteration

参数

参数类型

描述

id

Integer

迭代id

name

String

迭代名
表12 module

参数

参数类型

描述

id

Integer

模块id

name

String

模块
表13 parent_issue

参数

参数类型

描述

id

Integer

父工作项id

name

String

父工作项
表14 priority

参数

参数类型

描述

id

Integer

优先级id

name

String

优先级
表15 severity

参数

参数类型

描述

id

Integer

重要程度id

name

String

重要程度
表16 status

参数

参数类型

描述

id

Integer

状态id

name

String

状态名称
表17 tracker

参数

参数类型

描述

id

Integer

类型id

name

String

类型名称

状态码： 400

表18 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表19 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

PUT https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921

{
  "status_id" : 2
}

响应示例

状态码： 200

OK

{
  "actual_work_hours" : 0,
  "assigned_cc_user" : [ {
    "id" : 4091,
    "name" : " demo_user",
    "nick_name" : "demo"
  } ],
  "assigned_user" : {
    "id" : 4091,
    "name" : " demo_user",
    "nick_name" : "demo"
  },
  "begin_time" : "2020-09-12",
  "created_time" : "2020-09-13 14:40:11",
  "creator" : {
    "id" : 4091,
    "name" : " demo_user",
    "nick_name" : "demo"
  },
  "custom_fields" : [ {
    "name" : "customField16",
    "value" : "select1",
    "new_name" : "custom_field16"
  } ],
  "new_custom_fields" : [ {
    "custom_field" : "custom_field16",
    "field_name" : "field_name",
    "value" : "select1,select2"
  } ],
  "developer" : {
    "id" : 4091,
    "name" : " demo_user",
    "nick_name" : "demo"
  },
  "domain" : {
    "id" : 14,
    "name" : "性能"
  },
  "done_ratio" : 0,
  "end_time" : "2020-09-19",
  "expected_work_hours" : 9,
  "id" : 4567,
  "project" : {
    "project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
    "project_name" : "testDemo",
    "project_num_id" : 78953
  },
  "iteration" : {
    "id" : 456,
    "name" : "iteration1"
  },
  "module" : {
    "id" : 456,
    "name" : "Project"
  },
  "name" : "issue name",
  "parent_issue" : {
    "id" : 123,
    "name" : "parent issue name"
  },
  "priority" : {
    "id" : 1,
    "name" : "低"
  },
  "severity" : {
    "id" : 12,
    "name" : "一般"
  },
  "status" : {
    "id" : 1,
    "name" : "新建"
  },
  "tracker" : {
    "id" : 7,
    "name" : "story"
  },
  "updated_time" : "2020-09-14 14:40:11",
  "closed_time" : "2020-09-15 14:40:11"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。