删除工作项
功能介绍
删除工作项。
调用方法
请参见如何调用API。
URI
POST /v3/issue/delete
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
call_back_param |
否 |
call_back_param object |
参数解释: 删除工作项的请求参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
type |
否 |
String |
参数解释: 工作项操作类型。 约束限制: 不涉及。 取值范围: deleteIssue。 默认取值: deleteIssue。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
issue_id |
否 |
String |
参数解释: 工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10。 默认取值: 不涉及。 |
|
type |
否 |
String |
参数解释: 项目的类型。 约束限制: 不涉及。 取值范围: scrum。 默认取值: scrum。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
result object |
参数解释: 返回结果。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 返回状态。 取值范围: success:返回成功。 error:返回失败。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
deleted_issues |
Array of deleted_issues objects |
参数解释: 删除工作项。 取值范围: 不涉及。 |
|
delete_attachment_files |
Array of strings |
参数解释: 删除的附件文件。 取值范围: 不涉及。 |
|
issues |
Array of issues objects |
参数解释: 工作项。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 删除工作项id。 取值范围: 不涉及。 |
|
subject |
String |
参数解释: 删除工作项名称。 取值范围: 不涉及。 |
|
author |
IssueAuthorVO object |
参数解释: 用户。 取值范围: 不涉及。 |
|
created_on |
String |
参数解释: 工作项的创建时间,时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
|
updated_on |
String |
参数解释: 工作项的更新时间,时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 工作项的描述。 取值范围: 不涉及。 |
|
expected_work_hours |
Integer |
参数解释: 工作项的预计工时(单位:人/时)。 取值范围: 不涉及。 |
|
actual_work_hours |
Integer |
参数解释: 工作项的实际工时(单位:人/时)。 取值范围: 不涉及。 |
|
is_watcher |
Boolean |
参数解释: 是否订阅信息。 取值范围: true(可见) false(不可见) |
|
project |
Project object |
参数解释: 项目 。 取值范围: 不涉及。 |
|
tracker |
Tracker object |
参数解释: 工作项类型。 取值范围: 不涉及。 |
|
status |
Status object |
参数解释: 工作项的状态。 取值范围: 不涉及。 |
|
status_attribute |
StatusAttribute object |
参数解释: 状态属性。 取值范围: 不涉及。 |
|
priority |
Priority object |
参数解释: 优先级。 取值范围: 不涉及。 |
|
assigned_to |
IssueAssignedVO object |
参数解释: 项目负责人。 取值范围: 不涉及。 |
|
developer |
Object |
参数解释: 开发者。 取值范围: 不涉及。 |
|
closeder |
Object |
参数解释: 项目关闭人员。 取值范围: 不涉及。 |
|
fixed_version |
Object |
参数解释: 固定版本。 取值范围: 不涉及。 |
|
severity |
Severity object |
参数解释: 重要程度。 取值范围: 不涉及。 |
|
order |
Order object |
参数解释: 工作项的排序。 取值范围: 不涉及。 |
|
domain |
Object |
参数解释: 工作项的领域。 取值范围: 不涉及。 |
|
module |
Object |
参数解释: 工作项的模块。 取值范围: 不涉及。 |
|
story_point |
StoryPoint object |
参数解释: 工作项的故事点。 取值范围: 不涉及。 |
|
release_dev |
String |
参数解释: 工作项发布开发版。 取值范围: 不涉及。 |
|
find_release_dev |
String |
参数解释: 发布人。 取值范围: 不涉及。 |
|
assigned_cc_user |
Array of strings |
参数解释: 抄送人。 取值范围: 不涉及。 |
|
has_httachments |
Boolean |
参数解释: 是否有附件。 取值范围: true(有附件) false(没有附件) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
first_name |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
|
last_name |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
|
identifier |
String |
参数解释: 作者唯一标识。 取值范围: 不涉及。 |
|
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
|
assigned_nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 带租户信息的用户名(租户名称_用户名)。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 用户id。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
identifier |
String |
参数解释: 项目uuid。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 项目名称。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 项目数字id。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 项目类型。 取值范围: scrum。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 类型名称。 取值范围: Task。 Bug。 Epic。 Feature。 Story。 |
|
id |
Integer |
参数解释: 类型id。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 状态名称 取值范围: 新建 进行中 已解决 测试中 已关闭 已拒绝 |
|
id |
Integer |
参数解释: 状态id。 取值范围: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
参数解释: 项目32位UUID。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 名称。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 工作项的优先级。 取值范围: 低。 中。 高。 |
|
id |
Integer |
参数解释: 优先级id 。 取值范围: 1(低) 2(中) 3(高) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
first_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
|
last_name |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
|
identifier |
String |
参数解释: 用户32位uuid。 取值范围: 不涉及。 |
|
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
|
assigned_nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 用户数字id。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v3/issue/delete
{
"call_back_param" : {
"project_id" : "5192de5eb435430c8cd41c6ae6028848",
"issue_id" : "9186305",
"type" : "scrum"
},
"type" : "deleteIssue"
}
响应示例
状态码:200
删除工作项接口成功的响应。
{
"result" : {
"deleted_issues" : [ {
"id" : 9186305,
"subject" : "123",
"author" : {
"identifier" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_s00404480_01",
"last_name" : "devcloud_devcloud_s00404480_01",
"id" : 4091,
"first_name" : "devcloud_devcloud_s00404480_01"
},
"created_on" : "2025-07-25T11:46:55Z",
"updated_on" : "2025-07-25T11:46:55Z",
"description" : "<p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 作为 </span><用户角色></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 我想要 </span><结果></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 以便于 </span><目的> </p>",
"expected_work_hours" : 0,
"actual_work_hours" : 0,
"is_watcher" : false,
"project" : {
"identifier" : "5192de5eb435430c8cd41c6ae6028848",
"name" : "DevOps全流程示例项目XXXX",
"id" : 35138974
},
"tracker" : {
"name" : "Story",
"id" : 7
},
"status" : {
"name" : "新建",
"id" : 1
},
"status_attribute" : {
"name" : "开始态"
},
"priority" : {
"name" : "中"
},
"assigned_to" : {
"identifier" : "a360371833bf4c558f796fd707b44daf",
"assigned_nick_name" : "张三丰1",
"name" : "devcloud_devcloud_s00404480_01",
"last_name" : "devcloud_devcloud_s00404480_01",
"id" : 4091,
"first_name" : "devcloud_devcloud_s00404480_01"
},
"developer" : { },
"closeder" : { },
"fixed_version" : { },
"severity" : {
"name" : "一般",
"id" : 12
},
"order" : {
"name" : 1,
"id" : 1
},
"domain" : { },
"module" : { },
"story_point" : {
"id" : 3,
"name" : "1"
},
"release_dev" : "",
"find_release_dev" : "",
"assigned_cc_user" : [ ],
"has_httachments" : false
} ],
"delete_attachment_files" : [ ],
"issues" : [ {
"tracker_id" : 7,
"project_id" : "5192de5eb435430c8cd41c6ae6028848",
"id" : 9186305
} ]
},
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
删除工作项接口成功的响应。 |
错误码
请参见错误码。