Deleting a Work Item

Function

This API is used to delete a work item.

Calling Method

For details, see Calling APIs.

URI

POST /v3/issue/delete

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory. Value range: Minimum length: 10 characters. Maximum length: 32,768 characters. Default value: N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
call_back_param	No	call_back_param object	Definition: Request parameter for deleting a work item. Constraints: N/A Value range: N/A Default value: N/A
type	No	String	Definition: Work item operation type. Constraints: N/A Value range: deleteIssue Default value: deleteIssue

**Table 3** call_back_param
Parameter	Mandatory	Type	Description
project_id	No	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A
issue_id	No	String	Definition: Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID. Constraints: The value must contain 1 to 10 digits. Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: N/A
type	No	String	Definition: Project type. Constraints: N/A Value range: Scrum Default value: Scrum

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result. Value range: N/A
status	String	Definition: Returned status. Value range: success: Command execution succeeds. error: Command execution failed.

**Table 5** result
Parameter	Type	Description
deleted_issues	Array of deleted_issues objects	Definition: Deleted work item. Value range: N/A
delete_attachment_files	Array of strings	Definition: Deleted attachment. Value range: N/A
issues	Array of issues objects	Definition: Work item. Value range: N/A

**Table 6** deleted_issues
Parameter	Type	Description
id	Integer	Definition: ID of the work item to be deleted. Value range: N/A
subject	String	Definition: Name of the work item to be deleted. Value range: N/A
author	IssueAuthorVO object	Definition: User. Value range: N/A
created_on	String	Definition: Work item creation time, in timestamp format, for example, 1839340800000. Value range: N/A
updated_on	String	Definition: Work item update time, in timestamp format, for example, 1839340800000. Value range: N/A Value range: N/A
description	String	Definition: Work item description. Value range: N/A
expected_work_hours	Integer	Definition: Estimated workloads of a work item (unit: person-hour). Value range: N/A
actual_work_hours	Integer	Definition: Actual workloads of a work item (unit: person-hour). Value range: N/A
is_watcher	Boolean	Definition: Whether to subscribe to information. Value range: true (subscribe) false (not subscribe)
project	Project object	Definition: Project. Value range: N/A
tracker	Tracker object	Definition: Work item type. Value range: N/A
status	Status object	Definition: Work item status. Value range: N/A
status_attribute	StatusAttribute object	Definition: Status attribute. Value range: N/A
priority	Priority object	Definition: Priority. Value range: N/A
assigned_to	IssueAssignedVO object	Definition: Project owner. Value range: N/A
developer	Object	Definition: Developer. Value range: N/A
closeder	Object	Definition: Project closure personnel. Value range: N/A
fixed_version	Object	Definition: Fixed version. Value range: N/A
severity	Severity object	Definition: Severity. Value range: N/A
order	Order object	Definition: Sorting of work items. Value range: N/A
domain	Object	Definition: Domain of a work item. Value range: N/A
module	Object	Definition: Module of a work item. Value range: N/A
story_point	StoryPoint object	Definition: Story point of a work item. Value range: N/A
release_dev	String	Definition: Work item release version. Value range: N/A
find_release_dev	String	Definition: Releaser. Value range: N/A
assigned_cc_user	Array of strings	Definition: Cc recipient. Value range: N/A
has_httachments	Boolean	Definition: Whether there is an attachment. Value range: true (with attachments) false (no attachments)

**Table 7** IssueAuthorVO
Parameter	Type	Description
first_name	String	Definition: Username. Value range: N/A
last_name	String	Definition: Last name of the user. Value range: N/A
identifier	String	Definition: Unique ID of the author. Value range: N/A
image_id	String	Definition: User avatar ID. Value range: N/A
assigned_nick_name	String	Definition: User alias. Value range: N/A
name	String	Definition: Username with tenant information, in the format of Tenant name_Username. Value range: N/A
id	Integer	Definition: User ID. Value range: N/A

**Table 8** Project
Parameter	Type	Description
identifier	String	Definition: Project UUID. Value range: N/A
name	String	Definition: Project name. Value range: N/A
id	Integer	Definition: Digital ID of a project. Value range: N/A
type	String	Definition: Project type. Value range: Scrum

**Table 9** Tracker
Parameter	Type	Description
name	String	Definition: Type name. Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story)
id	Integer	Definition: Type ID. Value range: 2, 3, 5, 6, and 7

**Table 10** Status
Parameter	Type	Description
name	String	Definition: Status name. Value range: 1: new 2: developing 3: resolved 4: testing 5: closed 6: rejected
id	Integer	Definition: Status ID. Value range: 1, 2, 3, 4, 5, and 6

**Table 11** StatusAttribute
Parameter	Type	Description
project_id	String	Definition: 32-character UUID of a project. Value range: N/A
name	String	Definition: Name. Value range: N/A

**Table 12** Priority
Parameter	Type	Description
name	String	Definition: Work item priority. Value range: 1: low 2: medium 3: high
id	Integer	Definition: Priority ID. Value range: 1, 2, and 3

**Table 13** IssueAssignedVO
Parameter	Type	Description
first_name	String	Definition: Username. Value range: N/A
last_name	String	Definition: Last name of the user. Value range: N/A
identifier	String	Definition: 32–character UUID of a user. Value range: N/A
image_id	String	Definition: User avatar ID. Value range: N/A
assigned_nick_name	String	Definition: User alias. Value range: N/A
name	String	Definition: Username. Value range: N/A
id	Integer	Definition: Digital ID of a user. Value range: N/A

**Table 14** Severity
Parameter	Type	Description
name	String	Definition: Work item severity. Value range: 10: critical 11: major 12: minor 13: trivial
id	Integer	Definition: Severity ID. Value range: 10, 11, 12, and 13

**Table 15** Order
Parameter	Type	Description
name	Integer	Definition: Sorting name. Value range: N/A
id	Integer	Definition: Order ID. Value range: N/A

**Table 16** StoryPoint
Parameter	Type	Description
id	Integer	Definition: Story point ID. Value range: N/A
name	String	Definition: Story point name. Value range: N/A

**Table 17** issues
Parameter	Type	Description
tracker_id	Integer	Definition: Work item type. Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story)
project_id	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the API for querying the project list. Value range: N/A
id	Integer	Definition: Work item ID. Value range: N/A

Example Requests

{endpoint}/v3/issue/delete

{
  "call_back_param" : {
    "project_id" : "5192de5eb435430c8cd41c6ae6028848",
    "issue_id" : "9186305",
    "type" : "scrum"
  },
  "type" : "deleteIssue"
}

Example Responses

Status code: 200

Successful response for deleting a work item interface.

{
  "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;\"> As </span><User role></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> I want </span><to do something></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> so as to </span><do something> </p>",
      "expected_work_hours" : 0,
      "actual_work_hours" : 0,
      "is_watcher" : false,
      "project" : {
        "identifier" : "5192de5eb435430c8cd41c6ae6028848",
        "name" : "DevOps Full-Process Sample Project XXXX",
        "id" : 35138974
      },
      "tracker" : {
        "name" : "Story",
        "id" : 7
      },
      "status" : {
        "name" : "New",
        "id" : 1
      },
      "status_attribute" : {
        "name" : "To Do"
      },
      "priority" : {
        "name" : "Medium"
      },
      "assigned_to" : {
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "assigned_nick_name" : "Sam 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" : "Minor",
        "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"
}