GetSyncJobInfo retrieves information about synchronous jobs on BIRT iHub. For example, you can get the status of the report, its position in the queue, the name of the BIRT iHub machine on which it is pending, whether the report is transient or persistent, and how soon the request times out. The status of a synchronous job is Completed, Pending, Running, or Failed. GetSyncJobInfo also returns an error description if the status is Failed.

To submit a GetSyncJobInfo request, you need a ConnectionHandle and the ObjectId of the requested job. ConnectionHandle returns in the response to ExecuteReport.

This request returns known details about the job. In the following response, PendingTime is the number of seconds since the job entered the queue. QueueTimeout is the number of seconds remaining before BIRT iHub deletes the job from the queue. The default value for QueueTimeout is 600 seconds. An Encyclopedia volume administrator can configure a different value, to a maximum of 999 seconds. The response also shows the path to the executable file that creates the output, whether the report is transient, the resource group to which the job is assigned, and other information about the job.