addJobComment

Click to copy

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:

ParameterDescriptionData Type
commentRequired. The contents of the commentString

Body parameter

Use dark colors for code blocksCopy
1
2
3
{
  "comment": "string"
}

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

jobId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# 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}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
{
  "commentId": "string"
}
StatusMeaningDescriptionSchema

200

OK

success

Inline

404

Not Found

error

WorkflowJsonExceptionDTO

Response details

Status Code 200

AddJobCommentResponse

NameTypeRequired

commentId

string

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.