POST /bpm-engine/api/tasks/{taskId}/comment

Owned by Technische Redaktion
Last updated: Nov 11, 2021
As of Version

product version 2021 Autumn | component version 

Request MethodPOST
Response FormatJSON
Description

Creates a comment with the message specified in the plain text request body for the task specified by taskId. It will be included in the process instance's history.

Meaning of HTTP status codes:

HTTP Status CodeDescription
201The request was successful and the comment is returned.
400The request body is missing.
403Forbidden.
404The requested task was not found.
409Conflict.
415Unsupported media Type.
500Internal server error.
Request HeaderContent-Type: text/plain
Request Example

https://<host>/bpm-engine/api/tasks/00000000-0000-0000-0000-000000000123

Test comment number 2.
Response Example
{
  "id": "00000001-0001-0001-0001-000000000001",
  "author": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "message": "Test comment number 2.",
  "time": "2021-11-09T13:53:20.339Z",
  "processInstanceId": "00000000-0000-0000-0000-000000000000",
  "taskId": "00000000-0000-0000-0000-000000000123"
}