getJobComments

Click to copy

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

NameTypeRequired

token

string

Path parameters

NameTypeRequired

jobId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/jobs/{jobId}/comments \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "jobComments": [
    {
      "jobId": "string",
      "comment": "string",
      "commentId": "string",
      "lastModifiedBy": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

The comments on a job

Inline

400

Bad Request

error

WorkflowJsonExceptionDTO

404

Not Found

error

WorkflowJsonExceptionDTO

Response details

Status Code 200

JobComments

NameTypeRequired

jobComments

jobId

string

comment

string

commentId

string¦null

lastModifiedBy

string¦null

lastModified

string(date-time)¦null

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