Task Reports

Overview

Task Report requests can be used to retrieve Task Reports for a Job Task using the GET request type. PUT, POST and DELETE are not supported and sending a message of any of these types will result in a 501 Not Implemented error message. For more about these request types and their uses see the Request Formats and Responses documentation.

Requests and Responses

List of possible requests for Task Reports. It is possible to get a 400 Bad Request error message for any of the requests if the value for Data is incorrect. All requests may return a 400 Bad request error message if no Job ID is provided or a 500 Internal Server Error if the Job ID provided does not correspond to any Job in the repository. All requests may also return a 400 Bad Request error message if the Task ID was not provided, or was not valid, or was not an integer.

Get All Task Reports

Gets all the Task Reports for the Job Task that corresponds to the provided Job ID and provided Task ID.

URL: http://hostname:portnumber/api/taskreports?Data=all&JobID=validJobID&TaskID=validTaskID
http://hostname:portnumber/api/taskreports?JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing all the Task reports for the requested Job Task, or a message stating that there are no reports for the Job Task.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Task Error Reports

Gets all the Task Error Reports for the Job Task that corresponds to the provided Job ID and provided Task ID.

URL: http://hostname:portnumber/api/taskreports?Data=error&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing the Task error reports for the requested Job Task, or a message stating that there are no error reports for the Job Task.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Task Log Reports

Gets all the Task Log Reports for the Job Task that corresponds to the provided Job ID and provided Task ID.

URL: http://hostname:portnumber/api/taskreports?Data=log&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing the Task log reports for the requested Job Task, or a message stating that there are no log reports for the Job Task.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Task Requeue Reports

Gets all the Task Requeue Reports for the Job Task that corresponds to the provided Job ID and provided Task ID.

URL: http://hostname:portnumber/api/taskreports?Data=requeue&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing the Task requeue reports for the requested Job Task, or a message stating that there are no requeue reports for the Job Task.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get All Task Report Contents

Gets the contents of all types of reports for a single task.

URL: http://hostname:portnumber/api/taskreports?Data=allcontents&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get All Task Error Report Contents

Gets the contents of all error reports for a single task.

URL: http://hostname:portnumber/api/taskreports?Data=allerrorcontents&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get All Task Log Report Contents

Gets the contents of all log reports for a single task.

URL: http://hostname:portnumber/api/taskreports?Data=alllogcontents&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get All Task Requeue Report Contents

Gets the contents of all requeue reports for a single task.

URL: http://hostname:portnumber/api/taskreports?Data=allrequeuecontents&JobID=validJobID&TaskID=validTaskID

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Task Report Property Values

Values for some Task Report properties are represented by numbers. Those properties and their possible values are listed below.

Type (ReportType)
  • 0 = LogReport
  • 1 = ErrorReport
  • 2 = RequeueReport