Job Status
The following status fields are returned with the job status.
| Field Name | Description |
|---|---|
| id | The id of this job, in the form of URL to the job. |
| consumerKey | The oAuth Consumer Key of the user who submitted the job. |
| businessApplicationName | The business application name associated with this job. |
| businessApplicationVersion | The version of the business application associated with this job. |
| <jobParameter> | Each business application specific job parameter will be included as a field. |
| resultDataContentType | The desired file format type of the generated result data files. |
| jobStatus | The current processing status of this job. A completed job will have a status of "resultsCreated", while a job that has yet to be queued for processing will have a status of "submitted". |
| secondsToWaitForStatusCheck | The minimum number of seconds a client should wait before checking the status of a job again. 0 if the job processing has completed. |
| numSubmittedRequests | Initially this will be set to the value passed in with the job. Once the input request data has been validated, it will be updated to the actual number of requests in the Batch Job. |
| numCompletedRequests | The current number of Batch Job Requests successfully processed and returned by the Business Application. |
| numFailedRequests | The current number of Batch Job Requests that have failed processing by the Business Application. If any input request data fails validation, then the job is not processed at all by the Business Application, and the number of failed requests will be set to the number of submitted requests. |
| resultsUrl | If the job has completed successfully, and result data files have been generated, then this URL will list the URL and details of each result file associated with this job. This field will not be present if the job processing has not completed. |