curl --request POST \
--url http://{host}:{port}/{contextPath}/task/{id}/comment/create \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "a task comment",
"processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687"
}
'import requests
url = "http://{host}:{port}/{contextPath}/task/{id}/comment/create"
payload = {
"message": "a task comment",
"processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: 'a task comment',
processInstanceId: '96dc383f-23eb-11e6-8e4a-f6aefe19b687'
})
};
fetch('http://{host}:{port}/{contextPath}/task/{id}/comment/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{host}:{port}/{contextPath}/task/{id}/comment/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => 'a task comment',
'processInstanceId' => '96dc383f-23eb-11e6-8e4a-f6aefe19b687'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://{host}:{port}/{contextPath}/task/{id}/comment/create"
payload := strings.NewReader("{\n \"message\": \"a task comment\",\n \"processInstanceId\": \"96dc383f-23eb-11e6-8e4a-f6aefe19b687\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://{host}:{port}/{contextPath}/task/{id}/comment/create")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"a task comment\",\n \"processInstanceId\": \"96dc383f-23eb-11e6-8e4a-f6aefe19b687\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{contextPath}/task/{id}/comment/create")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"a task comment\",\n \"processInstanceId\": \"96dc383f-23eb-11e6-8e4a-f6aefe19b687\"\n}"
response = http.request(request)
puts response.read_body{
"links": [
{
"method": "GET",
"href": "http://localhost:38080/rest-test/task/aTaskId/comment/aTaskCommentId",
"rel": "self"
}
],
"id": "aTaskCommentId",
"userId": "userId",
"taskId": "aTaskId",
"processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
"time": "2013-01-02T21:37:03.887+0200",
"message": "comment message",
"removalTime": "2018-02-10T14:33:19.000+0200",
"rootProcessInstanceId": "aRootProcessInstanceId"
}{
"type": "<string>",
"message": "<string>",
"code": 123
}{
"userId": "<string>",
"missingAuthorizations": [
{
"permissionName": "<string>",
"resourceName": "<string>",
"resourceId": "<string>"
}
],
"type": "<string>",
"message": "<string>",
"code": 123
}Create
Creates a comment for a task by id.
curl --request POST \
--url http://{host}:{port}/{contextPath}/task/{id}/comment/create \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "a task comment",
"processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687"
}
'import requests
url = "http://{host}:{port}/{contextPath}/task/{id}/comment/create"
payload = {
"message": "a task comment",
"processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: 'a task comment',
processInstanceId: '96dc383f-23eb-11e6-8e4a-f6aefe19b687'
})
};
fetch('http://{host}:{port}/{contextPath}/task/{id}/comment/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{host}:{port}/{contextPath}/task/{id}/comment/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => 'a task comment',
'processInstanceId' => '96dc383f-23eb-11e6-8e4a-f6aefe19b687'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://{host}:{port}/{contextPath}/task/{id}/comment/create"
payload := strings.NewReader("{\n \"message\": \"a task comment\",\n \"processInstanceId\": \"96dc383f-23eb-11e6-8e4a-f6aefe19b687\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://{host}:{port}/{contextPath}/task/{id}/comment/create")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"a task comment\",\n \"processInstanceId\": \"96dc383f-23eb-11e6-8e4a-f6aefe19b687\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{contextPath}/task/{id}/comment/create")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"a task comment\",\n \"processInstanceId\": \"96dc383f-23eb-11e6-8e4a-f6aefe19b687\"\n}"
response = http.request(request)
puts response.read_body{
"links": [
{
"method": "GET",
"href": "http://localhost:38080/rest-test/task/aTaskId/comment/aTaskCommentId",
"rel": "self"
}
],
"id": "aTaskCommentId",
"userId": "userId",
"taskId": "aTaskId",
"processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
"time": "2013-01-02T21:37:03.887+0200",
"message": "comment message",
"removalTime": "2018-02-10T14:33:19.000+0200",
"rootProcessInstanceId": "aRootProcessInstanceId"
}{
"type": "<string>",
"message": "<string>",
"code": 123
}{
"userId": "<string>",
"missingAuthorizations": [
{
"permissionName": "<string>",
"resourceName": "<string>",
"resourceId": "<string>"
}
],
"type": "<string>",
"message": "<string>",
"code": 123
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The id of the task to add the comment to.
Body
Note: Only the message and processInstanceId properties will be used. Every other property passed to this endpoint will be ignored.
The id of the task comment.
The id of the user who created the comment.
The id of the task to which the comment belongs.
The id of the process instance the comment is related to.
The time when the comment was created.
Default format [blocked]
yyyy-MM-dd'T'HH:mm:ss.SSSZ.
The content of the comment.
The time after which the comment should be removed by the History Cleanup job.
Default format [blocked]
yyyy-MM-dd'T'HH:mm:ss.SSSZ.
The process instance id of the root process instance that initiated the process containing the task.
The links associated to this resource, with method, href and rel.
Show child attributes
Show child attributes
Response
Request successful.
The id of the task comment.
The id of the user who created the comment.
The id of the task to which the comment belongs.
The id of the process instance the comment is related to.
The time when the comment was created.
Default format [blocked]
yyyy-MM-dd'T'HH:mm:ss.SSSZ.
The content of the comment.
The time after which the comment should be removed by the History Cleanup job.
Default format [blocked]
yyyy-MM-dd'T'HH:mm:ss.SSSZ.
The process instance id of the root process instance that initiated the process containing the task.
The links associated to this resource, with method, href and rel.
Show child attributes
Show child attributes