curl --request PUT \
--url http://{host}:{port}/{contextPath}/process-instance/{id}/comment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "75bc161a-12da-11e4-7d3a-f4ccdc10a445",
"message": "a process instance comment"
}
'import requests
url = "http://{host}:{port}/{contextPath}/process-instance/{id}/comment"
payload = {
"id": "75bc161a-12da-11e4-7d3a-f4ccdc10a445",
"message": "a process instance comment"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '75bc161a-12da-11e4-7d3a-f4ccdc10a445',
message: 'a process instance comment'
})
};
fetch('http://{host}:{port}/{contextPath}/process-instance/{id}/comment', 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}/process-instance/{id}/comment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '75bc161a-12da-11e4-7d3a-f4ccdc10a445',
'message' => 'a process instance comment'
]),
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}/process-instance/{id}/comment"
payload := strings.NewReader("{\n \"id\": \"75bc161a-12da-11e4-7d3a-f4ccdc10a445\",\n \"message\": \"a process instance comment\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://{host}:{port}/{contextPath}/process-instance/{id}/comment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"75bc161a-12da-11e4-7d3a-f4ccdc10a445\",\n \"message\": \"a process instance comment\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{contextPath}/process-instance/{id}/comment")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"75bc161a-12da-11e4-7d3a-f4ccdc10a445\",\n \"message\": \"a process instance comment\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"message": "<string>",
"code": 123
}{
"userId": "<string>",
"missingAuthorizations": [
{
"permissionName": "<string>",
"resourceName": "<string>",
"resourceId": "<string>"
}
],
"type": "<string>",
"message": "<string>",
"code": 123
}Update
Updates a Comment.
curl --request PUT \
--url http://{host}:{port}/{contextPath}/process-instance/{id}/comment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "75bc161a-12da-11e4-7d3a-f4ccdc10a445",
"message": "a process instance comment"
}
'import requests
url = "http://{host}:{port}/{contextPath}/process-instance/{id}/comment"
payload = {
"id": "75bc161a-12da-11e4-7d3a-f4ccdc10a445",
"message": "a process instance comment"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '75bc161a-12da-11e4-7d3a-f4ccdc10a445',
message: 'a process instance comment'
})
};
fetch('http://{host}:{port}/{contextPath}/process-instance/{id}/comment', 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}/process-instance/{id}/comment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '75bc161a-12da-11e4-7d3a-f4ccdc10a445',
'message' => 'a process instance comment'
]),
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}/process-instance/{id}/comment"
payload := strings.NewReader("{\n \"id\": \"75bc161a-12da-11e4-7d3a-f4ccdc10a445\",\n \"message\": \"a process instance comment\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://{host}:{port}/{contextPath}/process-instance/{id}/comment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"75bc161a-12da-11e4-7d3a-f4ccdc10a445\",\n \"message\": \"a process instance comment\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{contextPath}/process-instance/{id}/comment")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"75bc161a-12da-11e4-7d3a-f4ccdc10a445\",\n \"message\": \"a process instance comment\"\n}"
response = http.request(request)
puts response.read_body{
"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 associated of a process instance of a comment to be updated.
Body
Note: Only the id and message 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.