Adding a Comment to a Work Item
Function
This API is used to add a comment to a work item.
Calling Method
For details, see Calling APIs.
URI
POST /v2/issues/update-issue-notes
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
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 |
notes |
Yes |
String |
Definition: Comment on a work item. Constraints: N/A Value range: N/A Default value: N/A |
project_uuid |
Yes |
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 |
type |
No |
String |
Definition: Type of the project to which the work item belongs. Constraints: N/A Value range: Scrum Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Returned information. |
status |
String |
Definition: Returned status. |
Parameter |
Type |
Description |
---|---|---|
issue |
IssueDetailResponseV2 object |
Definition: Whether a custom status name is duplicate. Value range: true (duplicate) false (not duplicate) |
Parameter |
Type |
Description |
---|---|---|
actual_work_hours |
Double |
Definition: Actual workloads of a work item (unit: person-hour). Value range: N/A |
assigned_cc_user |
Array of UserVO objects |
Definition: Cc recipient of the current work item. |
assigned_to |
UserVO object |
Definition: Current owner of a work item. |
start_date |
String |
Definition: Estimated start time of a work item, in timestamp format, for example, 1754323200000. Value range: N/A |
created_on |
String |
Definition: Time when a work item is created, in timestamp format, for example, 1754374102000. Value range: N/A |
author |
UserVO object |
Definition: Work item creator. |
custom_fields |
Array of CustomFieldV2 objects |
Definition: Custom field of a work item. |
custom_value_new |
IssueDetailCustomFieldV2 object |
Definition: Custom field of a work item. |
developer |
UserVO object |
Definition: Developer of a work item. |
domain |
domain object |
Definition: Domain of a work item. |
done_ratio |
Integer |
Definition: Work item completion rate. Value range: N/A |
end_time |
String |
Definition: Estimated end time of a work item, in timestamp format, for example, 1754323200000. Value range: N/A |
expected_work_hours |
Double |
Definition: Estimated completion time of a work item (unit: person-hour). Value range: N/A |
id |
Integer |
Definition: Work item ID. Value range: N/A |
project |
ProjectVO object |
Definition: Project to which the work item belongs. Value range: N/A |
iteration |
iteration object |
Definition: Sprint to which the work item belongs. |
story_point |
story_point object |
Definition: Story point information of a work item. |
module |
module object |
Definition: Module of a work item. |
subject |
String |
Definition: Title of a work item. Value range: N/A |
parent_issue |
parent_issue object |
Definition: Parent work item of a work item. |
priority |
priority object |
Definition: Work item priority. |
severity |
severity object |
Definition: Work item severity. |
status |
status object |
Definition: Current status of a work item. |
release_dev |
String |
Definition: Release version of a work item. Value range: N/A |
find_release_dev |
String |
Definition: Version where the bug was found (available only for bugs). Value range: N/A |
env |
env object |
Definition: Environment where the bug was found (available only for bugs). |
tracker |
tracker object |
Definition: Work item type. |
updated_on |
String |
Definition: Last update time of a work item, in timestamp format, for example, 1754374102000. Value range: N/A |
closed_time |
String |
Definition: Time when a work item is closed, in timestamp format, for example, 1754374102000. Value range: N/A |
description |
String |
Definition: Work item description. Value range: N/A |
accessories_list |
Array of IssueAccessoryV2 objects |
Definition: List of work item attachments. |
inner_text |
String |
Definition: Updated comments on a work item. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
assigned_nick_name |
String |
Definition: User alias. Value range: N/A |
first_name |
String |
Definition: Username. Value range: N/A |
id |
Integer |
Definition: Digital ID of a user. Value range: N/A |
identifier |
String |
Definition: 32–character UUID of a user. Value range: N/A |
last_name |
String |
Definition: Last name of the user. Value range: N/A |
name |
String |
Definition: Username with tenant information. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition: Custom field. Value range: N/A |
value |
String |
Definition: Value of a custom field. Value range: N/A |
new_name |
String |
Definition: Name of a custom field after modification. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
custom_field |
String |
Definition: Custom field. Value range: N/A |
field_name |
String |
Definition: Custom field name. Value range: N/A |
value |
String |
Definition: Values of custom properties, which are separated by commas (,). Value range: N/A |
field_type |
String |
Definition: Custom field type. Value range: textArea: multi-line text text: single-line text select: drop-down list number: number time_date: date checkbox: check box radio: radio button |
description |
String |
Definition: Description of a custom field. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Domain ID. Value range: N/A |
name |
String |
Definition: Domain name. Value range: N/A |
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 |
project_type |
String |
Definition: Project type. Value range: Scrum |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Sprint ID of a work item. Value range: N/A |
name |
String |
Definition: Sprint name of a work item. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Story point ID of a work item. Value range: N/A |
name |
String |
Definition: Story point name of a work item. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Module ID of a work item. Value range: N/A |
name |
String |
Definition: Module name of a work item. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Parent work item ID of a work item. Value range: N/A |
name |
String |
Definition: Parent work item name of a work item. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Priority ID of a work item. Value range: N/A |
name |
String |
Definition: Priority name of a work item. Value range: High, Medium, and Low |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Work item severity ID. Value range: N/A |
name |
String |
Definition: Work item severity name. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Current status ID of a work item. Value range: N/A |
name |
String |
Definition: Current status of a work item. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: ID of the environment where the bug was found. Value range: N/A |
name |
String |
Definition: Name of the environment where the bug was found. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Type ID of a work item. Value range: 2, 3, 5, 6, and 7 |
name |
String |
Definition: Work item type name. Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) |
Parameter |
Type |
Description |
---|---|---|
attachment_id |
Integer |
Definition: Attachment ID. Value range: N/A |
issue_id |
Integer |
Definition: Digital ID of a work item. Value range: N/A |
creator_num_id |
Integer |
Definition: Digital ID of the attachment uploader. Value range: N/A |
created_date |
String |
Definition: Attachment creation time, for example, 2025-08-04 19:43:46. Value range: N/A |
file_name |
String |
Definition: Attachment name. Value range: N/A |
container_type |
String |
Definition: Attachment type. Value range: Scrum |
disk_file_name |
String |
Definition: Actual name of the attachment on the server. Value range: N/A |
digest |
String |
Definition: Attachment source. Value range: 1 (local document uploaded for a work item) and 2 (associated document) |
disk_directory |
String |
Definition: Path of the attachment on the server. Value range: N/A |
creator_id |
String |
Definition: UUID of the attachment uploader. Value range: N/A |
Example Requests
POST http://{endpoint}/v2/issues/update-issue-notes { "id" : 9206017, "notes" : "TEST", "project_uuid" : "a8ac165097ff4e42bcfb234dd27d30a6", "type" : "scrum" }
Example Responses
Status code: 200
OK (The request has succeeded).
{ "result" : { "issue" : { "id" : 2884419, "subject" : "TEST", "author" : { "first_name" : "xxxxxx", "last_name" : "xxxxxx", "identifier" : "xxxxxx", "name" : "xxxxxx", "id" : 1111, "assigned_nick_name" : "xxxxxx" }, "created_on" : "1754463933000", "updated_on" : "1754463933000", "done_ratio" : 0, "description" : "<p><strong>TEST</strong></p>", "expected_work_hours" : 0, "actual_work_hours" : 0, "release_dev" : "", "project" : { "identifier" : "310eed4d6160446cb294a8bacfd46e7e", "name" : "APIFunction202507Cukr9K", "id" : 6345282 }, "tracker" : { "name" : "Story", "id" : 7 }, "status" : { "name" : "New", "id" : 1 }, "assigned_to" : { "first_name" : "xxxxxx", "last_name" : "xxxxxx", "identifier" : "xxxxxx", "name" : "xxxxxx", "id" : 1111, "assigned_nick_name" : "xxxxxx" }, "developer" : { }, "priority" : { "name" : "Medium", "id" : 2 }, "severity" : { "name" : "Minor", "id" : 12 }, "module" : { }, "story_point" : { "id" : 3, "name" : "1" }, "assigned_cc_user" : [ ], "inner_text" : "TEST1" } }, "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK (The request has succeeded). |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot