GET /tasks/{job_id}/notes
Use this method to return the notes history for a specific job (task).
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/tasks/{job_id}/notes
where {job_id} is the job ID To obtain the job IDs, use GET /tasks method.
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| createdBy | String | Name of the user that added the note or changed the state | ||
| id | String | Note ID | ||
| jobUID | String | Job ID | ||
| newState | String | Current Job state. This can be one of the following values.
| ||
| previousState | String | Previous state of the job
| ||
| text | String | Note text | ||
| timeStamp | String | Timestamp when the note was entered or the state was changed | ||
| translatedNewState | String | Translated current state | ||
| translatedPrevState | String | Translated previous state | ||
The following example is returned if the request is successful.
[{
"createdBy": "USERID",
"id": "1",
"jobUID": "4778",
"newState": "Working",
"previousState": "StoppedWithError",
"text": " Investigating the problem.",
"timeStamp": "2017-12-14T12:00:56Z",
"translatedNewState": "Working",
"translatedPrevState": "StoppedWithError"
}
{
"createdBy": "USERID",
"id": "2",
"jobUID": "4778",
"newState": "Resolved",
"previousState": " Working",
"text": "The issue was fixed.",
"timeStamp": "2017-12-14T12:59:56Z",
"translatedNewState": "Resolved",
"translatedPrevState": "Working"
}]
Give documentation feedback