POST
/{orgId}/{itemId}/jobs/{jobId}/commentsAdds a comment to a job. Job comments are associated to a specific job using the jobId. Users must have the job's associated job template shared with them to add a job comment.
Job Comment Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| comment | Required. The contents of the comment | String |
Query parameters
| Name | Type | Required |
|---|---|---|
token | string¦null |
Body parameters
Supported content types: application/json
Type: JobCommentArg
a job comment object defining the comment
| Name | Type | Required |
|---|---|---|
comment | string |
Path parameters
| Name | Type | Required |
|---|---|---|
job | string | |
org | string | |
item | string |
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | success | inline |
| 404 | Not Found | error | WorkflowJsonExceptionDTO |
Response details
Status Code 200
AddJobCommentResponse
| Name | Type | Required | Description |
|---|---|---|---|
comment | string |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/{jobId}/comments \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_TOKEN>' \
--data '{"comment":"string"}'Response
{
"commentId": "string"
}