/{orgId}/{itemId}/jobs/{jobId}/comments
Create a job comment
Adds 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 |
---|---|---|
|
|
Body parameters
Supported content types: application/json
Name | Type | Required | Description |
---|---|---|---|
a job comment object defining the comment | |||
|
|
Path parameters
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/{jobId}/comments \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
--data '{"comment":"string"}'
Response
Status | Meaning | Description | Schema |
---|---|---|---|
| success | Inline | |
| error |
Response details
Status Code 200
AddJobCommentResponse
Name | Type | Required |
---|---|---|
|
|