Job Reports

Overview

Job Report requests can be used to retrieve Job Reports for a Job 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 Job Reports. It is possible to get a 400 Bad Request error message for any of the requests if the value for Data is incorrect.

Get All Job Reports

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

URL: http://hostname:portnumber/api/jobreports?Data=all&JobID=validJobID
http://hostname:portnumber/api/jobreports?JobID=validJobID

Request Type: GET

Message Body: N/A

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

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job Error Reports

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

URL: http://hostname:portnumber/api/jobreports?Data=error&JobID=validJobID

Request Type: GET

Message Body: N/A

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

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job Log Reports

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

URL: http://hostname:portnumber/api/jobreports?Data=log&JobID=validJobID

Request Type: GET

Message Body: N/A

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

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job Requeue Reports

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

URL: http://hostname:portnumber/api/jobreports?Data=requeue&JobID=validJobID

Request Type: GET

Message Body: N/A

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

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job History Entries

Gets all the Job History Entries for the Job that corresponds to the provided Job ID.

URL: http://hostname:portnumber/api/jobreports?Data=history&JobID=validJobID

Request Type: GET

Message Body: N/A

Response: JSON object containing all the job history entries for the requested job, or a message stating that there are no history entries for the job.

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get All Job Report Contents

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

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=allcontents

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get All Job Error Report Contents

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

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=allerrorcontents

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get All Job Log Report Contents

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

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=alllogcontents

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get All Job Requeue Report Contents

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

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=allrequeuecontents

Request Type: GET

Message Body: N/A

Response: JSON object containing an array of string logs.

Possible Errors:
  • 400 Bad Request: No Job ID was provided.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job Log Report Contents

Gets the contents of a single log report for a job.

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=logcontents&ReportID=validReportID

Request Type: GET

Message Body: N/A

Response: JSON object containing the log string.

Possible Errors:
  • 400 Bad Request: No Job ID was provided or no Report ID was provided
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Report ID provided does not correspond to any Log in the repository, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job Error Report Contents

Gets the contents of a single error report for a job.

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=errorcontents&ReportID=validReportID

Request Type: GET

Message Body: N/A

Response: JSON object containing the log string.

Possible Errors:
  • 400 Bad Request: No Job ID was provided or no Report ID was provided
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Report ID provided does not correspond to any Log in the repository, or
    • The Job ID provided does not correspond to any Job in the repository.
Get Job Requeue Report Contents

Gets the contents of a single requeue report for a job.

URL: http://hostname:portnumber/api/jobreports?JobID=validJobID&Data=requeuecontents&ReportID=validReportID

Request Type: GET

Message Body: N/A

Response: JSON object containing the log string.

Possible Errors:
  • 400 Bad Request: No Job ID was provided or no Report ID was provided
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • The Report ID provided does not correspond to any Log in the repository, or
    • The Job ID provided does not correspond to any Job in the repository.

Job Report Property Values

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

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