getJobComments

GET
Use dark colors for code blocksCopy
/{orgId}/{itemId}/jobs/{jobId}/comments

Get the comments for a job

Gets all comments associated with a job. Returns a list of all comments associated with a job which includes the following fields: jobId, comment, commentId, lastModifiedBy, lastModified. Users must have the job's associated job template shared with them to get job comments.

Query parameters

Name	Type	Required
`token`	`string¦null`

Path parameters

Name	Type	Required
`jobId`	`string`
`orgId`	`string`
`itemId`	`string`

Response status

Status	Meaning	Description	Schema
200	OK	The comments on a job	inline
400	Bad Request	error	WorkflowJsonExceptionDTO
404	Not Found	error	WorkflowJsonExceptionDTO

Response details

Status Code 200

JobComments

Name	Type	Required	Description
`jobComments`	`[JobComment]`

Examples

Request

Use dark colors for code blocksCopy
# You can also use wget
curl -X GET /{orgId}/{itemId}/jobs/{jobId}/comments \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

Response

Use dark colors for code blocksCopy
{
  "jobComments": [
    {
      "jobId": "string",
      "comment": "string",
      "commentId": "string",
      "lastModifiedBy": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}