Updating a Work Item

Updated on 2023-06-12 GMT+08:00

View PDF

Function

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32
issue_id	Yes	Integer	Identifies a work item.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum: 10 Maximum: 32768

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
actual_work_hours	No	Double	Indicates the actual person-hours.
assigned_id	No	Integer	Handler ID, which corresponds to the numeric ID of the user information.
begin_time	No	String	Start time, in the format of year-month-day.
description	No	String	Details
developer_id	No	Integer	Developer ID, which corresponds to the numeric ID of user information.
domain_id	No	Integer	Identifies a domain.
done_ratio	No	Integer	Work Item Progress Value
end_time	No	String	End time, in the format of year-month-day.
expected_work_hours	No	Double	Expected
iteration_id	No	Integer	Identifies a sprint.
module_id	No	Integer	Specifies the module ID.
name	No	String	Title
parent_issue_id	No	Integer	ID of the parent work item.
priority_id	No	Integer	Priority, 1: low, In 2, 3 high,
severity_id	No	Integer	Importance, 10 key, 11 important, 12 general, 13 Prompt,
status_id	No	Integer	Status ID, New 1, 2 in progress, 3 resolved, 4 in the test, 5 closed, 6 resolved,
tracker_id	No	Integer	Work item type. The options are as follows: 2: task; 3: defect /Bug,5Epic,6Feature,7Story.
new_custom_fields	No	Array of NewCustomField objects	Custom Item

**Table 4** NewCustomField
Parameter	Mandatory	Type	Description
custom_field	No	String	Custom Parameter
field_name	No	String	Custom field name
value	No	String	Value of a customized attribute. Use commas (,) to separate multiple values.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
actual_work_hours	Double	Indicates the actual person-hours.
assigned_cc_user	Array of IssueUser objects	Copy To
assigned_user	IssueUser object
begin_time	String	Estimated start time, in the format of year-month-day.
created_time	String	Creation time Year-Month-Day Hour:Minute:Second
creator	IssueUser object
custom_fields	Array of CustomField objects	Customized attribute value, which is not recommended. You are advised to refer to the new_custom_fields field.
new_custom_fields	Array of NewCustomField objects	Attribute Value
developer	IssueUser object
domain	domain object	ID, domain 14, 'Performance', 15, 'Function', 16, 'Reliability' 17,'Network security' 18, 'Maintainability' 19,'Other DFX' 20, 'Availability'
done_ratio	Integer	Work Item Progress Value
end_time	String	Estimated end time, in the format of year-month-day.
expected_work_hours	Double	Expected
id	Integer	Work Item ID
project	IssueProjectResponseV4 object	Project Information
iteration	iteration object	Iteration
module	module object	Module
name	String	Title
parent_issue	parent_issue object	Parent Work Item
priority	priority object	Work Item Priority
severity	severity object	Work Item Importance
status	status object	Work Item Statuses
tracker	tracker object	Work item type. The options are as follows: 2: task; 3: defect /Bug,5Epic,6Feature,7Story.
updated_time	String	Update time (year-month-day hour:minute:second)
closed_time	String	Close Time Year-Month-Day Hour:Minute:Second

**Table 6** IssueUser
Parameter	Type	Description
user_id	String	uuid
user_num_id	Integer	id
id	Integer	Specifies the user ID.
name	String	User Name
nick_name	String	Nickname

**Table 7** CustomField
Parameter	Type	Description
name	String	Custom Attribute
value	String	Value of a customized attribute.
new_name	String	Custom Attribute

**Table 8** NewCustomField
Parameter	Type	Description
custom_field	String	Custom Parameter
field_name	String	Custom field name
value	String	Value of a customized attribute. Use commas (,) to separate multiple values.

**Table 9** domain
Parameter	Type	Description
id	Integer	Identifies a domain.
name	String	fields

**Table 10** IssueProjectResponseV4
Parameter	Type	Description
project_id	String	Project ID
project_name	String	Project
project_num_id	Integer	Project ID

**Table 11** iteration
Parameter	Type	Description
id	Integer	Identifies a sprint.
name	String	Iteration Name

**Table 12** module
Parameter	Type	Description
id	Integer	Specifies the module ID.
name	String	Module

**Table 13** parent_issue
Parameter	Type	Description
id	Integer	Parent Work Item ID
name	String	Parent Work Item

**Table 14** priority
Parameter	Type	Description
id	Integer	Identifies a priority.
name	String	Priority

**Table 15** severity
Parameter	Type	Description
id	Integer	Identifies a severity.
name	String	Indicates the level of severity.

**Table 16** status
Parameter	Type	Description
id	Integer	Identifies a status.
name	String	Event Name

**Table 17** tracker
Parameter	Type	Description
id	Integer	Type ID
name	String	Object

Status code: 400

**Table 18** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 19** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

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

{
  "status_id" : 2
}

Example Responses

Status code: 200

{
  "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"
}