批量编辑工作项V2
功能介绍
批量编辑工作项。
调用方法
请参见如何调用API。
URI
POST /v2/workitem/issues
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
assigned_to_id | 否 | String | 参数解释: 模块的负责人数字id,通过获取指定项目的成员用户列表接口获取,响应消息体中的user_num_id字段的值就是模块的负责人数字id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
issue_ids | 否 | String | 参数解释: 工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10。 默认取值: 不涉及。 |
project_id | 否 | String | 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
result | result object | 参数解释: 返回结果。 取值范围: 不涉及。 |
status | String | 参数解释: 返回状态。 取值范围: success:返回成功。 error:返回失败。 |
参数 | 参数类型 | 描述 |
|---|---|---|
project | project object | 参数解释: 项目。 取值范围: 不涉及。 |
journal_ids | Array of strings | 参数解释: 历史记录id。 取值范围: 不涉及。 |
error_issues | Array of integers | 参数解释: 编辑失败的工作项。 取值范围: 不涉及。 |
versions_issues | Array of strings | 参数解释: 工作项的迭代版本。 取值范围: 不涉及。 |
success_issues | Array of strings | 参数解释: 编辑成功的工作项。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | Integer | 参数解释: 项目数字id。 取值范围: 不涉及。 |
identifier | String | 参数解释: 项目uuid。 取值范围: 不涉及。 |
total | Integer | 参数解释: 批量编辑工作项的总数。 取值范围: 不涉及。 |
close | Integer | 参数解释: 项目是否关闭。 取值范围: 0(打开) 1(关闭) |
role | Integer | 参数解释: 批量编辑数量。 取值范围: 不涉及。 |
type | String | 参数解释: 工作项类型。 取值范围: scrum。 |
archive | Boolean | 参数解释: 工作项是否归档。 取值范围: true(归档) false(未归档) |
mem_count | Integer | 参数解释: 项目数量。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v2/workitem/issues
{
"assigned_to_id" : "4091",
"issue_ids" : "9191020",
"project_id" : "5192de5eb435430c8cd41c6ae6028848"
} 响应示例
状态码:200
批量编辑工作项接口成功的响应。
{
"result" : {
"project" : {
"id" : 35138974,
"identifier" : "5192de5eb435430c8cd41c6ae6028848",
"total" : 0,
"close" : 0,
"role" : 0,
"type" : "scrum",
"archive" : true,
"mem_count" : 0
},
"journal_ids" : [ ],
"error_issues" : [ 9191020 ],
"versions_issues" : [ ],
"success_issues" : [ ]
},
"status" : "success"
} 状态码
状态码 | 描述 |
|---|---|
200 | 批量编辑工作项接口成功的响应。 |
错误码
请参见错误码。

