Returns all instances of a recurring job that have occurred so far. To see only the status information for the latest instance of a recurring job, use getRecurringJobExecutionStatus.
Output Samples Change History |
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <getRecurringJobExecutionHistoryRequest xmlns="http://www.ebay.com/marketplace/services"> <!-- Call-specific Input Fields --> <endTime> dateTime </endTime> <jobStatus> JobStatus </jobStatus> <!-- ... more jobStatus values allowed here ... --> <recurringJobId> string </recurringJobId> <startTime> dateTime </startTime> </getRecurringJobExecutionHistoryRequest>
Argument | Type | Occurrence | Meaning |
---|
endTime | dateTime | Optional |
The startTime and endTime date range filters can be used to restrict recurring job instances retrieved in the response to those instances executed within the specified date range. The endTime is the ending date/time for the date range. The endTime must be more recent than the startTime (if one is specified). If an endTime is specified, but an startTime value is not, all recurring job instances (for which data exists) executed before the endTime value are retrieved. |
jobStatus | JobStatus | Optional,
repeatable: [0..*] |
This field is used to retrieve recurring job instances in various states. If this field is not used, recurring job instances in all states are retrieved.
Applicable values: See jobStatus. |
recurringJobId | string | Required |
Unique ID assigned by the Bulk Data Exchange API for managing your recurring job. The specified recurringJobId value will control which recurring job instances are retrieved in the response. recurringJobId values are returned in createRecurringJob responses, and you can also use getRecurringJobs to retrieve recurringJobId values for any recurring jobs you have created. |
startTime | dateTime | Optional |
The startTime and endTime date range filters can be used to restrict recurring job instances retrieved in the response to those instances executed within the specified date range. The startTime is the starting date/time for the date range. The startTime must be older than the endTime (if one is specified). If a startTime is specified, but an endTime value is not, the ending date/time of the date range defaults to the current date/time. |
Input Samples Change History |
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <getRecurringJobExecutionHistoryResponse xmlns="http://www.ebay.com/marketplace/services"> <!-- Call-specific Output Fields --> <jobProfile> JobProfile <completionTime> dateTime </completionTime> <creationTime> dateTime </creationTime> <errorCount> int </errorCount> <fileReferenceId> string </fileReferenceId> <jobId> string </jobId> <jobStatus> JobStatus </jobStatus> <jobType> token </jobType> <percentComplete> double </percentComplete> </jobProfile> <!-- ... more jobProfile nodes allowed here ... --> <!-- Standard Output Fields --> <ack> AckValue </ack> <errorMessage> ErrorMessage <error> ErrorData <category> ErrorCategory </category> <domain> string </domain> <errorId> long </errorId> <exceptionId> token </exceptionId> <message> string </message> <parameter name="string"> ErrorParameter (string) </parameter> <!-- ... more parameter nodes allowed here ... --> <severity> ErrorSeverity </severity> <subdomain> string </subdomain> </error> <!-- ... more error nodes allowed here ... --> </errorMessage> <timestamp> dateTime </timestamp> <version> string </version> </getRecurringJobExecutionHistoryResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
jobProfile | JobProfile | Always,
repeatable: [1..*] |
A jobProfile container is returned for each successfully retrieved recurring job. The jobProfile container consists of unique identifiers for the recurring job, as well as data that indicates the current status of the recurring job. The job profile returns data about the state of the Bulk Data Exchange job, but does not return information about the status of the processing for any data file that is sent with the job request or returned with the job response. |
jobProfile.completionTime | dateTime | Conditionally | This timestamp indicates the date and time that the Bulk Data Exchange job was completed. Compare this timestamp against creationTime to determine the average processing time for your jobs. If processing of the job has not completed, this field will not be returned. The user will have to look at the percentComplete value to determine the current status of the running job. |
jobProfile.creationTime | dateTime | Always | This timestamp indicates the date and time that the Bulk Data Exchange job was created. This value is always returned with the jobProfile container. |
jobProfile.errorCount | int | Conditionally | The number of non-fatal (informational) errors that occurred during file processing (uploads or reports) after a startUploadJobRequest or startDownloadJobRequest call. |
jobProfile.fileReferenceId | string | Conditionally |
A unique ID assigned to a file by the Bulk Data Exchange API. This value will be passed into the fileReferenceId field in the File Transfer API's uploadFile call. If a job has not completed processing, only the inputFileReferenceId value (from the createUploadJob response) will be returned. Once the upload job has finished processing, a new fileReferenceId is assigned by the Bulk Data Exchange API and returned by the job status calls. |
jobProfile.jobId | string | Always | Unique ID that is assigned for a job by the Bulk Data Exchange API after a successful startDownloadJob b> call. This value is always returned with the jobProfile container. |
jobProfile.jobStatus | JobStatus | Always |
The current state of a Bulk Data Exchange job. This value is always returned with the jobProfile container.
Applicable values: See jobStatus. |
jobProfile.jobType | token | Always |
Each of the Bulk Data Exchange job types corresponds to a Merchant Data request or response with the same name. The requests or responses are included within a data file that will be uploaded or downloaded after the job is created. For instance, if you create an AddFixedPriceItem job, then the file you are going to upload must contain AddFixedPriceItem requests - one request for each item in your data file. Each Bulk Data Exchange job can only have one job type per job. For example, if you are uploading a data file, it can not have both AddFixedPriceItem requests and ReviseFixedPriceItem requests within the same data file. The following value definitions describe the request or response associated with each job type. For more information about creating and uploading Merchant Data files, see the Large Merchant Services User Guide.
Recurring jobs can be established for download job types only. For getRecurringJobExecutionHistory and getRecurringJobExecutionStatus, only the following values apply:
|
jobProfile.percentComplete | double | Always | The percentage of your file that has been processed after startUploadJobRequest or startDownloadJobRequest call. This value is always returned with the jobProfile container whether the job is still in progress or complete. If the job is complete, the value of this field will be '100.0'. |
Standard Output Fields |
ack | AckValue | Always |
Returns the acknowledgement of the call success or failure.
Applicable values: |
errorMessage | ErrorMessage | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. |
errorMessage.error | ErrorData | Conditionally,
repeatable: [0..*] |
Details about a single error. |
errorMessage.error.category | ErrorCategory | Conditionally |
There are three categories of errors: request errors, application errors, and system errors.
Applicable values: |
errorMessage.error.domain | string | Conditionally |
Name of the domain upon which the error occurred.
|
errorMessage.error.errorId | long | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. |
errorMessage.error.exceptionId | token | Conditionally | Unique identifier for an exception associated with an error. |
errorMessage.error.message | string | Conditionally | A detailed description of the condition that resulted in the error. |
errorMessage.error.parameter | ErrorParameter (string) | Conditionally,
repeatable: [0..*] |
Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. |
errorMessage.error.parameter [ attribute name ] |
string | Conditionally | Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. |
errorMessage.error.severity | ErrorSeverity | Conditionally |
Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: |
errorMessage.error.subdomain | string | Conditionally |
Name of the subdomain upon which the error occurred.
|
timestamp | dateTime | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. |
version | string | Always |
The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. |
Input Output Change History |
New to making API calls? Please see Making an API Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Returns the processing history of a specified Bulk Data Exchange service recurring job.
Description
User megaonlinemerchant
wants to check the history of her ActiveInventoryReports, to see if they are being processed every week.
As a result of this call, megaonlinemerchant
will see whether the processing history of the recurring job that she has specified in her request.
Input
In the following getRecurringJobExecutionHistory request sample, you will see that you can provide a date range (optional) and the Recurring Job ID (required) in your request.
XML format. Also available is the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <getRecurringJobExecutionHistoryRequest xmlns="http://www.ebay.com/marketplace/services"> <startTime>2008-11-05T00:12:48.662Z</startTime> <endTime>2008-11-05T00:19:48.662Z</endTime> <recurringJobId>5000000800</recurringJobId> <jobStatus>Scheduled</jobStatus> </getRecurringJobExecutionHistoryRequest>
Output
The response includes a Success or Failure acknowledgement, the version number of the Bulk Data Exchange service, a timestamp, and a history of the processing for the job id that you specified.
XML format. Also available is the .txt version of this XML and the SOAP equivalent. <?xml version='1.0' encoding='utf-8'?> <getRecurringJobExecutionHistoryResponse xmlns="http://www.ebay.com/marketplace/services"> <ack>Success</ack> <version>1.0.0</version> <timestamp>2008-12-04T04:01:26.924Z</timestamp> <jobProfile> <jobId>50000000703</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T17:44:13.000-07:00</creationTime> <completionTime>2008-12-03T17:46:54.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001283</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000713</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T18:12:13.000-07:00</creationTime> <completionTime>2008-12-03T18:16:55.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001293</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000723</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T18:40:13.000-07:00</creationTime> <completionTime>2008-12-03T18:43:55.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001303</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000733</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T19:11:14.000-07:00</creationTime> <completionTime>2008-12-03T19:13:55.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001313</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000753</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T19:40:14.000-07:00</creationTime> <completionTime>2008-12-03T19:43:56.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001333</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000763</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T20:11:14.000-07:00</creationTime> <completionTime>2008-12-03T20:13:56.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001343</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000773</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-12-03T20:45:14.000-07:00</creationTime> <completionTime>2008-12-03T20:46:56.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000001353</fileReferenceId> </jobProfile> </getRecurringJobExecutionHistoryResponse>
Input Output Samples |
Change Date | Description |
---|---|
1.0.0 2008-11-29 |
|
Copyright © 2013–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.